Identity & Access API reference
Sign-in, sessions, MFA, passkeys and identity providers for your application’s end users.
Sign-in & Sessions
Signing your application's end users in and keeping them signed in: sign-up, sign-in, sign-out, passwordless magic links and one-time codes, passkeys, MFA enrolment, password reset, token refresh, whoami, and listing or revoking sessions.
The SDK surface is k9o.gate.*, with gate.signUp, gate.signIn, gate.signOut and gate.whoami at the root.
End users are a trust zone separate from operators, and in Native mode the tokens Gate issues scope every data query to the rows that user may see.
Creates a new end-user account on the project using email and password credentials.
Authenticates a project-scoped end-user with email and password credentials and returns a Gate JWT plus refresh token on success.
Exchanges a refresh token for a new Gate access JWT and a new refresh token, extending the end user's session under the project's session policy.
Validates a Gate-issued end-user access JWT, confirming it is properly signed and within its TTL.
Returns the identity record of the currently authenticated end-user, including their
eu_-prefixed ID, email, assigned roles (such asPROJECT_END_USER), and group memberships.Terminates the calling end-user's current project session by revoking the active refresh-token chain.
Ends every live session of the calling end user in this project, on every device, this one included.
Returns a cursor-paginated list of active sessions for all users within the project.
Sends a 6-digit one-time password to the end-user's email address, initiating a passwordless sign-in or step-up flow.
Verifies a one-time password previously sent to the end-user's email and, on success, issues a Gate JWT and refresh token.
Sends a single-use magic link to the end-user's email address to initiate passwordless sign-in.
Completes magic-link sign-in by verifying the token from the emailed link and issuing a Gate JWT and refresh token on success.
Initiates WebAuthn passkey registration for the authenticated end-user by returning a credential creation challenge.
Completes WebAuthn passkey registration by verifying the authenticator's attestation response and persisting the new
pky_-prefixed credential.Initiates WebAuthn passkey authentication for an end-user by returning an assertion challenge.
Completes WebAuthn passkey authentication by verifying the authenticator's assertion response, checking the signature counter for replay protection, and issuing a Gate JWT and refresh token on succ…
Initiates TOTP (time-based one-time password) MFA enrollment for the authenticated end-user, returning a provisioning QR code and the raw TOTP secret for scanning with an authenticator app.
Activates a pending TOTP MFA enrollment by verifying the first valid code from the authenticator app.
Returns the active MFA factor enrollments for the authenticated end-user, including TOTP and WebAuthn factors.
Removes a specific enrolled MFA factor (identified by
methodId) from the end-user's account, deactivating that factor for future sign-in challenges.Initiates a password reset flow for the specified email address by dispatching a single-use reset token.
Completes a password reset by accepting the single-use reset token and the new password.
Accepts a pending end-user invitation by presenting the single-use invitation token.
Federation
Letting your end users sign in with an outside identity provider: the OAuth2, OIDC and SAML 2.0 providers a project configures, the authorize and callback hops a browser or provider calls during sign-in, and the project's SAML service-provider metadata.
Federation for your own operators is configured separately, under Identity Providers.
Creates a new end-user federation provider configuration for the project.
Returns the paginated list of end-user federation provider configurations attached to the project.
Retrieves a single end-user federation provider configuration.
Partially updates a project-scoped end-user federation provider configuration.
Deletes a project-scoped end-user federation provider configuration.
Starts a redirect sign-in for an end user of this project.
Receives the authorization code and state from the identity provider after an end user authenticates.
Receives the SAML 2.0
SAMLResponseandRelayStatefrom the identity provider after a sign-in started atauthorize.
Auth Settings
How your project's sign-in is configured: the JWKS that verifies the tokens Gate issues, the end-user session policy, service tokens, allowed origins and sign-in flows.
Changes apply to every end user of the project.
Returns the public JSON Web Key Set used to verify bearer JWTs issued for this project.