Skip to content
Dashboard
Theme
Theme

Create a connection

POST /v1/connections: Create a connection.

View Markdown

POST /v1/connections

Scope
connections:write
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • organization string Required

  • name string

  • type string Required

    one of saml, oidc

  • saml_metadata_url string (uri)

  • saml_metadata_xml string

  • saml_manual object

  • oidc_discovery_url string (uri)

  • oidc_client_id string

  • oidc_client_secret string

  • routing_domains array of string

  • idp_initiated ConnectionIDPInitiated

    SAML only, off by default. Enabling or editing requires Business. While enabled, client_id must be a live publishable key in this environment and default_redirect_uri must exactly match a registered redirect. The broker always requires an account confirmation before sending a short single-use handoff ticket to that URI. Apps bind the ticket to their normal caller-PKCE authorize flow. Saving disabled removes the configuration; an absent object leaves it unchanged. Existing enabled settings keep being enforced after a plan downgrade.

  • oidc_managed ConnectionManagedOIDC

    Sign in with Google Workspace or Microsoft Entra through OhAuthCat’s own multi-tenant app: no per-customer IdP app. Set on an OIDC connection instead of oidc_discovery_url, oidc_client_id and oidc_client_secret. Every token is bound to the organization: Google’s hd claim, and the email domain, must be domains the organization verified; Microsoft Entra’s tid must be entra_tenant_id. Personal accounts are refused unless allow_personal_accounts is true (the verified-domain rule still applies).

  • catalogue_idp string

    Optional explicit catalogue selection, such as the IdP the developer picked in the dashboard wizard; never inferred from the IdP configuration. It must name a catalogue IdP that offers SSO over the connection’s type, or the request answers parameter_invalid. The portal’s edit flow offers the matching setup steps for it; a connection without one stays editable through this API.

    one of okta, entra, google_workspace, onelogin, jumpcloud, adfs, generic_saml, generic_oidc, generic_scim, okta_oidc, entra_oidc, google_oidc, pingfederate, pingone, keycloak, adp, auth0, cas, classlink, clever_oidc, cloudflare_access, cyberark, duo, lastpass, login_gov, miniorange, netiq, oracle, rippling, salesforce, shibboleth, shibboleth_unsolicited, simplesamlphp, vmware, sailpoint, csv, bamboohr, rippling_hris, google_admin_sdk, sftp_csv, workday, hibob, personio, gusto

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/connections" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"type": "saml"
}'
Response 201
{
"oidc_managed": {
"provider": "google_workspace",
"entra_tenant_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"allow_personal_accounts": false
},
"catalogue_idp": "okta",
"id": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"object": "connection",
"legacy_ids": {
"workos": "org_01H8ZQ4M7K2X8V3N5B6C1D0E9F"
},
"forwarding": {
"acs_urls": [
"https://app.acme.com/callback"
],
"redirect_uris": [
"https://app.acme.com/callback"
],
"until": "2026-01-15T09:30:00Z",
"expires_in_days": 0,
"last_warning_days": 1,
"hint": "example_hint"
},
"idp_initiated": {
"enabled": false,
"client_id": "client_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"default_redirect_uri": "https://app.acme.com/callback"
},
"organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"name": "Acme Corp",
"type": "saml",
"state": "draft",
"sp_entity_id": "https://idp.acme.com/saml/metadata",
"sp_metadata_url": "https://app.acme.com/callback",
"test_idp": true,
"acs_urls": [
"https://app.acme.com/callback"
],
"sp_slo_urls": [
"https://app.acme.com/callback"
],
"routing_domains": [
"acme.com"
],
"standby_registered": true,
"import_source": "example_import_source",
"import_lever": "A",
"standby_acs_selection": "url",
"idp_entity_id": "https://idp.acme.com/saml/metadata",
"oidc_issuer": "https://idp.acme.com/saml/metadata",
"metadata_stale_since": "2026-01-15T09:30:00Z",
"untested_since": "2026-01-15T09:30:00Z",
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:30:00Z"
}