API reference
OpenAPI-generated endpoint docs for the next-generation Zitadel preview.
The API reference is generated from api/openapi/openapi-spec.yaml during the docs build.
Use it when you need exact request bodies, response shapes, auth requirements, and operation names for the preview server. For the higher-level product path, start with the CLI and SDK docs first:
Grouped by OpenAPI tags
Generated operation pages are grouped by domain tags from the OpenAPI source. Update the spec tags when an endpoint belongs in a different reference section.
Runtime auth
Authorization
OIDC/OAuth discovery, authorize, token, keys, revoke, introspection, and userinfo endpoints.
Flows
Flow start, step, submit, event, and session integration endpoints.
Authentication Attempts
Challenge, verification, handoff, and state-machine endpoints.
Sessions
Session creation, lookup, exchange, and teardown endpoints.
Configuration
Flow Definitions
Templates that describe login, registration, and recovery flows.
Projects
Project creation and lookup endpoints.
Teams
Team creation and lookup endpoints.
Users
User creation, lookup, current-user, and password endpoints.
Schemas
User schema creation and lookup endpoints.
System
The source OpenAPI document is bundled into apps/docs/.generated/openapi.yaml before Fumapress creates the reference pages.