# API reference

<!-- Generated by scripts/generate.ts. Do not edit. -->

<!-- Source: core commit `f70874a3916ad5b24a8619246cbae6cc8bc24d27`. -->

API version **1.0.0**. The server-to-server v1 API: the management API, the SSO token exchange, the WorkOS-compatible reads and the hosted MCP server. Every operation has its own page with request examples in curl, Node and Python. Browser- and IdP-facing endpoints (authorize, ACS, OIDC callback, SP metadata, JWKS) and SCIM are unversioned; see [SSO](/sso/) and [Directory sync](/directory-sync/).

## Resources

<div class="api-index">
<section class="api-index__card">
<h3><a href="/reference/api/attribute-catalogue/">Attribute catalogue</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/attribute-catalogue/get-attribute-catalogue/"><span class="method method-get">GET</span><span>Retrieve the attribute catalogue</span></a></li>
<li><a href="/reference/api/attribute-catalogue/replace-attribute-catalogue/"><span class="method method-put">PUT</span><span>Replace the attribute catalogue</span></a></li>
<li><a href="/reference/api/attribute-catalogue/preview-attributes/"><span class="method method-post">POST</span><span>Preview the catalog mapping of an IdP payload</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/audit-log-events/">Audit log events</a> <span class="api-index__count">4</span></h3>
<ul>
<li><a href="/reference/api/audit-log-events/list-audit-log-events/"><span class="method method-get">GET</span><span>List audit events</span></a></li>
<li><a href="/reference/api/audit-log-events/create-audit-log-event/"><span class="method method-post">POST</span><span>Record an audit event for one of your customers' organizations</span></a></li>
<li><a href="/reference/api/audit-log-events/export-audit-log-events/"><span class="method method-get">GET</span><span>Export audit events as CSV or JSON</span></a></li>
<li><a href="/reference/api/audit-log-events/get-audit-log-event/"><span class="method method-get">GET</span><span>Retrieve an audit event</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/audit-log-schemas/">Audit log schemas</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/audit-log-schemas/list-audit-log-schemas/"><span class="method method-get">GET</span><span>List the latest schema of each action</span></a></li>
<li><a href="/reference/api/audit-log-schemas/create-audit-log-schema/"><span class="method method-post">POST</span><span>Register a new version of an action's audit event schema</span></a></li>
<li><a href="/reference/api/audit-log-schemas/get-audit-log-schema/"><span class="method method-get">GET</span><span>Retrieve an action's schema</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/audit-logs/">Audit logs</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/audit-logs/list-audit-logs/"><span class="method method-get">GET</span><span>List audit logs</span></a></li>
<li><a href="/reference/api/audit-logs/create-audit-log-export/"><span class="method method-post">POST</span><span>Export audit logs</span></a></li>
<li><a href="/reference/api/audit-logs/get-audit-log-export/"><span class="method method-get">GET</span><span>Retrieve an audit log export</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/authorization/">Authorization</a> <span class="api-index__count">12</span></h3>
<ul>
<li><a href="/reference/api/authorization/check-authorization/"><span class="method method-post">POST</span><span>Check one permission</span></a></li>
<li><a href="/reference/api/authorization/check-authorization-bulk/"><span class="method method-post">POST</span><span>Check up to 100 permissions</span></a></li>
<li><a href="/reference/api/authorization/list-permissions/"><span class="method method-get">GET</span><span>List the environment's permissions</span></a></li>
<li><a href="/reference/api/authorization/create-permission/"><span class="method method-post">POST</span><span>Create a permission</span></a></li>
<li><a href="/reference/api/authorization/get-permission/"><span class="method method-get">GET</span><span>Get a permission</span></a></li>
<li><a href="/reference/api/authorization/update-permission/"><span class="method method-patch">PATCH</span><span>Change a permission's name or description</span></a></li>
<li class="api-index__more"><a href="/reference/api/authorization/">All 12 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/branding/">Branding</a> <span class="api-index__count">5</span></h3>
<ul>
<li><a href="/reference/api/branding/get-branding/"><span class="method method-get">GET</span><span>Retrieve branding</span></a></li>
<li><a href="/reference/api/branding/update-branding/"><span class="method method-patch">PATCH</span><span>Update branding</span></a></li>
<li><a href="/reference/api/branding/upload-branding-favicon/"><span class="method method-post">POST</span><span>Upload a favicon</span></a></li>
<li><a href="/reference/api/branding/upload-branding-font/"><span class="method method-post">POST</span><span>Upload a custom font</span></a></li>
<li><a href="/reference/api/branding/upload-branding-logo/"><span class="method method-post">POST</span><span>Upload a logo</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/connection-health/">Connection health</a> <span class="api-index__count">1</span></h3>
<ul>
<li><a href="/reference/api/connection-health/list-connection-health/"><span class="method method-get">GET</span><span>Informational health of the environment's connections</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/connections/">Connections</a> <span class="api-index__count">39</span></h3>
<ul>
<li><a href="/reference/api/connections/list-connections/"><span class="method method-get">GET</span><span>List connections</span></a></li>
<li><a href="/reference/api/connections/create-connection/"><span class="method method-post">POST</span><span>Create a connection</span></a></li>
<li><a href="/reference/api/connections/get-connection/"><span class="method method-get">GET</span><span>Retrieve a connection</span></a></li>
<li><a href="/reference/api/connections/update-connection/"><span class="method method-patch">PATCH</span><span>Update a connection</span></a></li>
<li><a href="/reference/api/connections/delete-connection/"><span class="method method-delete">DELETE</span><span>Delete a connection</span></a></li>
<li><a href="/reference/api/connections/activate-connection/"><span class="method method-post">POST</span><span>Activate</span></a></li>
<li class="api-index__more"><a href="/reference/api/connections/">All 39 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/custom-domains/">Custom domains</a> <span class="api-index__count">5</span></h3>
<ul>
<li><a href="/reference/api/custom-domains/list-custom-domains/"><span class="method method-get">GET</span><span>List custom domains</span></a></li>
<li><a href="/reference/api/custom-domains/create-custom-domain/"><span class="method method-post">POST</span><span>Add a custom domain</span></a></li>
<li><a href="/reference/api/custom-domains/get-custom-domain/"><span class="method method-get">GET</span><span>Retrieve a custom domain and its status</span></a></li>
<li><a href="/reference/api/custom-domains/delete-custom-domain/"><span class="method method-delete">DELETE</span><span>Remove a custom domain</span></a></li>
<li><a href="/reference/api/custom-domains/verify-custom-domain/"><span class="method method-post">POST</span><span>Verify a custom domain now</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/debug-bundle-share/">Debug bundle share</a> <span class="api-index__count">1</span></h3>
<ul>
<li><a href="/reference/api/debug-bundle-share/open-debug-bundle-share/"><span class="method method-get">GET</span><span>Open debug bundle share</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/debug-bundles/">Debug bundles</a> <span class="api-index__count">6</span></h3>
<ul>
<li><a href="/reference/api/debug-bundles/list-debug-bundles/"><span class="method method-get">GET</span><span>List the environment's ready debug bundles</span></a></li>
<li><a href="/reference/api/debug-bundles/create-debug-bundle/"><span class="method method-post">POST</span><span>Create debug bundle</span></a></li>
<li><a href="/reference/api/debug-bundles/get-debug-bundle/"><span class="method method-get">GET</span><span>Get debug bundle</span></a></li>
<li><a href="/reference/api/debug-bundles/read-debug-bundle/"><span class="method method-get">GET</span><span>Read debug bundle</span></a></li>
<li><a href="/reference/api/debug-bundles/share-debug-bundle/"><span class="method method-post">POST</span><span>Share debug bundle</span></a></li>
<li><a href="/reference/api/debug-bundles/revoke-debug-bundle-share-links/"><span class="method method-delete">DELETE</span><span>Revoke every live share link of a debug bundle</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/dev/">Developer tools</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/dev/dev-init/"><span class="method method-post">POST</span><span>Prepare a sandbox for `ohauthcat init`</span></a></li>
<li><a href="/reference/api/dev/dev-relay/"><span class="method method-get">GET</span><span>Webhook relay for `ohauthcat listen` (sandbox only)</span></a></li>
<li><a href="/reference/api/dev/dev-trigger/"><span class="method method-post">POST</span><span>Send a sample event to the relay (sandbox only)</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/directories/">Directories</a> <span class="api-index__count">23</span></h3>
<ul>
<li><a href="/reference/api/directories/list-directories/"><span class="method method-get">GET</span><span>List directories</span></a></li>
<li><a href="/reference/api/directories/create-directory/"><span class="method method-post">POST</span><span>Create a directory</span></a></li>
<li><a href="/reference/api/directories/get-directory/"><span class="method method-get">GET</span><span>Retrieve a directory</span></a></li>
<li><a href="/reference/api/directories/update-directory/"><span class="method method-patch">PATCH</span><span>Update a directory</span></a></li>
<li><a href="/reference/api/directories/delete-directory/"><span class="method method-delete">DELETE</span><span>Delete a directory</span></a></li>
<li><a href="/reference/api/directories/get-directory-attribute-map/"><span class="method method-get">GET</span><span>Read directory custom attribute mappings</span></a></li>
<li class="api-index__more"><a href="/reference/api/directories/">All 23 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/directory-groups/">Directory groups</a> <span class="api-index__count">2</span></h3>
<ul>
<li><a href="/reference/api/directory-groups/get-directory-group/"><span class="method method-get">GET</span><span>Retrieve a directory group</span></a></li>
<li><a href="/reference/api/directory-groups/list-directory-group-members/"><span class="method method-get">GET</span><span>Members of a directory group</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/directory-sources/">Directory sources</a> <span class="api-index__count">5</span></h3>
<ul>
<li><a href="/reference/api/directory-sources/directory-source-bamboohr-oauth-callback/"><span class="method method-get">GET</span><span>BambooHR OAuth callback of a directory source</span></a></li>
<li><a href="/reference/api/directory-sources/get-directory-source-oauth-confirm/"><span class="method method-get">GET</span><span>Confirm step of a directory source connect link</span></a></li>
<li><a href="/reference/api/directory-sources/confirm-directory-source-oauth/"><span class="method method-post">POST</span><span>Continue a directory source connect link to the provider</span></a></li>
<li><a href="/reference/api/directory-sources/directory-source-google-oauth-callback/"><span class="method method-get">GET</span><span>Google OAuth callback of a directory source</span></a></li>
<li><a href="/reference/api/directory-sources/directory-source-gusto-oauth-callback/"><span class="method method-get">GET</span><span>Gusto OAuth callback of a directory source</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/directory-users/">Directory users</a> <span class="api-index__count">2</span></h3>
<ul>
<li><a href="/reference/api/directory-users/get-directory-user/"><span class="method method-get">GET</span><span>Retrieve a directory user</span></a></li>
<li><a href="/reference/api/directory-users/list-directory-user-groups/"><span class="method method-get">GET</span><span>Groups of a directory user</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/email-events/">Email events</a> <span class="api-index__count">2</span></h3>
<ul>
<li><a href="/reference/api/email-events/list-email-events/"><span class="method method-get">GET</span><span>List the environment's email events</span></a></li>
<li><a href="/reference/api/email-events/send-test-email/"><span class="method method-post">POST</span><span>Send a test notice email</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/encryption-keys/">Encryption keys</a> <span class="api-index__count">7</span></h3>
<ul>
<li><a href="/reference/api/encryption-keys/list-encryption-keys/"><span class="method method-get">GET</span><span>List customer-managed key versions and their re-seal state</span></a></li>
<li><a href="/reference/api/encryption-keys/create-encryption-key/"><span class="method method-post">POST</span><span>Register a customer-managed AWS KMS key as the scope's new active version</span></a></li>
<li><a href="/reference/api/encryption-keys/get-encryption-key-setup/"><span class="method method-get">GET</span><span>The key policy statement and service principal to grant</span></a></li>
<li><a href="/reference/api/encryption-keys/get-encryption-key/"><span class="method method-get">GET</span><span>Get one key version</span></a></li>
<li><a href="/reference/api/encryption-keys/activate-encryption-key/"><span class="method method-post">POST</span><span>Make an enabled version active again</span></a></li>
<li><a href="/reference/api/encryption-keys/deprecate-encryption-key/"><span class="method method-post">POST</span><span>Deprecate a non-active version</span></a></li>
<li class="api-index__more"><a href="/reference/api/encryption-keys/">All 7 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/environment/">Environment</a> <span class="api-index__count">4</span></h3>
<ul>
<li><a href="/reference/api/environment/get-environment/"><span class="method method-get">GET</span><span>Retrieve the environment</span></a></li>
<li><a href="/reference/api/environment/update-environment/"><span class="method method-patch">PATCH</span><span>Update the environment</span></a></li>
<li><a href="/reference/api/environment/get-environment-signin-host/"><span class="method method-get">GET</span><span>Get the active sign-in host and passkey relying party</span></a></li>
<li><a href="/reference/api/environment/set-environment-signin-host/"><span class="method method-put">PUT</span><span>Change the active sign-in host</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/events/">Events</a> <span class="api-index__count">2</span></h3>
<ul>
<li><a href="/reference/api/events/list-events/"><span class="method method-get">GET</span><span>List events</span></a></li>
<li><a href="/reference/api/events/get-event/"><span class="method method-get">GET</span><span>Retrieve an event</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/exports/">Exports</a> <span class="api-index__count">2</span></h3>
<ul>
<li><a href="/reference/api/exports/create-export/"><span class="method method-post">POST</span><span>Start a full export</span></a></li>
<li><a href="/reference/api/exports/get-export/"><span class="method method-get">GET</span><span>Retrieve an export (signed download)</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/feature-flags/">Feature flags</a> <span class="api-index__count">7</span></h3>
<ul>
<li><a href="/reference/api/feature-flags/list-feature-flags/"><span class="method method-get">GET</span><span>List feature flags</span></a></li>
<li><a href="/reference/api/feature-flags/create-feature-flag/"><span class="method method-post">POST</span><span>Create a feature flag</span></a></li>
<li><a href="/reference/api/feature-flags/evaluate-feature-flag/"><span class="method method-post">POST</span><span>Evaluate one feature flag for a context</span></a></li>
<li><a href="/reference/api/feature-flags/evaluate-feature-flags/"><span class="method method-post">POST</span><span>Evaluate many feature flags for a context</span></a></li>
<li><a href="/reference/api/feature-flags/get-feature-flag/"><span class="method method-get">GET</span><span>Retrieve a feature flag</span></a></li>
<li><a href="/reference/api/feature-flags/update-feature-flag/"><span class="method method-patch">PATCH</span><span>Update a feature flag</span></a></li>
<li class="api-index__more"><a href="/reference/api/feature-flags/">All 7 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/idp-radar/">IdP Radar</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/idp-radar/get-radar-alert-subscription/"><span class="method method-get">GET</span><span>Get the IdP Radar alert subscription</span></a></li>
<li><a href="/reference/api/idp-radar/put-radar-alert-subscription/"><span class="method method-put">PUT</span><span>Subscribe to IdP Radar alerts</span></a></li>
<li><a href="/reference/api/idp-radar/delete-radar-alert-subscription/"><span class="method method-delete">DELETE</span><span>Unsubscribe from IdP Radar alerts</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/imports/">Imports</a> <span class="api-index__count">7</span></h3>
<ul>
<li><a href="/reference/api/imports/list-imports/"><span class="method method-get">GET</span><span>List imports</span></a></li>
<li><a href="/reference/api/imports/create-import/"><span class="method method-post">POST</span><span>Plan an import</span></a></li>
<li><a href="/reference/api/imports/get-import/"><span class="method method-get">GET</span><span>Retrieve an import plan</span></a></li>
<li><a href="/reference/api/imports/cancel-import/"><span class="method method-post">POST</span><span>Cancel an import</span></a></li>
<li><a href="/reference/api/imports/rollback-import-organization/"><span class="method method-post">POST</span><span>Roll an organization's routing back</span></a></li>
<li><a href="/reference/api/imports/switch-import-organization/"><span class="method method-post">POST</span><span>Switch an organization's routing</span></a></li>
<li class="api-index__more"><a href="/reference/api/imports/">All 7 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/invites/">Invites</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/invites/list-end-user-invites/"><span class="method method-get">GET</span><span>List end-user invites</span></a></li>
<li><a href="/reference/api/invites/create-end-user-invite/"><span class="method method-post">POST</span><span>Invite an end user by email</span></a></li>
<li><a href="/reference/api/invites/revoke-end-user-invite/"><span class="method method-post">POST</span><span>Revoke a pending end-user invite</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/it-email-configuration/">IT email configuration</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/it-email-configuration/get-it-email-configuration/"><span class="method method-get">GET</span><span>Get customer IT email configuration</span></a></li>
<li><a href="/reference/api/it-email-configuration/put-it-email-configuration/"><span class="method method-put">PUT</span><span>Put customer IT email configuration</span></a></li>
<li><a href="/reference/api/it-email-configuration/delete-it-email-configuration/"><span class="method method-delete">DELETE</span><span>Delete customer IT email configuration</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/log-streams/">Log streams</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/log-streams/list-log-streams/"><span class="method method-get">GET</span><span>List prospective audit and sign-in log destinations</span></a></li>
<li><a href="/reference/api/log-streams/create-log-stream/"><span class="method method-post">POST</span><span>Create a prospective log destination within the plan allowance</span></a></li>
<li><a href="/reference/api/log-streams/delete-log-stream/"><span class="method method-delete">DELETE</span><span>Delete a log destination and cancel its queued deliveries</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/m2m-clients/">M2M clients</a> <span class="api-index__count">6</span></h3>
<ul>
<li><a href="/reference/api/m2m-clients/list-m2m-clients/"><span class="method method-get">GET</span><span>List machine-to-machine clients</span></a></li>
<li><a href="/reference/api/m2m-clients/create-m2m-client/"><span class="method method-post">POST</span><span>Create a machine-to-machine client</span></a></li>
<li><a href="/reference/api/m2m-clients/get-m2m-client/"><span class="method method-get">GET</span><span>Get a machine-to-machine client</span></a></li>
<li><a href="/reference/api/m2m-clients/update-m2m-client/"><span class="method method-patch">PATCH</span><span>Change a client's name, scopes, audiences, lifetime or JWKS</span></a></li>
<li><a href="/reference/api/m2m-clients/revoke-m2m-client/"><span class="method method-delete">DELETE</span><span>Revoke a client; its token requests fail at once</span></a></li>
<li><a href="/reference/api/m2m-clients/rotate-m2m-client-secret/"><span class="method method-post">POST</span><span>Rotate a client's secret</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/mcp/">MCP</a> <span class="api-index__count">1</span></h3>
<ul>
<li><a href="/reference/api/mcp/call-mcp/"><span class="method method-post">POST</span><span>Call the hosted MCP server</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/oauth/">OAuth</a> <span class="api-index__count">17</span></h3>
<ul>
<li><a href="/reference/api/oauth/list-oauth-clients/"><span class="method method-get">GET</span><span>List connected apps (OAuth clients)</span></a></li>
<li><a href="/reference/api/oauth/create-oauth-client/"><span class="method method-post">POST</span><span>Register a connected app</span></a></li>
<li><a href="/reference/api/oauth/get-oauth-client/"><span class="method method-get">GET</span><span>Get a connected app</span></a></li>
<li><a href="/reference/api/oauth/update-oauth-client/"><span class="method method-put">PUT</span><span>Replace a connected app's settings</span></a></li>
<li><a href="/reference/api/oauth/delete-oauth-client/"><span class="method method-delete">DELETE</span><span>Delete a connected app and its grants</span></a></li>
<li><a href="/reference/api/oauth/rotate-oauth-client-secret/"><span class="method method-post">POST</span><span>Rotate a confidential client's secret</span></a></li>
<li class="api-index__more"><a href="/reference/api/oauth/">All 17 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/organization-exports/">Organization exports</a> <span class="api-index__count">2</span></h3>
<ul>
<li><a href="/reference/api/organization-exports/create-organization-export/"><span class="method method-post">POST</span><span>Export the organization list as CSV</span></a></li>
<li><a href="/reference/api/organization-exports/get-organization-export/"><span class="method method-get">GET</span><span>Retrieve an organization export</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/organizations/">Organizations</a> <span class="api-index__count">43</span></h3>
<ul>
<li><a href="/reference/api/organizations/list-organizations/"><span class="method method-get">GET</span><span>List organizations</span></a></li>
<li><a href="/reference/api/organizations/create-organization/"><span class="method method-post">POST</span><span>Create an organization</span></a></li>
<li><a href="/reference/api/organizations/get-organization/"><span class="method method-get">GET</span><span>Retrieve an organization</span></a></li>
<li><a href="/reference/api/organizations/update-organization/"><span class="method method-patch">PATCH</span><span>Update an organization</span></a></li>
<li><a href="/reference/api/organizations/delete-organization/"><span class="method method-delete">DELETE</span><span>Delete an organization</span></a></li>
<li><a href="/reference/api/organizations/get-organization-allowed-intents/"><span class="method method-get">GET</span><span>Get the portal intents an organization allows</span></a></li>
<li class="api-index__more"><a href="/reference/api/organizations/">All 43 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/passport/">Passport</a> <span class="api-index__count">2</span></h3>
<ul>
<li><a href="/reference/api/passport/list-passport-links/"><span class="method method-get">GET</span><span>List the Passports linked to your organizations</span></a></li>
<li><a href="/reference/api/passport/revoke-passport-link/"><span class="method method-delete">DELETE</span><span>Unlink a Passport from one of your organizations</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/pipes/">Pipes</a> <span class="api-index__count">8</span></h3>
<ul>
<li><a href="/reference/api/pipes/list-pipe-connections/"><span class="method method-get">GET</span><span>List Pipes connections</span></a></li>
<li><a href="/reference/api/pipes/create-pipe-connection/"><span class="method method-post">POST</span><span>Start connecting an end user to a provider</span></a></li>
<li><a href="/reference/api/pipes/get-pipe-connection/"><span class="method method-get">GET</span><span>Retrieve a Pipes connection</span></a></li>
<li><a href="/reference/api/pipes/disconnect-pipe-connection/"><span class="method method-delete">DELETE</span><span>Disconnect and revoke a Pipes connection</span></a></li>
<li><a href="/reference/api/pipes/get-pipe-access-token/"><span class="method method-get">GET</span><span>Get a fresh access token for a Pipes connection</span></a></li>
<li><a href="/reference/api/pipes/list-pipe-providers/"><span class="method method-get">GET</span><span>List configured Pipes providers</span></a></li>
<li class="api-index__more"><a href="/reference/api/pipes/">All 8 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/policies/">Policies</a> <span class="api-index__count">5</span></h3>
<ul>
<li><a href="/reference/api/policies/list-policies/"><span class="method method-get">GET</span><span>List policies</span></a></li>
<li><a href="/reference/api/policies/create-policy/"><span class="method method-post">POST</span><span>Create policy</span></a></li>
<li><a href="/reference/api/policies/get-policy/"><span class="method method-get">GET</span><span>Get policy</span></a></li>
<li><a href="/reference/api/policies/update-policy/"><span class="method method-patch">PATCH</span><span>Update policy</span></a></li>
<li><a href="/reference/api/policies/delete-policy/"><span class="method method-delete">DELETE</span><span>Delete policy</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/portal/">Portal</a> <span class="api-index__count">7</span></h3>
<ul>
<li><a href="/reference/api/portal/list-portal-invites/"><span class="method method-get">GET</span><span>List portal invites</span></a></li>
<li><a href="/reference/api/portal/create-portal-invite/"><span class="method method-post">POST</span><span>Invite an IT admin to the portal</span></a></li>
<li><a href="/reference/api/portal/resend-portal-invite/"><span class="method method-post">POST</span><span>Resend a portal invite</span></a></li>
<li><a href="/reference/api/portal/revoke-portal-invite/"><span class="method method-post">POST</span><span>Revoke a portal invite</span></a></li>
<li><a href="/reference/api/portal/list-portal-links/"><span class="method method-get">GET</span><span>List portal links</span></a></li>
<li><a href="/reference/api/portal/create-portal-link/"><span class="method method-post">POST</span><span>Create a portal setup link</span></a></li>
<li class="api-index__more"><a href="/reference/api/portal/">All 7 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/portal-profiles/">Portal profiles</a> <span class="api-index__count">5</span></h3>
<ul>
<li><a href="/reference/api/portal-profiles/list-portal-profiles/"><span class="method method-get">GET</span><span>List environment portal profiles</span></a></li>
<li><a href="/reference/api/portal-profiles/create-portal-profile/"><span class="method method-post">POST</span><span>Create a Business portal profile</span></a></li>
<li><a href="/reference/api/portal-profiles/get-portal-profile/"><span class="method method-get">GET</span><span>Retrieve an environment portal profile</span></a></li>
<li><a href="/reference/api/portal-profiles/replace-portal-profile/"><span class="method method-put">PUT</span><span>Replace an unfinished-setup portal profile</span></a></li>
<li><a href="/reference/api/portal-profiles/delete-portal-profile/"><span class="method method-delete">DELETE</span><span>Delete a portal profile without unexpired link references</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/providers/">Providers</a> <span class="api-index__count">1</span></h3>
<ul>
<li><a href="/reference/api/providers/get-provider-catalogue/"><span class="method method-get">GET</span><span>Retrieve the identity provider and directory source catalogue</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/redirect-uris/">Redirect uris</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/redirect-uris/list-redirect-uris/"><span class="method method-get">GET</span><span>List redirect URIs</span></a></li>
<li><a href="/reference/api/redirect-uris/create-redirect-uri/"><span class="method method-post">POST</span><span>Add a redirect URI</span></a></li>
<li><a href="/reference/api/redirect-uris/delete-redirect-uri/"><span class="method method-delete">DELETE</span><span>Remove a redirect URI</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/requests/">Requests</a> <span class="api-index__count">1</span></h3>
<ul>
<li><a href="/reference/api/requests/list-requests/"><span class="method method-get">GET</span><span>Workbench request log</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/role-rules/">Role rules</a> <span class="api-index__count">6</span></h3>
<ul>
<li><a href="/reference/api/role-rules/list-role-rules/"><span class="method method-get">GET</span><span>List role rules</span></a></li>
<li><a href="/reference/api/role-rules/create-role-rule/"><span class="method method-post">POST</span><span>Create role rule</span></a></li>
<li><a href="/reference/api/role-rules/preview-role-rules/"><span class="method method-post">POST</span><span>Preview the role a sign-in would get</span></a></li>
<li><a href="/reference/api/role-rules/get-role-rule/"><span class="method method-get">GET</span><span>Get role rule</span></a></li>
<li><a href="/reference/api/role-rules/update-role-rule/"><span class="method method-patch">PATCH</span><span>Update role rule</span></a></li>
<li><a href="/reference/api/role-rules/delete-role-rule/"><span class="method method-delete">DELETE</span><span>Delete role rule</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/sandboxes/">Sandboxes</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/sandboxes/create-sandbox/"><span class="method method-post">POST</span><span>Create a claimable test sandbox</span></a></li>
<li><a href="/reference/api/sandboxes/create-sandbox-handoff/"><span class="method method-post">POST</span><span>Start a sandbox handoff for the CLI</span></a></li>
<li><a href="/reference/api/sandboxes/redeem-sandbox-handoff/"><span class="method method-post">POST</span><span>Redeem a sandbox handoff</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/sign-in-hooks/">Sign in hooks</a> <span class="api-index__count">8</span></h3>
<ul>
<li><a href="/reference/api/sign-in-hooks/list-sign-in-hooks/"><span class="method method-get">GET</span><span>List sign-in hooks</span></a></li>
<li><a href="/reference/api/sign-in-hooks/create-sign-in-hook/"><span class="method method-post">POST</span><span>Create a sign-in hook</span></a></li>
<li><a href="/reference/api/sign-in-hooks/get-sign-in-hook/"><span class="method method-get">GET</span><span>Retrieve a sign-in hook</span></a></li>
<li><a href="/reference/api/sign-in-hooks/update-sign-in-hook/"><span class="method method-patch">PATCH</span><span>Update a sign-in hook</span></a></li>
<li><a href="/reference/api/sign-in-hooks/delete-sign-in-hook/"><span class="method method-delete">DELETE</span><span>Delete a sign-in hook</span></a></li>
<li><a href="/reference/api/sign-in-hooks/list-sign-in-hook-deliveries/"><span class="method method-get">GET</span><span>The delivery log of a sign-in hook</span></a></li>
<li class="api-index__more"><a href="/reference/api/sign-in-hooks/">All 8 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/sign-in-risk-policy/">Sign in risk policy</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/sign-in-risk-policy/get-sign-in-risk-policy/"><span class="method method-get">GET</span><span>Retrieve the sign-in risk policy</span></a></li>
<li><a href="/reference/api/sign-in-risk-policy/put-sign-in-risk-policy/"><span class="method method-put">PUT</span><span>Set the sign-in risk policy</span></a></li>
<li><a href="/reference/api/sign-in-risk-policy/delete-sign-in-risk-policy/"><span class="method method-delete">DELETE</span><span>Remove the sign-in risk policy</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/sign-ins/">Sign ins</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/sign-ins/list-sign-ins/"><span class="method method-get">GET</span><span>List the environment's sign-ins</span></a></li>
<li><a href="/reference/api/sign-ins/get-sign-in-explanation/"><span class="method method-get">GET</span><span>Explain a failed sign-in</span></a></li>
<li><a href="/reference/api/sign-ins/get-sign-in-timeline/"><span class="method method-get">GET</span><span>Sign-in timeline</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/ssf-streams/">SSF streams</a> <span class="api-index__count">6</span></h3>
<ul>
<li><a href="/reference/api/ssf-streams/list-ssf-streams/"><span class="method method-get">GET</span><span>List SSF transmitter streams</span></a></li>
<li><a href="/reference/api/ssf-streams/create-ssf-stream/"><span class="method method-post">POST</span><span>Create an SSF transmitter stream</span></a></li>
<li><a href="/reference/api/ssf-streams/get-ssf-stream/"><span class="method method-get">GET</span><span>Get an SSF transmitter stream</span></a></li>
<li><a href="/reference/api/ssf-streams/update-ssf-stream/"><span class="method method-patch">PATCH</span><span>Update an SSF transmitter stream</span></a></li>
<li><a href="/reference/api/ssf-streams/delete-ssf-stream/"><span class="method method-delete">DELETE</span><span>Delete an SSF transmitter stream</span></a></li>
<li><a href="/reference/api/ssf-streams/verify-ssf-stream/"><span class="method method-post">POST</span><span>Send a verification event on a stream</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/sso/">SSO</a> <span class="api-index__count">10</span></h3>
<ul>
<li><a href="/reference/api/sso/get-workos-profile-prefixed/"><span class="method method-get">GET</span><span>Profile for a confined compatibility access token</span></a></li>
<li><a href="/reference/api/sso/exchange-workos-code-prefixed/"><span class="method method-post">POST</span><span>Exchange a confined WorkOS compatibility code</span></a></li>
<li><a href="/reference/api/sso/get-workos-profile/"><span class="method method-get">GET</span><span>Profile for a confined compatibility access token</span></a></li>
<li><a href="/reference/api/sso/exchange-workos-code/"><span class="method method-post">POST</span><span>Exchange a confined WorkOS compatibility code</span></a></li>
<li><a href="/reference/api/sso/migrate-session/"><span class="method method-post">POST</span><span>Session cutover helper during an active import</span></a></li>
<li><a href="/reference/api/sso/forward-sso-response/"><span class="method method-post">POST</span><span>Validate a SAMLResponse or OIDC code received by the app's own ACS</span></a></li>
<li class="api-index__more"><a href="/reference/api/sso/">All 10 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/subprocessor-notices/">Subprocessor notices</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/subprocessor-notices/subscribe-subprocessor-notices/"><span class="method method-post">POST</span><span>Subscribe to sub-processor change notices</span></a></li>
<li><a href="/reference/api/subprocessor-notices/unsubscribe-subprocessor-notices/"><span class="method method-post">POST</span><span>Unsubscribe from sub-processor change notices</span></a></li>
<li><a href="/reference/api/subprocessor-notices/unsubscribe-subprocessor-notices-one-click/"><span class="method method-post">POST</span><span>Unsubscribe from sub-processor change notices (one-click)</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/trusted-issuers/">Trusted issuers</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/trusted-issuers/list-trusted-issuers/"><span class="method method-get">GET</span><span>List trusted token issuers</span></a></li>
<li><a href="/reference/api/trusted-issuers/create-trusted-issuer/"><span class="method method-post">POST</span><span>Trust a third-party token issuer</span></a></li>
<li><a href="/reference/api/trusted-issuers/delete-trusted-issuer/"><span class="method method-delete">DELETE</span><span>Stop trusting a token issuer</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/uploads/">Uploads</a> <span class="api-index__count">1</span></h3>
<ul>
<li><a href="/reference/api/uploads/create-upload/"><span class="method method-post">POST</span><span>Signed upload for an ImportBundle</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/user-management/">User management</a> <span class="api-index__count">11</span></h3>
<ul>
<li><a href="/reference/api/user-management/list-bot-detections/"><span class="method method-get">GET</span><span>List challenged and blocked end-user sign-ins and sign-ups</span></a></li>
<li><a href="/reference/api/user-management/get-bot-protection/"><span class="method method-get">GET</span><span>Get the environment's bot and abuse protection settings</span></a></li>
<li><a href="/reference/api/user-management/update-bot-protection/"><span class="method method-put">PUT</span><span>Replace the environment's bot and abuse protection settings</span></a></li>
<li><a href="/reference/api/user-management/authenticate-end-user-passkey/"><span class="method method-post">POST</span><span>Finish a passkey sign-in (headless)</span></a></li>
<li><a href="/reference/api/user-management/start-end-user-passkey-authentication/"><span class="method method-post">POST</span><span>Start a passkey sign-in</span></a></li>
<li><a href="/reference/api/user-management/get-user-management-settings/"><span class="method method-get">GET</span><span>Get the environment's end-user auth settings</span></a></li>
<li class="api-index__more"><a href="/reference/api/user-management/">All 11 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/users/">Users</a> <span class="api-index__count">16</span></h3>
<ul>
<li><a href="/reference/api/users/list-end-users/"><span class="method method-get">GET</span><span>List or search end users</span></a></li>
<li><a href="/reference/api/users/create-end-user/"><span class="method method-post">POST</span><span>Create an end user</span></a></li>
<li><a href="/reference/api/users/get-end-user/"><span class="method method-get">GET</span><span>Get an end user</span></a></li>
<li><a href="/reference/api/users/update-end-user/"><span class="method method-patch">PATCH</span><span>Update an end user</span></a></li>
<li><a href="/reference/api/users/delete-end-user/"><span class="method method-delete">DELETE</span><span>Delete an end user and their memberships</span></a></li>
<li><a href="/reference/api/users/list-end-user-factors/"><span class="method method-get">GET</span><span>List an end user's passkeys and authenticator apps</span></a></li>
<li class="api-index__more"><a href="/reference/api/users/">All 16 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/vault/">Vault</a> <span class="api-index__count">9</span></h3>
<ul>
<li><a href="/reference/api/vault/vault-decrypt/"><span class="method method-post">POST</span><span>Decrypt a Vault ciphertext of an organization</span></a></li>
<li><a href="/reference/api/vault/vault-encrypt/"><span class="method method-post">POST</span><span>Encrypt data under an organization's named key</span></a></li>
<li><a href="/reference/api/vault/list-vault-keys/"><span class="method method-get">GET</span><span>List an organization's Vault keys</span></a></li>
<li><a href="/reference/api/vault/create-vault-key/"><span class="method method-post">POST</span><span>Create a named Vault key for an organization</span></a></li>
<li><a href="/reference/api/vault/rotate-vault-key/"><span class="method method-post">POST</span><span>Rotate a Vault key</span></a></li>
<li><a href="/reference/api/vault/get-vault-object/"><span class="method method-get">GET</span><span>Read and decrypt one version of an object</span></a></li>
<li class="api-index__more"><a href="/reference/api/vault/">All 9 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/waitlist/">Waitlist</a> <span class="api-index__count">3</span></h3>
<ul>
<li><a href="/reference/api/waitlist/join-waitlist/"><span class="method method-post">POST</span><span>Join the waitlist</span></a></li>
<li><a href="/reference/api/waitlist/remove-from-waitlist/"><span class="method method-post">POST</span><span>Leave the waitlist</span></a></li>
<li><a href="/reference/api/waitlist/remove-from-waitlist-one-click/"><span class="method method-post">POST</span><span>Leave the waitlist (one-click)</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/webhook-deliveries/">Webhook deliveries</a> <span class="api-index__count">1</span></h3>
<ul>
<li><a href="/reference/api/webhook-deliveries/resend-webhook-delivery/"><span class="method method-post">POST</span><span>Resend a delivery</span></a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/webhook-endpoints/">Webhook endpoints</a> <span class="api-index__count">8</span></h3>
<ul>
<li><a href="/reference/api/webhook-endpoints/list-webhook-endpoints/"><span class="method method-get">GET</span><span>List webhook endpoints</span></a></li>
<li><a href="/reference/api/webhook-endpoints/create-webhook-endpoint/"><span class="method method-post">POST</span><span>Create a webhook endpoint</span></a></li>
<li><a href="/reference/api/webhook-endpoints/get-webhook-endpoint/"><span class="method method-get">GET</span><span>Retrieve a webhook endpoint</span></a></li>
<li><a href="/reference/api/webhook-endpoints/update-webhook-endpoint/"><span class="method method-patch">PATCH</span><span>Update a webhook endpoint</span></a></li>
<li><a href="/reference/api/webhook-endpoints/delete-webhook-endpoint/"><span class="method method-delete">DELETE</span><span>Delete a webhook endpoint</span></a></li>
<li><a href="/reference/api/webhook-endpoints/list-webhook-deliveries/"><span class="method method-get">GET</span><span>List deliveries</span></a></li>
<li class="api-index__more"><a href="/reference/api/webhook-endpoints/">All 8 operations</a></li>
</ul>
</section>
<section class="api-index__card">
<h3><a href="/reference/api/workos-compat/">WorkOS compatibility</a> <span class="api-index__count">6</span></h3>
<ul>
<li><a href="/reference/api/workos-compat/list-workos-directories/"><span class="method method-get">GET</span><span>List compatible directories</span></a></li>
<li><a href="/reference/api/workos-compat/get-workos-directory/"><span class="method method-get">GET</span><span>Get compatible directories object</span></a></li>
<li><a href="/reference/api/workos-compat/list-workos-directory-groups/"><span class="method method-get">GET</span><span>List compatible directory_groups</span></a></li>
<li><a href="/reference/api/workos-compat/get-workos-directory-group/"><span class="method method-get">GET</span><span>Get compatible directory_groups object</span></a></li>
<li><a href="/reference/api/workos-compat/list-workos-directory-users/"><span class="method method-get">GET</span><span>List compatible directory_users</span></a></li>
<li><a href="/reference/api/workos-compat/get-workos-directory-user/"><span class="method method-get">GET</span><span>Get compatible directory_users object</span></a></li>
</ul>
</section>
</div>

## Servers

- `https://api.ohauthcat.com`
- `https://api.oauthcat.com`: Standby

The standby host in the contract does not imply that a standby deployment is live.

## Authentication schemes

### cliCredential

A current human CLI session credential; project administrator membership is revalidated for signing-key rotation mutations.

- type: `http`
- scheme: `bearer`

### secretKey

Secret key sk_test_... or sk_live_..., scoped.

- type: `http`
- scheme: `bearer`

### accessToken

SSO access token (ADR-010).

- type: `http`
- scheme: `bearer`

## List organizations example

Set `OHAUTHCAT_BASE_URL` to the API host and `OHAUTHCAT_API_KEY` to your own key. The sample is executed against a local specification mock by the snippet gate. Never embed a key in documentation.

```javascript
const response = await fetch(
  `${process.env.OHAUTHCAT_BASE_URL}/v1/organizations`,
  {
    headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}` },
  },
);
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const organizations = await response.json();
if (!Array.isArray(organizations.data))
  throw new Error("Invalid organizations response");
console.log(`Received ${organizations.data.length} organizations.`);
```

See [schemas](/reference/schemas/), [error codes](/errors/), and the [v1 contract changelog](/reference/changelog/v1/).
