Identity API reference

The pages in this section render the identity server's OpenAPI schema with Fumadocs OpenAPI. Open an endpoint group to inspect request parameters, response schemas, and code examples, or use its request playground.

Other groups, including API keys, signing keys, and two-factor authentication, are available in the sidebar.

Live reference and schemaCopy Anchor Link

• Identity server's live OpenAPI explorer
• Identity server's live OpenAPI JSON
• Schema snapshot used by these pages
• OIDC discovery

The checked-in snapshot was retrieved from the development server on October 15, 2026. The live server can change before these pages are refreshed. Its OpenAPI servers URL includes /api/auth; operation paths in the reference are relative to that base.

Use the playgroundCopy Anchor Link

The playground sends requests to the API server listed in the schema. Use test credentials and inspect the destination before sending a request that changes data. A browser request still needs the API's CORS and origin rules to permit the docs origin. No credential-forwarding proxy is configured by this documentation.

The generated schema marks many operations with a generic bearer security scheme. OAuth token, introspection, and revocation requests use the client's registered authentication method instead. Follow Connect a client for those requests. Identity session credentials and resource access tokens have different uses, so check the endpoint's requirements before entering a credential.

The schema describes Better Auth and public plugin endpoints. Identity's admin tRPC operations, including resource management, are not part of this contract. The custom organization API key exchange uses the token endpoint but adds fields that may not appear in its generated request schema.

The current schema references InviteType without defining it. The embedded renderer shows that value as an object with unspecified fields so the invitation reference can render. The downloadable snapshot preserves the server's original schema.

Refresh the embedded referenceCopy Anchor Link

From the docs-internal repository root:

# Download the development schema and regenerate the API pages.
pnpm --filter fumadocs identity:openapi:refresh

# Regenerate pages from the checked-in schema without downloading it.
pnpm --filter fumadocs identity:openapi

Review and commit the schema snapshot and generated pages together. Update the retrieval date above after a refresh. Builds read the local snapshot, so they do not need the identity server to be reachable.

See Better Auth's OpenAPI plugin for how the identity server produces the schema.