# Zitadel preview

> The server's API as one OpenAPI document: [openapi.json](/docs/openapi.json).

- [Overview](/docs/index.md): Start here for the current Zitadel preview docs, shipped boundaries, and navigation.
- Get started
  - [Quickstart](/docs/get-started/quickstart.md): Add the Zitadel preview to a local app with the CLI and npm-binary runtime.
  - [Add Zitadel to an existing app](/docs/get-started/existing-app.md): Run setup in an app you already have, what it writes for each framework, and when it stops instead.
  - [Agent setup](/docs/get-started/agents.md): Install the Zitadel Agent Skills, drive the CLI with JSON envelopes, and prove auth in a browser.
- Guides
  - [Run Zitadel locally](/docs/guides/local-runtime.md): Start, stop, and reset the local Zitadel the CLI manages, and sign in to its console.
  - [Edit the login flow and schema](/docs/guides/plan-apply.md): Change your user schema and login flows in .zitadel/, preview the change with plan, and publish it with apply.
  - [Add social sign-in](/docs/guides/social-sign-in.md): Let users sign in with Google or any OpenID Connect provider, set up with the zitadel CLI.
  - [Customize the login design](/docs/guides/customize-design.md): Style the login from your app's stylesheet, or eject a starter design, add your branding, and publish it as a revision.
  - [Customize the login text](/docs/guides/customize-copy.md): Change the login's wording, translate it, and label the steps you add to a flow.
  - [Troubleshooting](/docs/guides/troubleshooting.md): Common CLI errors and first checks.
- Concepts
  - [Concepts](/docs/concepts.md): The minimum vocabulary for the Zitadel preview, and how the pieces fit together.
  - [Project, team, and user](/docs/concepts/project-team-user.md): Core resource vocabulary for the preview.
  - [Configuration as code](/docs/concepts/repo-config.md): How your project's auth configuration lives in repo files, syncs with plan and apply, and becomes revisions.
  - [Flows and schemas](/docs/concepts/flows-and-schemas.md): The relationship between login flows, user schemas, and generated UI.
  - [Sessions and auth attempts](/docs/concepts/sessions-auth-attempts.md): Durable sessions and ephemeral authentication attempts.
  - [Databases](/docs/concepts/databases.md): Choose SQLite, PostgreSQL, or Spanner for the Zitadel server.
- SDKs
  - [SDKs](/docs/sdks.md): Framework packages and shared client surfaces for the Zitadel preview.
  - [SDK proxy](/docs/sdks/proxy.md): Why framework SDKs proxy Zitadel requests through the app origin.

  - **Server frameworks**
  - [Next.js SDK](/docs/sdks/next.md): Middleware and helpers for Next.js applications.
  - [Nuxt SDK](/docs/sdks/nuxt.md): Nitro middleware and composables for Nuxt applications.
  - [SvelteKit SDK](/docs/sdks/sveltekit.md): A server hook and helpers for SvelteKit applications.
  - [SolidStart SDK](/docs/sdks/solid-start.md): Request middleware and helpers for SolidStart applications.
  - [Qwik Router SDK](/docs/sdks/qwik-router.md): An onRequest plugin and helpers for Qwik Router (formerly Qwik City) applications.
  - [TanStack Start SDK](/docs/sdks/tanstack-start.md): Request middleware, route guards, and React widgets for TanStack Start applications.

  - **SPA frameworks**
  - [React SDK](/docs/sdks/react.md): Client-side React wrappers for the Zitadel login and logout components.
  - [Vue SDK](/docs/sdks/vue.md): Client-side Vue 3 wrappers for the Zitadel login and logout components.
  - [Angular SDK](/docs/sdks/angular.md): Client-side Angular wrappers for the Zitadel login and logout components.
  - [Solid SDK](/docs/sdks/solid.md): Client-side Solid wrappers for the Zitadel login and logout components.
  - [Svelte SDK](/docs/sdks/svelte.md): Client-side Svelte 5 wrappers for the Zitadel login and logout components.
  - [Qwik SDK](/docs/sdks/qwik.md): Client-side Qwik wrappers for the Zitadel login and logout components.

  - **Building blocks**
  - [Components](/docs/sdks/components.md): Shared web components used by framework SDKs.
  - [API client](/docs/sdks/api-client.md): Generated TypeScript client and runtime configuration.
