API Reference
Every endpoint, grouped by category. 304 operations across 31 categories. Select one to read its parameters, schema, and responses — and send it live.
System
1Users
10API Keys
4Auth
34- POST
/v1/auth/change-password - POST
/v1/auth/consent/accept - POST
/v1/auth/magic-link/start - GET
/v1/auth/me - GET
/v1/auth/me/identities - DELETE
/v1/auth/me/identities/{id} - POST
/v1/auth/me/identities/connect/{provider} - POST
/v1/auth/mfa/backup-codes - POST
/v1/auth/mfa/enroll/begin - POST
/v1/auth/mfa/enroll/complete - GET
/v1/auth/mfa/factors - DELETE
/v1/auth/mfa/factors/{id} - POST
/v1/auth/mfa/totp/enroll - POST
/v1/auth/mfa/totp/verify - POST
/v1/auth/mfa/verify - GET
/v1/auth/oauth/{application_id}/{provider}/callback - GET
/v1/auth/oauth/{application_id}/{provider}/start - POST
/v1/auth/otp/start - DELETE
/v1/auth/passkeys/{id} - POST
/v1/auth/passkeys/authenticate/begin - POST
/v1/auth/passkeys/authenticate/finish - POST
/v1/auth/passkeys/mfa/begin - POST
/v1/auth/passkeys/mfa/finish - POST
/v1/auth/passkeys/register/begin - POST
/v1/auth/passkeys/register/finish - POST
/v1/auth/password-reset/start - POST
/v1/auth/password-reset/verify - POST
/v1/auth/passwordless/verify - POST
/v1/auth/sign-in - POST
/v1/auth/sign-out - POST
/v1/auth/sign-out-all - POST
/v1/auth/sign-up - POST
/v1/auth/verify-email - POST
/v1/auth/verify-email/resend
Sessions
6Discovery
2Organizations
10- GET
/v1/organizations - POST
/v1/organizations - GET
/v1/organizations/{id} - PATCH
/v1/organizations/{id} - DELETE
/v1/organizations/{id} - POST
/v1/organizations/{id}/activate - GET
/v1/organizations/{id}/members - POST
/v1/organizations/{id}/members - PATCH
/v1/organizations/{id}/members/{user_id} - DELETE
/v1/organizations/{id}/members/{user_id}
Webhooks
6Audit
3Roles
5Authz
6Hooks
5Entitlements
9Lifecycle
9Invitations
12- GET
/v1/invitations - POST
/v1/invitations - DELETE
/v1/invitations/{id} - POST
/v1/invitations/accept - GET
/v1/organizations/{id}/join-requests - POST
/v1/organizations/{id}/join-requests - POST
/v1/organizations/{id}/join-requests/{request_id}/approve - POST
/v1/organizations/{id}/join-requests/{request_id}/deny - GET
/v1/waitlist - POST
/v1/waitlist/{id}/approve - POST
/v1/waitlist/{id}/deny - POST
/v1/waitlist/join
Billing
24- POST
/v1/billing/checkout - POST
/v1/billing/connect/account - POST
/v1/billing/connect/account-session - GET
/v1/billing/connect/status - GET
/v1/billing/invoices - GET
/v1/billing/invoices/{id} - GET
/v1/billing/me/invoices - GET
/v1/billing/me/invoices/{id} - POST
/v1/billing/me/setup-intent - GET
/v1/billing/me/subscription - POST
/v1/billing/me/subscription/cancel - POST
/v1/billing/me/subscription/change - POST
/v1/billing/me/subscription/resume - PUT
/v1/billing/payment-method - GET
/v1/billing/plans - GET
/v1/billing/pricing - GET
/v1/billing/profile - PATCH
/v1/billing/profile - POST
/v1/billing/setup-intent - POST
/v1/billing/subscribe - POST
/v1/billing/subscription - POST
/v1/billing/subscription/stripe - POST
/v1/billing/subscription/stripe/cancel - GET
/v1/billing/usage
Monetization
10- GET
/v1/billing/customer-plans - POST
/v1/billing/customer-plans - PATCH
/v1/billing/customer-plans/{id} - DELETE
/v1/billing/customer-plans/{id} - GET
/v1/billing/revenue - GET
/v1/billing/subscriptions - GET
/v1/organizations/{id}/entitlements - GET
/v1/organizations/{id}/subscription - PUT
/v1/organizations/{id}/subscription - DELETE
/v1/organizations/{id}/subscription
SAML SSO
7OIDC SSO
6SCIM
3Security
5Settings
28- GET
/v1/applications/{application_id}/branding/public - GET
/v1/applications/{id}/branding - PUT
/v1/applications/{id}/branding - GET
/v1/applications/{id}/domains - POST
/v1/applications/{id}/domains - DELETE
/v1/applications/{id}/domains/{domain_id} - POST
/v1/applications/{id}/domains/{domain_id}/verify - GET
/v1/applications/{id}/go-live - POST
/v1/applications/{id}/go-live - GET
/v1/applications/{id}/providers/messaging - PUT
/v1/applications/{id}/providers/messaging - POST
/v1/applications/{id}/providers/messaging/verify - GET
/v1/applications/{id}/providers/oauth - PUT
/v1/applications/{id}/providers/oauth - GET
/v1/applications/{id}/sandbox - PUT
/v1/applications/{id}/sandbox - GET
/v1/applications/{id}/settings - PATCH
/v1/applications/{id}/settings - GET
/v1/applications/{id}/signing-keys - POST
/v1/applications/{id}/signing-keys/rotate - GET
/v1/applications/{id}/stats - GET
/v1/applications/{id}/stats/trend - GET
/v1/applications/{id}/templates - PUT
/v1/applications/{id}/templates - DELETE
/v1/applications/{id}/templates/{template_id} - GET
/v1/applications/{id}/templates/catalog - GET
/v1/applications/{id}/templates/defaults/{template} - POST
/v1/applications/{id}/templates/preview
Dashboard
26- GET
/v1/applications - POST
/v1/applications - GET
/v1/applications/{application_id} - GET
/v1/dashboard/audit - POST
/v1/dashboard/change-password - GET
/v1/dashboard/me - GET
/v1/dashboard/mfa - POST
/v1/dashboard/mfa/totp/enroll - POST
/v1/dashboard/mfa/totp/verify - POST
/v1/dashboard/password-reset/start - POST
/v1/dashboard/password-reset/verify - POST
/v1/dashboard/sign-in - POST
/v1/dashboard/sign-out - POST
/v1/dashboard/sign-up - GET
/v1/dashboard/sso/connection - PUT
/v1/dashboard/sso/connection - DELETE
/v1/dashboard/sso/connection - GET
/v1/dashboard/sso/domains - POST
/v1/dashboard/sso/domains - DELETE
/v1/dashboard/sso/domains/{id} - POST
/v1/dashboard/sso/domains/{id}/verify - POST
/v1/dashboard/sso/resolve - GET
/v1/dashboard/team - POST
/v1/dashboard/team - PATCH
/v1/dashboard/team/{member_id} - DELETE
/v1/dashboard/team/{member_id}
Governance
24- POST
/v1/access-review-items/{id}/decide - GET
/v1/access-reviews - POST
/v1/access-reviews - POST
/v1/access-reviews/{id}/close - GET
/v1/access-reviews/{id}/items - GET
/v1/named-locations - POST
/v1/named-locations - PATCH
/v1/named-locations/{id} - DELETE
/v1/named-locations/{id} - GET
/v1/risk/users - GET
/v1/role-grants - POST
/v1/role-grants - DELETE
/v1/role-grants/{id} - GET
/v1/service-accounts - POST
/v1/service-accounts - PATCH
/v1/service-accounts/{id} - DELETE
/v1/service-accounts/{id} - POST
/v1/service-accounts/{id}/keys - GET
/v1/sod-policies - POST
/v1/sod-policies - PATCH
/v1/sod-policies/{id} - DELETE
/v1/sod-policies/{id} - POST
/v1/users/{id}/impersonate - GET
/v1/users/{id}/risk
Support
1Programmatic Access
4Oauth Provider
8Consent
2Imports
3Os Access
25- GET
/v1/os/access-rules - POST
/v1/os/access-rules - DELETE
/v1/os/access-rules/{id} - GET
/v1/os/challenges - POST
/v1/os/challenges/{id}/respond - GET
/v1/os/challenges/history - GET
/v1/os/devices - POST
/v1/os/devices - DELETE
/v1/os/devices/{id} - POST
/v1/os/devices/enrollment-ticket - POST
/v1/os/devices/ticket/enroll - POST
/v1/os/devices/ticket/resolve - GET
/v1/os/elevation-requests - GET
/v1/os/enrollment-tokens - POST
/v1/os/enrollment-tokens - DELETE
/v1/os/enrollment-tokens/{id} - GET
/v1/os/host-groups - POST
/v1/os/host-groups - GET
/v1/os/hosts - DELETE
/v1/os/hosts/{id} - POST
/v1/os/login/approve - POST
/v1/os/login/challenge - POST
/v1/os/login/deny - GET
/v1/os/sessions - DELETE
/v1/os/sessions/{id}