Show Menu
Search…
Ctrl+K
ESC
Example searches: “clientDataJSON”, “description”, “identifier”, “result”, “retries”
Toggle dark mode
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
main
main
default
dev
Topics
Introduction
Endpoints
Applications
GET /api/applications
GET
POST /api/applications
POST
GET /api/applications/{id}
GET
DELETE /api/applications/{id}
DELETE
PATCH /api/applications/{id}
PATCH
GET /api/applications/{applicationId}/roles
GET
PUT /api/applications/{applicationId}/roles
PUT
POST /api/applications/{applicationId}/roles
POST
DELETE /api/applications/{applicationId}/roles/{roleId}
DELETE
Authn
GET /api/authn/hasura
GET
POST /api/authn/saml/{connectorId}
POST
POST /api/authn/single-sign-on/saml/{connectorId}
POST
Configs
GET /api/configs/admin-console
GET
PATCH /api/configs/admin-console
PATCH
GET /api/configs/oidc/{keyType}
GET
DELETE /api/configs/oidc/{keyType}/{keyId}
DELETE
POST /api/configs/oidc/{keyType}/rotate
POST
Connector factories
GET /api/connector-factories
GET
GET /api/connector-factories/{id}
GET
Connectors
GET /api/connectors
GET
POST /api/connectors
POST
GET /api/connectors/{id}
GET
DELETE /api/connectors/{id}
DELETE
PATCH /api/connectors/{id}
PATCH
POST /api/connectors/{factoryId}/test
POST
POST /api/connectors/{connectorId}/authorization-uri
POST
Custom phrases
GET /api/custom-phrases
GET
GET /api/custom-phrases/{languageTag}
GET
PUT /api/custom-phrases/{languageTag}
PUT
DELETE /api/custom-phrases/{languageTag}
DELETE
Dashboard
GET /api/dashboard/users/total
GET
GET /api/dashboard/users/new
GET
GET /api/dashboard/users/active
GET
Domains
GET /api/domains
GET
POST /api/domains
POST
GET /api/domains/{id}
GET
DELETE /api/domains/{id}
DELETE
Hooks
GET /api/hooks
GET
POST /api/hooks
POST
GET /api/hooks/{id}
GET
DELETE /api/hooks/{id}
DELETE
PATCH /api/hooks/{id}
PATCH
GET /api/hooks/{id}/recent-logs
GET
POST /api/hooks/{id}/test
POST
PATCH /api/hooks/{id}/signing-key
PATCH
Interaction
PUT /api/interaction
PUT
DELETE /api/interaction
DELETE
PUT /api/interaction/event
PUT
PATCH /api/interaction/identifiers
PATCH
PUT /api/interaction/profile
PUT
DELETE /api/interaction/profile
DELETE
PATCH /api/interaction/profile
PATCH
POST /api/interaction/submit
POST
POST /api/interaction/consent
POST
POST /api/interaction/verification/social-authorization-uri
POST
POST /api/interaction/verification/verification-code
POST
POST /api/interaction/verification/totp
POST
POST /api/interaction/verification/webauthn-registration
POST
POST /api/interaction/verification/webauthn-authentication
POST
POST /api/interaction/bind-mfa
POST
PUT /api/interaction/mfa
PUT
PUT /api/interaction/mfa-skipped
PUT
POST /api/interaction/single-sign-on/{connectorId}/authorization-url
POST
POST /api/interaction/single-sign-on/{connectorId}/authentication
POST
POST /api/interaction/single-sign-on/{connectorId}/registration
POST
GET /api/interaction/single-sign-on/connectors
GET
Logs
GET /api/logs
GET
GET /api/logs/{id}
GET
Organization roles
Get organization role by ID
GET
Delete organization role by ID
DELETE
Update organization role by ID
PATCH
Get organization roles
GET
Create a new organization role
POST
Get organization role scopes
GET
Replace organization scopes for organization role
PUT
Assign organization scopes to organization role
POST
Remove organization scope
DELETE
Organization scopes
Get organization scopes
GET
Create a new organization scope
POST
Get organization scope by ID
GET
Delete organization scope by ID
DELETE
Update organization scope by ID
PATCH
Organizations
Get organizations
GET
Create a new organization
POST
Get organization by ID
GET
Delete organization by ID
DELETE
Update organization by ID
PATCH
Get organization user members
GET
Replace organization user members
PUT
Add user members to organization
POST
Remove user member from organization
DELETE
Assign roles to organization user members
POST
Get roles for a user in an organization
GET
Update roles for a user in an organization
PUT
Assign roles to a user in an organization
POST
Remove a role from a user in an organization
DELETE
Resources
GET /api/resources
GET
POST /api/resources
POST
GET /api/resources/{id}
GET
DELETE /api/resources/{id}
DELETE
PATCH /api/resources/{id}
PATCH
PATCH /api/resources/{id}/is-default
PATCH
GET /api/resources/{resourceId}/scopes
GET
POST /api/resources/{resourceId}/scopes
POST
DELETE /api/resources/{resourceId}/scopes/{scopeId}
DELETE
PATCH /api/resources/{resourceId}/scopes/{scopeId}
PATCH
Roles
GET /api/roles
GET
POST /api/roles
POST
GET /api/roles/{id}
GET
DELETE /api/roles/{id}
DELETE
PATCH /api/roles/{id}
PATCH
GET /api/roles/{id}/users
GET
POST /api/roles/{id}/users
POST
DELETE /api/roles/{id}/users/{userId}
DELETE
GET /api/roles/{id}/applications
GET
POST /api/roles/{id}/applications
POST
DELETE /api/roles/{id}/applications/{applicationId}
DELETE
GET /api/roles/{id}/scopes
GET
POST /api/roles/{id}/scopes
POST
DELETE /api/roles/{id}/scopes/{scopeId}
DELETE
Sign in exp
GET /api/sign-in-exp
GET
PATCH /api/sign-in-exp
PATCH
Sso connector factories
GET /api/sso-connector-factories
GET
Sso connectors
GET /api/sso-connectors
GET
POST /api/sso-connectors
POST
GET /api/sso-connectors/{id}
GET
DELETE /api/sso-connectors/{id}
DELETE
PATCH /api/sso-connectors/{id}
PATCH
PATCH /api/sso-connectors/{id}/config
PATCH
Status
Health check
GET
Swagger.json
GET /api/swagger.json
GET
User assets
GET /api/user-assets/service-status
GET
POST /api/user-assets
POST
Users
GET /api/users/{userId}
GET
DELETE /api/users/{userId}
DELETE
PATCH /api/users/{userId}
PATCH
GET /api/users/{userId}/custom-data
GET
PATCH /api/users/{userId}/custom-data
PATCH
GET /api/users
GET
POST /api/users
POST
PATCH /api/users/{userId}/password
PATCH
POST /api/users/{userId}/password/verify
POST
GET /api/users/{userId}/has-password
GET
PATCH /api/users/{userId}/is-suspended
PATCH
GET /api/users/{userId}/roles
GET
PUT /api/users/{userId}/roles
PUT
POST /api/users/{userId}/roles
POST
DELETE /api/users/{userId}/roles/{roleId}
DELETE
POST /api/users/{userId}/identities
POST
DELETE /api/users/{userId}/identities/{target}
DELETE
GET /api/users/{userId}/organizations
GET
GET /api/users/{userId}/mfa-verifications
GET
POST /api/users/{userId}/mfa-verifications
POST
DELETE /api/users/{userId}/mfa-verifications/{verificationId}
DELETE
Verification codes
POST /api/verification-codes
POST
POST /api/verification-codes/verify
POST
Well known
GET /api/.well-known/sign-in-exp
GET
GET /api/.well-known/phrases
GET
Dismiss highlight
Show more
Verification codes