Set up an organization's SSO connection
/api/v1/organizations/{id}/sso-connectionCreates an end_user SSO connection at the Account, links it to the organization's Environment, and binds it to the organization, with default_role_id as the membership role when given, in one call. Without one the binding waits for an arrival role, which activation requires; the arrival-roles route lists the choices and which to preselect. The connection starts configuring and belongs to this organization: no other organization may bind it. Returns 409 (organization.sso_connection_already_configured) when the organization already has one. Requires hierarchy.manage or canopy:organization.manage at the organization.
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.
hierarchy.manageHierarchyCreate, update, and delete hierarchy nodes. 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.
Path Parameters
idstring Required Headers
X-Canopy-EnvironmentThe id of the Environment this request acts in. Required with an account API key, which belongs to the Account and names its Environment per request; an Environment key may send it only to name its own Environment. A missing header for an account key answers `400` (`api_key.environment_required`), one naming no Environment of the key's Account `400` (`api_key.environment_not_found`), and one naming another Environment than an Environment key's own `400` (`api_key.environment_mismatch`).
Request body
application/json
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 default_role_idstring Optional The Environment role a person joins the organization with when they first sign in through this connection. May be left for later; activation requires it. The arrival-roles route lists what may be chosen.
Responses
application/json
dataOrganizationSsoConnectionDetailResponseDto
application/json
errorApiErrorBodyDto
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/organizations/value/sso-connection" \ -H "X-Canopy-Environment: value" \ -H "X-API-Key: $CANOPY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "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, "default_role_id": "string" }'
{ "data": { "connection": { "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 }, "default_role": { "id": "string", "name": "string" }, "owned_by_organization": false, "service_provider": { "protocol": "saml", "acs_url": "string", "entity_id": "string", "metadata_url": "string", "redirect_uri": "string" }, "certificate_expiry": { "expires_at": "string", "days_remaining": 0, "expired": false, "expiring_soon": false } } }
Tell us how we can improve this guide.