- CLI reference
  - [CLI reference](/docs/reference/cli.md): Every zitadel command, with its flags and examples.
  - [Telemetry](/docs/reference/cli/telemetry.md): What the zitadel CLI reports about how it is used, and how to turn that off.
  - [Release notes](/docs/reference/cli/release-notes.md): What changed in each version of the zitadel CLI.

  - **Project commands**
  - [zitadel setup](/docs/reference/cli/setup.md): Create a Zitadel project and scaffold local auth.
  - [zitadel claim](/docs/reference/cli/claim.md): Claim this project to make it permanent.
  - [zitadel doctor](/docs/reference/cli/doctor.md): Verify local runtime and project state.
  - [zitadel eject](/docs/reference/cli/eject.md): Remove managed files and local Zitadel state.

  - **Local server commands**
  - [zitadel start](/docs/reference/cli/start.md): Start a local Zitadel server.
  - [zitadel stop](/docs/reference/cli/stop.md): Stop the local Zitadel server.
  - [zitadel status](/docs/reference/cli/status.md): Summarize the local Zitadel server and project state.
  - [zitadel logs](/docs/reference/cli/logs.md): Show local Zitadel server logs.
  - [zitadel reset](/docs/reference/cli/reset.md): Delete the local Zitadel server runtime and data.
  - [zitadel console](/docs/reference/cli/console.md): Open the local console, signed in as the local admin created by zitadel start.

  - **Configuration commands**
  - [zitadel plan](/docs/reference/cli/plan.md): Validate config without mutation and preview the sync diff.
  - [zitadel apply](/docs/reference/cli/apply.md): Validate and upload repo config to the platform.
  - [zitadel branding eject](/docs/reference/cli/branding/eject.md): Take ownership of the login template: scaffold .zitadel/branding/ from a shipped design.
  - [zitadel auth-method passkey disable](/docs/reference/cli/auth-method/passkey/disable.md): Disable passkey sign-in for a user schema.
  - [zitadel auth-method passkey enable](/docs/reference/cli/auth-method/passkey/enable.md): Enable passkey sign-in for a user schema.
  - [zitadel auth-method password disable](/docs/reference/cli/auth-method/password/disable.md): Disable password sign-in for a user schema.
  - [zitadel auth-method password enable](/docs/reference/cli/auth-method/password/enable.md): Enable password sign-in for a user schema.
  - [zitadel auth-method sso disable](/docs/reference/cli/auth-method/sso/disable.md): Remove an identity provider from a user schema.
  - [zitadel auth-method sso enable](/docs/reference/cli/auth-method/sso/enable.md): Add an identity provider to a user schema.
  - [zitadel branding get](/docs/reference/cli/branding/get.md): Get one branding revision by id.
  - [zitadel branding list](/docs/reference/cli/branding/list.md): List branding.
  - [zitadel flow-definitions get](/docs/reference/cli/flow-definitions/get.md): Get one flow definition by id.
  - [zitadel flow-definitions list](/docs/reference/cli/flow-definitions/list.md): List flow-definitions.
  - [zitadel releases get](/docs/reference/cli/releases/get.md): Get one release by id.
  - [zitadel releases list](/docs/reference/cli/releases/list.md): List releases.
  - [zitadel schemas get](/docs/reference/cli/schemas/get.md): Get one schema by id.
  - [zitadel schemas list](/docs/reference/cli/schemas/list.md): List schemas.
  - [zitadel variables delete](/docs/reference/cli/variables/delete.md): Delete one variable from the project.
  - [zitadel variables get](/docs/reference/cli/variables/get.md): Get one variable from the project.
  - [zitadel variables list](/docs/reference/cli/variables/list.md): List the variables entered on the project.
  - [zitadel variables set](/docs/reference/cli/variables/set.md): Set one variable on the project.

  - **Resource commands**
  - [zitadel resources](/docs/reference/cli/resources.md): List the resources this CLI manages and what can be done to each.
  - api
    - [zitadel api](/docs/reference/cli/api.md): Call any operation of the Zitadel API, with this project's server and project secret.
    - [zitadel api ls](/docs/reference/cli/api/ls.md): List the operations of the Zitadel API that zitadel api calls.
  - [zitadel events get](/docs/reference/cli/events/get.md): Get one event by id.
  - [zitadel events list](/docs/reference/cli/events/list.md): List events.
  - [zitadel grants create](/docs/reference/cli/grants/create.md): Create a grant.
  - [zitadel grants delete](/docs/reference/cli/grants/delete.md): Delete a grant by id.
  - [zitadel grants get](/docs/reference/cli/grants/get.md): Get one grant by id.
  - [zitadel grants list](/docs/reference/cli/grants/list.md): List grants.
  - [zitadel idps create](/docs/reference/cli/idps/create.md): Create an identity provider connection.
  - [zitadel idps get](/docs/reference/cli/idps/get.md): Get one identity provider connection by id.
  - [zitadel idps list](/docs/reference/cli/idps/list.md): List idps.
  - [zitadel projects get](/docs/reference/cli/projects/get.md): Get one project by id.
  - [zitadel projects list](/docs/reference/cli/projects/list.md): List projects.
  - [zitadel projects update](/docs/reference/cli/projects/update.md): Update a project by id.
  - [zitadel sessions get](/docs/reference/cli/sessions/get.md): Get one session by id.
  - [zitadel sessions list](/docs/reference/cli/sessions/list.md): List sessions.
  - [zitadel sessions revoke](/docs/reference/cli/sessions/revoke.md): Revoke a session by id.
  - [zitadel teams create](/docs/reference/cli/teams/create.md): Create a team.
  - [zitadel teams deactivate](/docs/reference/cli/teams/deactivate.md): Deactivate a team by id.
  - [zitadel teams get](/docs/reference/cli/teams/get.md): Get one team by id.
  - [zitadel teams list](/docs/reference/cli/teams/list.md): List teams.
  - [zitadel teams update](/docs/reference/cli/teams/update.md): Update a team by id.
  - [zitadel users create](/docs/reference/cli/users/create.md): Create a user.
  - [zitadel users delete](/docs/reference/cli/users/delete.md): Delete a user by id.
  - [zitadel users get](/docs/reference/cli/users/get.md): Get one user by id.
  - [zitadel users list](/docs/reference/cli/users/list.md): List users.
  - [zitadel users update](/docs/reference/cli/users/update.md): Update a user by id.
