{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"The openapi folder","siteUrl":"https://developers.frontegg.com/","llmstxt":{"title":"Frontegg Developer Documentation","description":"Authentication, authorization, and user management for Customer Identity, plus Agen for SaaS and Agen for Work. Guides, SDKs, and API references.","sections":[{"title":"Customer Identity (CIAM)","description":"Auth, SSO, SCIM, entitlements, and user management — guides, SDKs, and APIs.","includeFiles":["ciam/**/*.md"],"excludeFiles":[]},{"title":"Agen for SaaS","description":"Agentic access and authorization for SaaS products.","includeFiles":["agen-for-saas/**/*.md"],"excludeFiles":[]},{"title":"Agen for Work","description":"Agentic access and authorization for internal and workforce use.","includeFiles":["agen-for-work/**/*.md"],"excludeFiles":[]},{"title":"Platform","description":"Shared platform overview.","includeFiles":["platform/**/*.md"],"excludeFiles":[]}],"excludeFiles":["internal-docs/**","ciam/guides/env-settings/inject-client-ip.md","CLAUDE.md",".claude/**","**/images/**"],"hide":false}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-openapi-folder","__idx":0},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["openapi"]}," folder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This folder contains your entrypoint ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["openapi.yaml"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["That file contains references to the entire API definition."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Here are some sections to pay attention to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Top-level ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["description"]},": this accepts markdown, and Redoc and Redocly API Reference will render it at the top of the docs.  Consider maintaining your markdown in a separate file and ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://redocly.com/docs/api-reference-docs/embedded-markdown/"},"children":["embedding it"]},". Note to Redoc community edition users, the special tags are only available to the Redocly API Reference users, but you can still embed markdown."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Security schemes: you will define the scheme(s) your API uses for security (eg OAuth2, API Key, etc...). The security schemes are used by the Redocly API Reference \"Try It\" API console feature."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/ciam/api/paths/readme"},"children":["Paths"]},": this defines each endpoint.  A path can have one operation per http method."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tags: it's a good idea to organize each operation.  Each tag can have a description.  The description is used as a section description within the reference docs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Servers: a list of your servers, each with a URL."]}]}]},"headings":[{"value":"The openapi folder","id":"the-openapi-folder","depth":2}],"frontmatter":{"seo":{"title":"The openapi folder"}},"lastModified":"2025-11-04T13:25:50.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/ciam/api/readme","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}