Create an SSO connection
/api/v1/sso/connectionsCreates a new SSO connection in the Account in configuring status, accepting SAML or OIDC config via the request body; any supplied oidc_client_secret is encrypted before persistence and never returned. end_user-scope connections consume a plan connection slot and return 409 when the limit is reached, while admin-scope connections are unmetered. Emits an sso.connection.created audit row and returns the created connection as 201.
Authentication
Authorization Option A JWT access token. Never send alongside X-API-Key: a request carrying both is refused.
X-API-Key Option B API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.
sso.manageAccountCreate, update, and delete SSO connections, verified domains and SCIM tokens. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.
Request body
application/json
scopeenum Required typeenum Required namestring Required Human label, e.g. "Acme Corp Okta".
saml_entity_idstring Optional saml_sso_urlstring Optional saml_slo_urlstring Optional saml_signing_certstring Optional IdP X.509 signing certificate (PEM).
saml_signature_algorithmstring Optional saml_want_assertions_signedboolean Optional saml_name_id_formatstring Optional force_authnboolean Optional Force the IdP to re-authenticate the user on every login (SAML ForceAuthn / OIDC max_age=0). Prevents silent reuse of a stale IdP session on shared devices.
oidc_discovery_urlstring Optional The identity provider's OIDC discovery document. Canopy's servers fetch it, so it must be an `https` address on a public host; private, loopback and link-local addresses are refused.
oidc_client_idstring Optional oidc_client_secretstring Optional OIDC client secret (plaintext in; encrypted at rest).
oidc_scopesstring[] Optional attribute_mappingobject Optional jit_provisioning_enabledboolean Optional Responses
application/json
dataSsoConnectionResponseDto
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
Errors
When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.
authorization.deniedForbiddenThe credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.
Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.
Returned object
curl -X POST "https://auth.canopy-io.com/api/v1/sso/connections" \ -H "X-API-Key: $CANOPY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "scope": "admin", "type": "saml", "name": "string", "saml_entity_id": "string", "saml_sso_url": "string", "saml_slo_url": "string", "saml_signing_cert": "string", "saml_signature_algorithm": "string", "saml_want_assertions_signed": false, "saml_name_id_format": "string", "force_authn": false, "oidc_discovery_url": "string", "oidc_client_id": "string", "oidc_client_secret": "string", "oidc_scopes": [ "string" ], "attribute_mapping": {}, "jit_provisioning_enabled": false }'
{ "data": { "id": "string", "account_id": "string", "scope": "admin", "type": "saml", "name": "string", "status": "configuring", "owner_organization_node_id": "string", "owned_by_organization": false, "saml_metadata_url": "string", "last_test_sign_in": { "test_id": "string", "outcome": "success", "reason": "string", "email": "string", "domain_outcome": "accepted", "completed_at": "2026-04-20T12:00:00.000Z" }, "saml_entity_id": "string", "saml_sso_url": "string", "saml_slo_url": "string", "saml_signing_cert": "string", "saml_signature_algorithm": "string", "saml_want_assertions_signed": false, "saml_name_id_format": "string", "force_authn": false, "oidc_discovery_url": "string", "oidc_client_id": "string", "oidc_scopes": [ "string" ], "has_oidc_client_secret": false, "jit_provisioning_enabled": false, "attribute_mapping": {}, "last_login_at": "2026-04-20T12:00:00.000Z", "created_at": "2026-04-20T12:00:00.000Z", "updated_at": "2026-04-20T12:00:00.000Z", "version": 0 } }
Tell us how we can improve this guide.