Your server’s API for organizations, connections, directories, domains, setup links and events.
API version 1.0.0. 344 operations.
Attribute catalogue
Section titled “Attribute catalogue”- GETRetrieve the attribute catalogue
/v1/attribute_catalogue - PUTReplace the attribute catalogue
/v1/attribute_catalogue - POSTPreview the catalog mapping of an IdP payload
/v1/ attribute_catalogue/ preview
Audit log events
Section titled “Audit log events”- GETList audit events
/v1/audit_log_events - POSTRecord an audit event for one of your customers' organizations
/v1/audit_log_events - GETExport audit events as CSV or JSON
/v1/ audit_log_events/ export - GETRetrieve an audit event
/v1/ audit_log_events/ {audit_log_event}
Audit log schemas
Section titled “Audit log schemas”- GETList the latest schema of each action
/v1/audit_log_schemas - POSTRegister a new version of an action's audit event schema
/v1/audit_log_schemas - GETRetrieve an action's schema
/v1/ audit_log_schemas/ {action}
Audit logs
Section titled “Audit logs”- GETList audit logs
/v1/audit_logs - POSTExport audit logs
/v1/audit_logs/exports - GETRetrieve an audit log export
/v1/ audit_logs/ exports/ {export}
Authorization
Section titled “Authorization”- POSTCheck one permission
/v1/authorization/check - POSTCheck up to 100 permissions
/v1/ authorization/ check/ bulk - GETList the environment's permissions
/v1/ authorization/ permissions - POSTCreate a permission
/v1/ authorization/ permissions - GETGet a permission
/v1/ authorization/ permissions/ {permission} - PATCHChange a permission's name or description
/v1/ authorization/ permissions/ {permission} - DELETEDelete a permission and remove it from every role
/v1/ authorization/ permissions/ {permission} - GETList roles, highest priority first
/v1/authorization/roles - POSTCreate an environment or organization role
/v1/authorization/roles - GETGet a role with its permissions
/v1/ authorization/ roles/ {role} - PATCHChange a role's name, description, priority or permissions
/v1/ authorization/ roles/ {role} - DELETEDelete a role and its assignments
/v1/ authorization/ roles/ {role}
Branding
Section titled “Branding”- GETRetrieve branding
/v1/branding - PATCHUpdate branding
/v1/branding - POSTUpload a favicon
/v1/branding/favicon - POSTUpload a custom font
/v1/branding/font - POSTUpload a logo
/v1/branding/logo
Connection health
Section titled “Connection health”Connections
Section titled “Connections”- GETList connections
/v1/connections - POSTCreate a connection
/v1/connections - GETRetrieve a connection
/v1/ connections/ {conn} - PATCHUpdate a connection
/v1/ connections/ {conn} - DELETEDelete a connection
/v1/ connections/ {conn} - POSTActivate
/v1/ connections/ {conn}/ activate - GETRead connection custom attribute mappings
/v1/ connections/ {conn}/ attribute_map - PUTReplace connection custom attribute mappings
/v1/ connections/ {conn}/ attribute_map - GETRead the latest verified test attribute source
/v1/ connections/ {conn}/ attribute_preview - GETList IdP certificates
/v1/ connections/ {conn}/ certificates - POSTAdd an IdP certificate for rollover
/v1/ connections/ {conn}/ certificates - DELETERemove an IdP certificate
/v1/ connections/ {conn}/ certificates/ {fp} - GETList the client assertion keys of an OIDC connection
/v1/ connections/ {conn}/ client_keys - POSTCreate or stage a client assertion key
/v1/ connections/ {conn}/ client_keys - POSTActivate the staged client assertion key
/v1/ connections/ {conn}/ client_keys/ activate - POSTRemove retiring client assertion keys
/v1/ connections/ {conn}/ client_keys/ retire - POSTDeactivate
/v1/ connections/ {conn}/ deactivate - GETGet debug capture
/v1/ connections/ {conn}/ debug_capture - POSTStart debug capture
/v1/ connections/ {conn}/ debug_capture - DELETEEnd debug capture
/v1/ connections/ {conn}/ debug_capture - GETInformational connection health
/v1/ connections/ {conn}/ health - PUTSet an explicit authoritative SCIM subject binding
/v1/ connections/ {conn}/ scim_binding - DELETERemove an explicit SCIM subject binding
/v1/ connections/ {conn}/ scim_binding - GETList sign-ins
/v1/ connections/ {conn}/ sessions - GETList the organizations a connection is shared with
/v1/ connections/ {conn}/ shares - POSTShare a connection with another organization
/v1/ connections/ {conn}/ shares - DELETERevoke a connection share
/v1/ connections/ {conn}/ shares/ {share} - GETSingle logout settings of a SAML connection
/v1/ connections/ {conn}/ single_logout - PUTTurn SAML single logout on or off
/v1/ connections/ {conn}/ single_logout - GETRead per-connection signing-key rotation progress
/v1/ connections/ {conn}/ sp_key_rotations - POSTStage a per-connection signing-key rotation
/v1/ connections/ {conn}/ sp_key_rotations - POSTActivate an eligible confirmed signing key
/v1/ connections/ {conn}/ sp_key_rotations/ activate - POSTConfirm the latest eligible next-key test
/v1/ connections/ {conn}/ sp_key_rotations/ confirm - POSTExplicitly retire an unused preceding signing key
/v1/ connections/ {conn}/ sp_key_rotations/ retire - POSTRestore the preceding signing key before retirement
/v1/ connections/ {conn}/ sp_key_rotations/ rollback - POSTStart a test bound to the exact next signing key
/v1/ connections/ {conn}/ sp_key_rotations/ test - GETSP metadata XML
/v1/ connections/ {conn}/ sp_metadata - POSTStart a test sign-in
/v1/ connections/ {conn}/ test - GETLatest test sign-in result with Connection Doctor output
/v1/ connections/ {conn}/ test_result
Custom domains
Section titled “Custom domains”- GETList custom domains
/v1/custom_domains - POSTAdd a custom domain
/v1/custom_domains - GETRetrieve a custom domain and its status
/v1/ custom_domains/ {custom_domain} - DELETERemove a custom domain
/v1/ custom_domains/ {custom_domain} - POSTVerify a custom domain now
/v1/ custom_domains/ {custom_domain}/ verify
Debug bundle share
Section titled “Debug bundle share”Debug bundles
Section titled “Debug bundles”- GETList the environment's ready debug bundles
/v1/debug_bundles - POSTCreate debug bundle
/v1/debug_bundles - GETGet debug bundle
/v1/ debug_bundles/ {bundle} - GETRead debug bundle
/v1/ debug_bundles/ {bundle}/ content - POSTShare debug bundle
/v1/ debug_bundles/ {bundle}/ share_links - DELETERevoke every live share link of a debug bundle
/v1/ debug_bundles/ {bundle}/ share_links
Developer tools
Section titled “Developer tools”- POSTPrepare a sandbox for `ohauthcat init`
/v1/dev/init - GETWebhook relay for `ohauthcat listen` (sandbox only)
/v1/dev/relay - POSTSend a sample event to the relay (sandbox only)
/v1/dev/trigger
Directories
Section titled “Directories”- GETList directories
/v1/directories - POSTCreate a directory
/v1/directories - GETRetrieve a directory
/v1/ directories/ {dir} - PATCHUpdate a directory
/v1/ directories/ {dir} - DELETEDelete a directory
/v1/ directories/ {dir} - GETRead directory custom attribute mappings
/v1/ directories/ {dir}/ attribute_map - PUTReplace directory custom attribute mappings
/v1/ directories/ {dir}/ attribute_map - POSTSync a CSV directory from an uploaded CSV file
/v1/ directories/ {dir}/ csv_imports - GETList directory groups
/v1/ directories/ {dir}/ groups - POSTRotate the SCIM token
/v1/ directories/ {dir}/ rotate_token - POSTReplay an IdP's SCIM sequence against a directory (sandbox only)
/v1/ directories/ {dir}/ scim_replays - GETRedacted SCIM request log
/v1/ directories/ {dir}/ scim_requests - GETRetrieve a pulled directory source
/v1/ directories/ {dir}/ source - PUTSave the credentials of a pulled directory source
/v1/ directories/ {dir}/ source - PATCHChange the poll interval of a pulled directory source
/v1/ directories/ {dir}/ source - GETRetrieve the OAuth connection of a directory source
/v1/ directories/ {dir}/ source/ oauth - POSTChoose the company a directory source syncs
/v1/ directories/ {dir}/ source/ oauth/ company - POSTStart connecting a directory source through OAuth
/v1/ directories/ {dir}/ source/ oauth/ start - POSTPreview a pulled directory source sync
/v1/ directories/ {dir}/ source/ preview - GETRetrieve the generated SFTP key of a directory source
/v1/ directories/ {dir}/ source/ ssh_key - POSTGenerate an SFTP key pair for a directory source
/v1/ directories/ {dir}/ source/ ssh_key - POSTPoll a pulled directory source now
/v1/ directories/ {dir}/ source/ sync - GETList directory users
/v1/ directories/ {dir}/ users
Directory groups
Section titled “Directory groups”- GETRetrieve a directory group
/v1/ directory_groups/ {group} - GETMembers of a directory group
/v1/ directory_groups/ {group}/ members
Directory sources
Section titled “Directory sources”- GETBambooHR OAuth callback of a directory source
/v1/ directory_sources/ oauth/ bamboohr/ callback - GETConfirm step of a directory source connect link
/v1/ directory_sources/ oauth/ confirm - POSTContinue a directory source connect link to the provider
/v1/ directory_sources/ oauth/ confirm - GETGoogle OAuth callback of a directory source
/v1/ directory_sources/ oauth/ google/ callback - GETGusto OAuth callback of a directory source
/v1/ directory_sources/ oauth/ gusto/ callback
Directory users
Section titled “Directory users”- GETRetrieve a directory user
/v1/ directory_users/ {user} - GETGroups of a directory user
/v1/ directory_users/ {user}/ groups
Email events
Section titled “Email events”- GETList the environment's email events
/v1/email_events - POSTSend a test notice email
/v1/email_events/test
Encryption keys
Section titled “Encryption keys”- GETList customer-managed key versions and their re-seal state
/v1/encryption_keys - POSTRegister a customer-managed AWS KMS key as the scope's new active version
/v1/encryption_keys - GETThe key policy statement and service principal to grant
/v1/ encryption_keys/ setup - GETGet one key version
/v1/ encryption_keys/ {key} - POSTMake an enabled version active again
/v1/ encryption_keys/ {key}/ activate - POSTDeprecate a non-active version
/v1/ encryption_keys/ {key}/ deprecate - POSTTest a key version again
/v1/ encryption_keys/ {key}/ validate
Environment
Section titled “Environment”- GETRetrieve the environment
/v1/environment - PATCHUpdate the environment
/v1/environment - GETGet the active sign-in host and passkey relying party
/v1/ environment/ signin_host - PUTChange the active sign-in host
/v1/ environment/ signin_host
Events
Section titled “Events”Exports
Section titled “Exports”Feature flags
Section titled “Feature flags”- GETList feature flags
/v1/feature_flags - POSTCreate a feature flag
/v1/feature_flags - POSTEvaluate one feature flag for a context
/v1/ feature_flags/ evaluate - POSTEvaluate many feature flags for a context
/v1/ feature_flags/ evaluate_bulk - GETRetrieve a feature flag
/v1/ feature_flags/ {feature_flag} - PATCHUpdate a feature flag
/v1/ feature_flags/ {feature_flag} - DELETEDelete a feature flag
/v1/ feature_flags/ {feature_flag}
IdP Radar
Section titled “IdP Radar”- GETGet the IdP Radar alert subscription
/v1/ idp_radar/ alert_subscription - PUTSubscribe to IdP Radar alerts
/v1/ idp_radar/ alert_subscription - DELETEUnsubscribe from IdP Radar alerts
/v1/ idp_radar/ alert_subscription
Imports
Section titled “Imports”- GETList imports
/v1/imports - POSTPlan an import
/v1/imports - GETRetrieve an import plan
/v1/ imports/ {imp} - POSTCancel an import
/v1/ imports/ {imp}/ cancel - POSTRoll an organization's routing back
/v1/ imports/ {imp}/ organizations/ {org}/ rollback - POSTSwitch an organization's routing
/v1/ imports/ {imp}/ organizations/ {org}/ switch - POSTRun an import
/v1/ imports/ {imp}/ run
Invites
Section titled “Invites”- GETList end-user invites
/v1/invites - POSTInvite an end user by email
/v1/invites - POSTRevoke a pending end-user invite
/v1/ invites/ {invite}/ revoke
IT email configuration
Section titled “IT email configuration”- GETGet customer IT email configuration
/v1/ it_email_configuration - PUTPut customer IT email configuration
/v1/ it_email_configuration - DELETEDelete customer IT email configuration
/v1/ it_email_configuration
Log streams
Section titled “Log streams”- GETList prospective audit and sign-in log destinations
/v1/log_streams - POSTCreate a prospective log destination within the plan allowance
/v1/log_streams - DELETEDelete a log destination and cancel its queued deliveries
/v1/ log_streams/ {stream}
M2M clients
Section titled “M2M clients”- GETList machine-to-machine clients
/v1/m2m_clients - POSTCreate a machine-to-machine client
/v1/m2m_clients - GETGet a machine-to-machine client
/v1/ m2m_clients/ {client} - PATCHChange a client's name, scopes, audiences, lifetime or JWKS
/v1/ m2m_clients/ {client} - DELETERevoke a client; its token requests fail at once
/v1/ m2m_clients/ {client} - POSTRotate a client's secret
/v1/ m2m_clients/ {client}/ rotate_secret
- GETList connected apps (OAuth clients)
/v1/oauth/clients - POSTRegister a connected app
/v1/oauth/clients - GETGet a connected app
/v1/ oauth/ clients/ {client} - PUTReplace a connected app's settings
/v1/ oauth/ clients/ {client} - DELETEDelete a connected app and its grants
/v1/ oauth/ clients/ {client} - POSTRotate a confidential client's secret
/v1/ oauth/ clients/ {client}/ secret - GETList live grants
/v1/oauth/grants - DELETERevoke a grant
/v1/ oauth/ grants/ {grant} - GETList resource servers
/v1/oauth/resources - POSTRegister a resource server
/v1/oauth/resources - GETGet a resource server
/v1/ oauth/ resources/ {resource} - PUTUpdate a resource server
/v1/ oauth/ resources/ {resource} - DELETEDelete a resource server
/v1/ oauth/ resources/ {resource} - GETThe RFC 9728 document the resource server publishes
/v1/ oauth/ resources/ {resource}/ protected_resource_metadata - GETList the environment's OAuth scopes
/v1/oauth/scopes - PUTDefine or redescribe an OAuth scope
/v1/ oauth/ scopes/ {scope} - DELETEDelete an OAuth scope
/v1/ oauth/ scopes/ {scope}
Organization exports
Section titled “Organization exports”- POSTExport the organization list as CSV
/v1/ organization_exports - GETRetrieve an organization export
/v1/ organization_exports/ {export}
Organizations
Section titled “Organizations”- GETList organizations
/v1/organizations - POSTCreate an organization
/v1/organizations - GETRetrieve an organization
/v1/ organizations/ {org} - PATCHUpdate an organization
/v1/ organizations/ {org} - DELETEDelete an organization
/v1/ organizations/ {org} - GETGet the portal intents an organization allows
/v1/ organizations/ {org}/ allowed_intents - PUTReplace the portal intents an organization allows
/v1/ organizations/ {org}/ allowed_intents - GETList an organization's API keys
/v1/ organizations/ {org}/ api_keys - POSTCreate an organization-scoped secret key (shown once)
/v1/ organizations/ {org}/ api_keys - GETGet an organization-scoped API key
/v1/ organizations/ {org}/ api_keys/ {key} - POSTRevoke an organization-scoped key
/v1/ organizations/ {org}/ api_keys/ {key}/ revoke - POSTRoll an organization-scoped key with overlap
/v1/ organizations/ {org}/ api_keys/ {key}/ roll - GETList the extra secrets of an organization-scoped key
/v1/ organizations/ {org}/ api_keys/ {key}/ secrets - POSTAdd a secret to an organization-scoped key (shown once)
/v1/ organizations/ {org}/ api_keys/ {key}/ secrets - POSTRevoke one secret of an organization-scoped key
/v1/ organizations/ {org}/ api_keys/ {key}/ secrets/ {secret}/ revoke - GETList domains
/v1/ organizations/ {org}/ domains - POSTAdd a domain
/v1/ organizations/ {org}/ domains - PATCHUpdate a domain
/v1/ organizations/ {org}/ domains/ {domain} - DELETEDelete a domain
/v1/ organizations/ {org}/ domains/ {domain} - POSTRe-check the DNS record now
/v1/ organizations/ {org}/ domains/ {domain}/ verify - GETList an organization's events
/v1/ organizations/ {org}/ events - GETList IT contacts
/v1/ organizations/ {org}/ it_contacts - POSTAdd an IT contact
/v1/ organizations/ {org}/ it_contacts - GETRetrieve an IT contact
/v1/ organizations/ {org}/ it_contacts/ {contact} - PATCHUpdate an IT contact
/v1/ organizations/ {org}/ it_contacts/ {contact} - DELETERemove an IT contact
/v1/ organizations/ {org}/ it_contacts/ {contact} - GETList an organization's memberships
/v1/ organizations/ {org}/ memberships - POSTAdd an end user to an organization
/v1/ organizations/ {org}/ memberships - PATCHChange a membership's role or state
/v1/ organizations/ {org}/ memberships/ {membership} - DELETERemove an end user from an organization
/v1/ organizations/ {org}/ memberships/ {membership} - GETList a membership's roles and permissions
/v1/ organizations/ {org}/ memberships/ {membership}/ permissions - GETList a membership's role assignments
/v1/ organizations/ {org}/ memberships/ {membership}/ role_assignments - POSTGive a membership a role, optionally on one resource
/v1/ organizations/ {org}/ memberships/ {membership}/ role_assignments - DELETERemove a role assignment
/v1/ organizations/ {org}/ memberships/ {membership}/ role_assignments/ {assignment} - POSTRevoke the grants held by an organization's members
/v1/ organizations/ {org}/ oauth_grants/ revoke - GETGet an organization's third-party app rule
/v1/ organizations/ {org}/ oauth_settings - PUTSet an organization's third-party app rule
/v1/ organizations/ {org}/ oauth_settings - GETRetrieve an organization's slug, logo and branding overrides
/v1/ organizations/ {org}/ profile - PATCHUpdate an organization's slug, logo and branding overrides
/v1/ organizations/ {org}/ profile - GETSetup checklist per intent
/v1/ organizations/ {org}/ status - GETGet an organization's end-user auth overrides
/v1/ organizations/ {org}/ user_management_settings - PUTSet an organization's end-user auth overrides
/v1/ organizations/ {org}/ user_management_settings - DELETERemove an organization's end-user auth overrides
/v1/ organizations/ {org}/ user_management_settings
Passport
Section titled “Passport”- GETList the Passports linked to your organizations
/v1/passport/links - DELETEUnlink a Passport from one of your organizations
/v1/ passport/ links/ {link}
- GETList Pipes connections
/v1/pipes/connections - POSTStart connecting an end user to a provider
/v1/pipes/connections - GETRetrieve a Pipes connection
/v1/ pipes/ connections/ {connection} - DELETEDisconnect and revoke a Pipes connection
/v1/ pipes/ connections/ {connection} - GETGet a fresh access token for a Pipes connection
/v1/ pipes/ connections/ {connection}/ access_token - GETList configured Pipes providers
/v1/pipes/providers - PUTConfigure a Pipes provider
/v1/ pipes/ providers/ {provider} - DELETERemove a Pipes provider
/v1/ pipes/ providers/ {provider}
Policies
Section titled “Policies”- GETList policies
/v1/policies - POSTCreate policy
/v1/policies - GETGet policy
/v1/ policies/ {policy} - PATCHUpdate policy
/v1/ policies/ {policy} - DELETEDelete policy
/v1/ policies/ {policy}
Portal
Section titled “Portal”- GETList portal invites
/v1/portal/invites - POSTInvite an IT admin to the portal
/v1/portal/invites - POSTResend a portal invite
/v1/ portal/ invites/ {invite}/ resend - POSTRevoke a portal invite
/v1/ portal/ invites/ {invite}/ revoke - GETList portal links
/v1/portal/links - POSTCreate a portal setup link
/v1/portal/links - POSTRevoke a portal link
/v1/ portal/ links/ {link}/ revoke
Portal profiles
Section titled “Portal profiles”- GETList environment portal profiles
/v1/portal_profiles - POSTCreate a Business portal profile
/v1/portal_profiles - GETRetrieve an environment portal profile
/v1/ portal_profiles/ {profile} - PUTReplace an unfinished-setup portal profile
/v1/ portal_profiles/ {profile} - DELETEDelete a portal profile without unexpired link references
/v1/ portal_profiles/ {profile}
Providers
Section titled “Providers”Redirect uris
Section titled “Redirect uris”- GETList redirect URIs
/v1/redirect_uris - POSTAdd a redirect URI
/v1/redirect_uris - DELETERemove a redirect URI
/v1/ redirect_uris/ {uri}
Requests
Section titled “Requests”Role rules
Section titled “Role rules”- GETList role rules
/v1/role_rules - POSTCreate role rule
/v1/role_rules - POSTPreview the role a sign-in would get
/v1/role_rules/preview - GETGet role rule
/v1/ role_rules/ {role_rule} - PATCHUpdate role rule
/v1/ role_rules/ {role_rule} - DELETEDelete role rule
/v1/ role_rules/ {role_rule}
Sandboxes
Section titled “Sandboxes”- POSTCreate a claimable test sandbox
/v1/sandboxes - POSTStart a sandbox handoff for the CLI
/v1/sandboxes/handoffs - POSTRedeem a sandbox handoff
/v1/ sandboxes/ handoffs/ token
Sign in hooks
Section titled “Sign in hooks”- GETList sign-in hooks
/v1/sign_in_hooks - POSTCreate a sign-in hook
/v1/sign_in_hooks - GETRetrieve a sign-in hook
/v1/ sign_in_hooks/ {hook} - PATCHUpdate a sign-in hook
/v1/ sign_in_hooks/ {hook} - DELETEDelete a sign-in hook
/v1/ sign_in_hooks/ {hook} - GETThe delivery log of a sign-in hook
/v1/ sign_in_hooks/ {hook}/ deliveries - POSTRotate a sign-in hook secret
/v1/ sign_in_hooks/ {hook}/ rotate_secret - POSTSend a test event to a sign-in hook
/v1/ sign_in_hooks/ {hook}/ test
Sign in risk policy
Section titled “Sign in risk policy”- GETRetrieve the sign-in risk policy
/v1/sign_in_risk_policy - PUTSet the sign-in risk policy
/v1/sign_in_risk_policy - DELETERemove the sign-in risk policy
/v1/sign_in_risk_policy
Sign ins
Section titled “Sign ins”- GETList the environment's sign-ins
/v1/sign_ins - GETExplain a failed sign-in
/v1/ sign_ins/ {sign_in}/ explanation - GETSign-in timeline
/v1/ sign_ins/ {sign_in}/ timeline
SSF streams
Section titled “SSF streams”- GETList SSF transmitter streams
/v1/ssf_streams - POSTCreate an SSF transmitter stream
/v1/ssf_streams - GETGet an SSF transmitter stream
/v1/ ssf_streams/ {stream} - PATCHUpdate an SSF transmitter stream
/v1/ ssf_streams/ {stream} - DELETEDelete an SSF transmitter stream
/v1/ ssf_streams/ {stream} - POSTSend a verification event on a stream
/v1/ ssf_streams/ {stream}/ verify
Subprocessor notices
Section titled “Subprocessor notices”- POSTSubscribe to sub-processor change notices
/v1/ subprocessor-notices - POSTUnsubscribe from sub-processor change notices
/v1/ subprocessor-notices/ removals - POSTUnsubscribe from sub-processor change notices (one-click)
/v1/ subprocessor-notices/ removals/ one-click
Trusted issuers
Section titled “Trusted issuers”- GETList trusted token issuers
/v1/trusted_issuers - POSTTrust a third-party token issuer
/v1/trusted_issuers - DELETEStop trusting a token issuer
/v1/ trusted_issuers/ {issuer_id}
Uploads
Section titled “Uploads”User management
Section titled “User management”- GETList challenged and blocked end-user sign-ins and sign-ups
/v1/ user_management/ bot_detections - GETGet the environment's bot and abuse protection settings
/v1/ user_management/ bot_protection - PUTReplace the environment's bot and abuse protection settings
/v1/ user_management/ bot_protection - POSTFinish a passkey sign-in (headless)
/v1/ user_management/ passkeys/ authenticate - POSTStart a passkey sign-in
/v1/ user_management/ passkeys/ authentication_options - GETGet the environment's end-user auth settings
/v1/ user_management/ settings - PUTReplace the environment's end-user auth settings
/v1/ user_management/ settings - GETList the environment's social sign-in providers
/v1/ user_management/ social_providers - PUTSet a social provider's OAuth client
/v1/ user_management/ social_providers/ {provider} - DELETERemove a social provider
/v1/ user_management/ social_providers/ {provider} - GETGet the environment's monthly active end users
/v1/ user_management/ usage
- GETList or search end users
/v1/users - POSTCreate an end user
/v1/users - GETGet an end user
/v1/ users/ {user} - PATCHUpdate an end user
/v1/ users/ {user} - DELETEDelete an end user and their memberships
/v1/ users/ {user} - GETList an end user's passkeys and authenticator apps
/v1/ users/ {user}/ factors - DELETERemove an end user's passkey or authenticator app
/v1/ users/ {user}/ factors/ {factor} - GETList an end user's linked social accounts
/v1/ users/ {user}/ identities - POSTFinish registering a passkey for an end user (headless)
/v1/ users/ {user}/ passkeys - POSTStart registering a passkey for an end user (headless)
/v1/ users/ {user}/ passkeys/ registration_options - PATCHRename an end user's passkey
/v1/ users/ {user}/ passkeys/ {passkey} - PUTSet an end user's password
/v1/ users/ {user}/ password - DELETERemove an end user's password and its history
/v1/ users/ {user}/ password - GETList an end user's live sessions
/v1/ users/ {user}/ sessions - DELETESign an end user out everywhere
/v1/ users/ {user}/ sessions - DELETERevoke one end-user session
/v1/ users/ {user}/ sessions/ {session}
- POSTDecrypt a Vault ciphertext of an organization
/v1/vault/decrypt - POSTEncrypt data under an organization's named key
/v1/vault/encrypt - GETList an organization's Vault keys
/v1/vault/keys - POSTCreate a named Vault key for an organization
/v1/vault/keys - POSTRotate a Vault key
/v1/ vault/ keys/ {key}/ rotate - GETRead and decrypt one version of an object
/v1/ vault/ objects/ {name} - PUTStore a new version of an encrypted key-value object
/v1/ vault/ objects/ {name} - DELETEDelete every version of an object
/v1/ vault/ objects/ {name} - GETList an object's versions (metadata only), newest first
/v1/ vault/ objects/ {name}/ versions
Waitlist
Section titled “Waitlist”- POSTJoin the waitlist
/v1/waitlist - POSTLeave the waitlist
/v1/waitlist/removals - POSTLeave the waitlist (one-click)
/v1/ waitlist/ removals/ one-click
Webhook deliveries
Section titled “Webhook deliveries”Webhook endpoints
Section titled “Webhook endpoints”- GETList webhook endpoints
/v1/webhook_endpoints - POSTCreate a webhook endpoint
/v1/webhook_endpoints - GETRetrieve a webhook endpoint
/v1/ webhook_endpoints/ {endpoint} - PATCHUpdate a webhook endpoint
/v1/ webhook_endpoints/ {endpoint} - DELETEDelete a webhook endpoint
/v1/ webhook_endpoints/ {endpoint} - GETList deliveries
/v1/ webhook_endpoints/ {endpoint}/ deliveries - POSTRotate the signing secret
/v1/ webhook_endpoints/ {endpoint}/ rotate_secret - POSTSend a sample event
/v1/ webhook_endpoints/ {endpoint}/ test