API reference
The OhAuthCat v1 API, version 1.0.0: resources, servers and authentication.
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 and Directory sync.
Resources
Section titled “Resources”Attribute catalogue 3
Audit log events 4
Audit log schemas 3
Audit logs 3
Authorization 12
Branding 5
Connection health 1
Connections 39
Custom domains 5
Debug bundle share 1
Debug bundles 6
Developer tools 3
Directories 23
Directory groups 2
Directory sources 5
Directory users 2
Email events 2
Encryption keys 7
- GETList customer-managed key versions and their re-seal state
- POSTRegister a customer-managed AWS KMS key as the scope's new active version
- GETThe key policy statement and service principal to grant
- GETGet one key version
- POSTMake an enabled version active again
- POSTDeprecate a non-active version
- All 7 operations
Environment 4
Events 2
Exports 2
Feature flags 7
IdP Radar 3
Imports 7
Invites 3
IT email configuration 3
Log streams 3
M2M clients 6
MCP 1
OAuth 17
Organization exports 2
Organizations 43
Passport 2
Pipes 8
Policies 5
Portal 7
Portal profiles 5
Providers 1
Redirect uris 3
Requests 1
Role rules 6
Sandboxes 3
Sign in hooks 8
Sign in risk policy 3
Sign ins 3
SSF streams 6
SSO 10
- GETProfile for a confined compatibility access token
- POSTExchange a confined WorkOS compatibility code
- GETProfile for a confined compatibility access token
- POSTExchange a confined WorkOS compatibility code
- POSTSession cutover helper during an active import
- POSTValidate a SAMLResponse or OIDC code received by the app's own ACS
- All 10 operations
Subprocessor notices 3
Trusted issuers 3
Uploads 1
User management 11
- GETList challenged and blocked end-user sign-ins and sign-ups
- GETGet the environment's bot and abuse protection settings
- PUTReplace the environment's bot and abuse protection settings
- POSTFinish a passkey sign-in (headless)
- POSTStart a passkey sign-in
- GETGet the environment's end-user auth settings
- All 11 operations
Users 16
Vault 9
Waitlist 3
Webhook deliveries 1
Webhook endpoints 8
WorkOS compatibility 6
Servers
Section titled “Servers”https:/ / api. ohauthcat. com https:: Standby/ / api. oauthcat. com
The standby host in the contract does not imply that a standby deployment is live.
Authentication schemes
Section titled “Authentication schemes”cliCredential
Section titled “cliCredential”A current human CLI session credential; project administrator membership is revalidated for signing-key rotation mutations.
- type:
http - scheme:
bearer
secretKey
Section titled “secretKey”Secret key sk_test_… or sk_live_…, scoped.
- type:
http - scheme:
bearer
accessToken
Section titled “accessToken”SSO access token (ADR-010).
- type:
http - scheme:
bearer
List organizations example
Section titled “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.
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, error codes, and the v1 contract changelog.