- API reference
  - [API reference](/docs/reference/api.md): How to call the Zitadel API, and every operation it has, generated from its OpenAPI document.
  - [Errors](/docs/reference/api/errors.md): Every error code of the API, what it means, and the operations that return it.

  - **Runtime auth**
  - Flows
    - [Flows](/docs/reference/api/flows.md): OpenAPI operations for browser-facing flow orchestration.
    - [Start a new flow](/docs/reference/api/flows/createFlow.md): Resolves a flow definition based on purpose + audience context and returns the first capability step.
    - [Get current step (re-render)](/docs/reference/api/flows/getFlowStep.md): Returns the current capability step without advancing the state machine.
    - [Submit step data and advance](/docs/reference/api/flows/submitFlowStep.md): Submits user input for the current step.
  - Authentication attempts
    - [Authentication attempts](/docs/reference/api/authentication-attempts.md): OpenAPI operations for the authentication attempt state machine.
    - [Create a new authentication attempt](/docs/reference/api/authentication-attempts/createAuthAttempt.md): Starts a new authentication attempt.
    - [Get authentication attempt state](/docs/reference/api/authentication-attempts/getAuthAttempt.md): Polls the current state of an authentication attempt.
    - [Issue a factor challenge](/docs/reference/api/authentication-attempts/issueChallenge.md): Issues a single-factor verification challenge within an auth attempt.
    - [Verify a factor proof](/docs/reference/api/authentication-attempts/verifyChallengeProof.md): Submits a proof (credential, code, assertion) to verify a factor challenge.
    - [Complete authentication and create handoff token](/docs/reference/api/authentication-attempts/createHandoff.md): Completes the authentication attempt and mints a handoff_token.
  - Sessions
    - [Sessions](/docs/reference/api/sessions.md): OpenAPI operations for session creation, lookup, exchange, and teardown.
    - [Create an anonymous session shell](/docs/reference/api/sessions/createSession.md): Creates an anonymous session shell with no user and no factors (state: building).
    - [Query sessions](/docs/reference/api/sessions/querySessions.md): Returns the sessions of a project, paginated with a cursor.
    - [Exchange handoff token for a session](/docs/reference/api/sessions/exchangeHandoff.md): Consumes a one-time handoff_token minted by POST /auth_attempts/{id}/handoff and returns the resulting session and a session_token.
    - [Get session state](/docs/reference/api/sessions/getSession.md): Returns the current state of a session including its factors and all currently satisfied assurance levels.
    - [Revoke session](/docs/reference/api/sessions/revokeSession.md): Permanently deletes the session, terminating it immediately.
    - [Get my session state](/docs/reference/api/sessions/getMySession.md): Returns the current state of the current session including its factors and all currently satisfied assurance levels.
    - [Revoke my session](/docs/reference/api/sessions/revokeMySession.md): Logs out by permanently deleting the session.
    - [Get my session's CSRF token](/docs/reference/api/sessions/getMySessionCsrfToken.md): Returns the session-bound token for cross-site request forgery protection (ADR 053 §5).

  - **Configuration**
  - Flow definitions
    - [Flow definitions](/docs/reference/api/flow-definitions.md): OpenAPI operations for flow definition templates.
    - [List flow definitions](/docs/reference/api/flow-definitions/listFlowDefinitions.md): Retrieves a list of all flow definitions, newest by creation time first.
    - [Create a new flow definition](/docs/reference/api/flow-definitions/createFlowDefinition.md): Publishes a new flow definition revision.
    - [Get a flow definition by id](/docs/reference/api/flow-definitions/getFlowDefinition.md): Get a flow definition by id
  - Schemas
    - [Schemas](/docs/reference/api/schemas.md): OpenAPI operations for user and configuration schemas.
    - [List all schemas](/docs/reference/api/schemas/listSchemas.md): Retrieve a list of all schemas available in the system.
    - [Create new schema](/docs/reference/api/schemas/createSchema.md): Create a new schema.
    - [Get schema by ID](/docs/reference/api/schemas/getSchemaById.md): Get a schema by its ID.
  - Branding
    - [Branding](/docs/reference/api/branding.md): OpenAPI operations for login branding revisions.
    - [List branding revisions](/docs/reference/api/branding/listBranding.md): Lists branding revisions for the project, newest first, capped at the 100 most recent.
    - [Publish a new branding revision](/docs/reference/api/branding/createBranding.md): Publishes a new immutable branding revision for the project.
    - [Get a branding revision by ID](/docs/reference/api/branding/getBrandingById.md): Retrieves a single branding revision, including its stored configuration.
  - Identity providers
    - [Identity providers](/docs/reference/api/identity-providers.md): OpenAPI operations for identity provider connections.
    - [Create or revise an identity provider connection](/docs/reference/api/identity-providers/createIdp.md): Creates or revises a connection document.
    - [Query identity provider connections](/docs/reference/api/identity-providers/queryIdps.md): Returns the identity provider connections of a project, paginated with a cursor.
    - [Get an identity provider connection by id](/docs/reference/api/identity-providers/getIdpById.md): Reads a connection by its id, at its newest revision.
    - [List the revisions of an identity provider connection](/docs/reference/api/identity-providers/listIdpRevisions.md): Returns every revision of one connection, newest first, paginated with a cursor.
    - [Get one revision of an identity provider connection](/docs/reference/api/identity-providers/getIdpRevisionById.md): Reads one revision of a connection by its revision_id, the value an auth attempt or a release pins.
  - Policies
    - [Policies](/docs/reference/api/policies.md): OpenAPI operations for operation policies, such as the password policy.
    - [List policies](/docs/reference/api/policies/listPolicies.md): Lists the project's policies, one per operation, each as its newest revision, ordered by created_at (first publish) and then id.
    - [Publish a policy](/docs/reference/api/policies/publishPolicy.md): Publishes the project's policy for an operation as a new immutable revision, creating the policy on its first publish.
    - [Get a policy](/docs/reference/api/policies/getPolicy.md): Reads a policy as its newest revision, the one that applies the next time its operation runs.
    - [List the revisions of a policy](/docs/reference/api/policies/listPolicyRevisions.md): Returns every revision of one policy, newest first, paginated with a cursor.
    - [Get a policy revision](/docs/reference/api/policies/getPolicyRevision.md): Reads one revision of a policy, newest or not.
  - Variables
    - [Variables](/docs/reference/api/variables.md): OpenAPI operations for project variables and secrets.
    - [Get variables](/docs/reference/api/variables/getVariables.md): Returns the project's variables, keyed by name, each with its value per kind.
    - [Update variables](/docs/reference/api/variables/updateVariables.md): Enters, replaces and removes the project's variables for the requested kind.
    - [Get a variable](/docs/reference/api/variables/getVariable.md): Reads one variable by name, with its value per kind.
    - [Delete a variable](/docs/reference/api/variables/deleteVariable.md): Removes a variable for the requested kind, or for both kinds without kind.
  - Releases
    - [Releases](/docs/reference/api/releases.md): OpenAPI operations for configuration releases.
    - [List releases](/docs/reference/api/releases/listReleases.md): Lists the project's releases, newest first.
    - [Create a release](/docs/reference/api/releases/createRelease.md): Assembles a release from existing revisions, given as (kind, revision_id) pairs.
    - [Build a release from files](/docs/reference/api/releases/buildRelease.md): Builds a release from the resources of .zitadel/ as authored on disk, grouped by kind, in one transaction: a failure anywhere leaves no revision and no release.
    - [Get a release by id](/docs/reference/api/releases/getReleaseById.md): Reads one release: its digest, its metadata, whether it was revoked, and the (kind, handle, revision_id) tuples it pins.
    - [Revoke a release](/docs/reference/api/releases/revokeRelease.md): Marks the release revoked, so that its content is never served again.
  - Deployments
    - [Deployments](/docs/reference/api/deployments.md): OpenAPI operations for deployments.
    - [List deployments](/docs/reference/api/deployments/listDeployments.md): Lists what ran where, and when.
    - [Create a deployment](/docs/reference/api/deployments/createDeployment.md): Makes a release live on its targets by recording a deployment, atomically: on success every target serves the release and the record exists; on failure nothing changes and no record is written.
    - [Get a deployment by id](/docs/reference/api/deployments/getDeploymentById.md): Reads one deployment record.
    - [Roll back to a deployment](/docs/reference/api/deployments/rollbackDeployment.md): Re-deploys the release of the deployment named in the path to primary, with the variable values it froze: a new deployment with reason: rollback and rollback_to naming it.
    - [Get a deployment's variables](/docs/reference/api/deployments/getDeploymentVariables.md): Returns the variable values the deployment froze when it was made.
  - Previews
    - [Previews](/docs/reference/api/previews.md): OpenAPI operations for live preview URLs.
    - [List previews](/docs/reference/api/previews/listPreviews.md): Lists the project's live previews, newest first by created_at.
    - [Remove a preview](/docs/reference/api/previews/removePreview.md): Ends a preview before it expires: the URL stops being served at once.

  - **Management**
  - Projects
    - [Projects](/docs/reference/api/projects.md): OpenAPI operations for projects, project claims, and origin patterns.
    - [List the projects I can act on](/docs/reference/api/projects/listMyProjects.md): The projects the signed-in user can act on: those they hold an active grant on, either directly or through a team they are a member of.
    - [Create project](/docs/reference/api/projects/createProject.md): Creates a project and returns its project secret and preview secret, which no other endpoint returns.
    - [Query projects](/docs/reference/api/projects/queryProjects.md): Returns the project the project secret belongs to, as a page of at most one project.
    - [Get project](/docs/reference/api/projects/getProject.md): Returns the current state of a project.
    - [Update project](/docs/reference/api/projects/patchProject.md): Updates the state of a project.
    - [Initialize a project claim](/docs/reference/api/projects/initClaim.md): Starts a claim challenge for an unclaimed project.
    - [Get claim status](/docs/reference/api/projects/getClaimStatus.md): Polled by the CLI while a browser completes the claim.
    - [Complete a project claim](/docs/reference/api/projects/completeClaim.md): Called by the browser after the developer authenticates on the claim page.
    - [Get the claim window for a project](/docs/reference/api/projects/getClaimWindow.md): Read by the claim page in the browser to show how long is left to claim the project.
    - [Add an origin pattern](/docs/reference/api/projects/addOrigin.md): Adds one {pattern, kind} to the project's origins.
    - [Remove an origin pattern](/docs/reference/api/projects/removeOrigin.md): Removes one pattern from the project's origins.
  - Teams
    - [Teams](/docs/reference/api/teams.md): OpenAPI operations for team lifecycle endpoints.
    - [Create team](/docs/reference/api/teams/createTeam.md): Creates a team in the project, with a name no other team in the project has.
    - [Query teams](/docs/reference/api/teams/queryTeams.md): Returns the teams of a project, paginated with a cursor.
    - [Get team](/docs/reference/api/teams/getTeam.md): Returns a Team by its id.
    - [Update team](/docs/reference/api/teams/updateTeam.md): Update team.
    - [Delete team](/docs/reference/api/teams/deleteTeam.md): Deactivates the team.
  - Users
    - [Users](/docs/reference/api/users.md): OpenAPI operations for user lifecycle and account data.
    - [Create user](/docs/reference/api/users/createUser.md): Creates a user whose attributes satisfy the user schema the request names.
    - [Query users](/docs/reference/api/users/queryUsers.md): Returns the users of a project, paginated with a cursor.
    - [Get user by ID](/docs/reference/api/users/GetUserByID.md): Returns a user by its id, with the attributes its schema defines.
    - [Update user by ID](/docs/reference/api/users/PatchUserByID.md): Partially updates a user's schema-defined attributes, and optionally moves the user to another registered schema.
    - [Delete user by ID](/docs/reference/api/users/DeleteUserByID.md): Deletes a user and removes them from every team they belong to.
    - [List the provider accounts linked to a user](/docs/reference/api/users/listUserIdentityLinks.md): The identity provider accounts a sign-in linked to the user, oldest first.
    - [List user passkeys](/docs/reference/api/users/listUserPasskeys.md): Returns the passkeys registered for a user, newest first, paginated with a cursor.
    - [Begin passkey registration](/docs/reference/api/users/beginUserPasskeyRegistration.md): Starts a WebAuthn registration ceremony for the user and returns the creation options for navigator.credentials.create().
    - [Finish passkey registration](/docs/reference/api/users/finishUserPasskeyRegistration.md): Verifies the attestation against the ceremony started by POST /users/{user_id}/passkeys/registrations and persists the new credential.
    - [Get user password state](/docs/reference/api/users/getUserPasswordState.md): Reports when the user's current password was set, and leaves set_at out when the user has none.
    - [Set user password](/docs/reference/api/users/setUserPassword.md): Sets a user's password, hashed with the project's current password hashing policy.
    - [List the teams a user belongs to](/docs/reference/api/users/listUserTeams.md): The user's team roster, ordered by team name.
    - [Get my user information](/docs/reference/api/users/getMyUser.md): Returns the user signed in to the session that authenticates the request.
    - [Update my user information](/docs/reference/api/users/patchMyUser.md): Partially updates the caller's own schema-defined attributes.
    - [List the provider accounts linked to me](/docs/reference/api/users/listMyIdentityLinks.md): The identity provider accounts a sign-in linked to the signed-in user, oldest first.
    - [List my passkeys](/docs/reference/api/users/listMyPasskeys.md): The signed-in user's own passkeys, newest first, paginated with a cursor.
    - [Get my password state](/docs/reference/api/users/getMyPasswordState.md): Reports when the signed-in user's current password was set, and leaves set_at out when they have none.
    - [Get my user schema](/docs/reference/api/users/getMyUserSchema.md): The schema the signed-in user's own record is validated against.
    - [List the teams I belong to](/docs/reference/api/users/listMyTeams.md): The signed-in user's own team roster, ordered by team name.
  - Grants
    - [Grants](/docs/reference/api/grants.md): OpenAPI operations for collaboration grants.
    - [Create grant](/docs/reference/api/grants/createGrant.md): Bind a user or team to project.viewer, project.editor, or project.admin on the project identified by the project-id header.
    - [Query grants](/docs/reference/api/grants/queryGrants.md): Returns the collaboration grants of a project, paginated with a cursor.
    - [Get grant](/docs/reference/api/grants/getGrant.md): Loads a grant by (project_id, id) that this API manages (user or team bound to viewer, editor, or admin) and that has not been revoked.
    - [Revoke grant](/docs/reference/api/grants/deleteGrant.md): Soft-revokes a grant this API manages and emits authz.revoked.
  - Events
    - [Events](/docs/reference/api/events.md): OpenAPI operations for the project's audit events.
    - [List events](/docs/reference/api/events/listEvents.md): Returns project-scoped audit events, newest-first by keyset on (created_at, id) (ADR 027 / ADR 049).
    - [Get event by ID](/docs/reference/api/events/getEvent.md): Loads a single event by (project_id, id).
  - Event webhooks
    - [Event webhooks](/docs/reference/api/event-webhooks.md): The requests the server sends a webhook to deliver the project's events, one page per event type.
    - [auth.attempt.created](/docs/reference/api/event-webhooks/authAttemptCreated.md): An authentication attempt started.
    - [auth.attempt.handed_off](/docs/reference/api/event-webhooks/authAttemptHandedOff.md): An authentication attempt was handed off to a session.
    - [auth.check.failed](/docs/reference/api/event-webhooks/authCheckFailed.md): A check in an authentication attempt failed, such as a wrong password.
    - [auth.check.succeeded](/docs/reference/api/event-webhooks/authCheckSucceeded.md): A check in an authentication attempt succeeded.
    - [auth.factor.passkey.enrolled](/docs/reference/api/event-webhooks/authFactorPasskeyEnrolled.md): A passkey was enrolled for a user.
    - [auth.factor.password.set](/docs/reference/api/event-webhooks/authFactorPasswordSet.md): A user's password was set.
    - [auth.sso.authorization.failed](/docs/reference/api/event-webhooks/authSsoAuthorizationFailed.md): The identity provider answered an SSO sign-in with an error, access_denied included, or the callback carried no code.
    - [auth.sso.exchange.failed](/docs/reference/api/event-webhooks/authSsoExchangeFailed.md): An SSO sign-in failed after its code arrived: the token exchange, the ID token or userinfo validation, or the connection's configuration failed.
    - [auth.sso.exchange.succeeded](/docs/reference/api/event-webhooks/authSsoExchangeSucceeded.md): The code an SSO sign-in returned was exchanged.
    - [auth.token.issued](/docs/reference/api/event-webhooks/authTokenIssued.md): A token was issued.
    - [auth.token.revoked](/docs/reference/api/event-webhooks/authTokenRevoked.md): A token was revoked.
    - [authz.granted](/docs/reference/api/event-webhooks/authzGranted.md): A role on a project was granted.
    - [authz.revoked](/docs/reference/api/event-webhooks/authzRevoked.md): A role on a project was revoked.
    - [branding.created](/docs/reference/api/event-webhooks/brandingCreated.md): A branding revision was created.
    - [deployment.created](/docs/reference/api/event-webhooks/deploymentCreated.md): A release was deployed, or a deployment rolled back.
    - [flowdef.created](/docs/reference/api/event-webhooks/flowdefCreated.md): A flow definition was created.
    - [flowdef.deleted](/docs/reference/api/event-webhooks/flowdefDeleted.md): A flow definition was deleted.
    - [flowdef.updated](/docs/reference/api/event-webhooks/flowdefUpdated.md): A flow definition was updated.
    - [idp.created](/docs/reference/api/event-webhooks/idpCreated.md): An identity provider connection was created.
    - [idp.identity_link.created](/docs/reference/api/event-webhooks/idpIdentityLinkCreated.md): A user was linked to an account at an identity provider, by an SSO sign-in that created the user.
    - [idp.updated](/docs/reference/api/event-webhooks/idpUpdated.md): An identity provider connection was revised.
    - [origin.added](/docs/reference/api/event-webhooks/originAdded.md): An origin was added to a project.
    - [origin.removed](/docs/reference/api/event-webhooks/originRemoved.md): An origin was removed from a project.
    - [policy.created](/docs/reference/api/event-webhooks/policyCreated.md): A project published the first revision of its policy for an operation.
    - [policy.updated](/docs/reference/api/event-webhooks/policyUpdated.md): A project published a new revision of its policy for an operation.
    - [project.created](/docs/reference/api/event-webhooks/projectCreated.md): A project was created.
    - [project.deleted](/docs/reference/api/event-webhooks/projectDeleted.md): A project was deleted.
    - [project.updated](/docs/reference/api/event-webhooks/projectUpdated.md): A project was updated.
    - [release.created](/docs/reference/api/event-webhooks/releaseCreated.md): A release was created.
    - [release.revoked](/docs/reference/api/event-webhooks/releaseRevoked.md): A release was revoked.
    - [request.api](/docs/reference/api/event-webhooks/requestApi.md): An API request in the project completed.
    - [schema.created](/docs/reference/api/event-webhooks/schemaCreated.md): A schema was created.
    - [session.deleted](/docs/reference/api/event-webhooks/sessionDeleted.md): A session was revoked.
    - [session.established](/docs/reference/api/event-webhooks/sessionEstablished.md): A session was established, by a sign-in or by exchanging a session.
    - [team.created](/docs/reference/api/event-webhooks/teamCreated.md): A team was created.
    - [team.deactivated](/docs/reference/api/event-webhooks/teamDeactivated.md): A team was deactivated.
    - [team.updated](/docs/reference/api/event-webhooks/teamUpdated.md): A team was updated.
    - [user.create.failed](/docs/reference/api/event-webhooks/userCreateFailed.md): Creating a user failed because a unique attribute was already taken.
    - [user.created](/docs/reference/api/event-webhooks/userCreated.md): A user was created.
    - [user.deleted](/docs/reference/api/event-webhooks/userDeleted.md): A user was deleted.
    - [user.updated](/docs/reference/api/event-webhooks/userUpdated.md): A user's attributes were updated.
    - [variable.removed](/docs/reference/api/event-webhooks/variableRemoved.md): A variable's value was removed.
    - [variable.set](/docs/reference/api/event-webhooks/variableSet.md): A variable was given a value, new or replacing one.

  - **System**
  - System
    - [System](/docs/reference/api/system.md): OpenAPI operations for server health, liveness, and readiness probes.
    - [Check server health](/docs/reference/api/system/getHealth.md): Check whether the server is healthy
    - [Check server liveness](/docs/reference/api/system/getLive.md): Check whether the server is started
    - [Check server readiness](/docs/reference/api/system/getReady.md): Check whether the server is ready to accept requests