1. Docs
  2. API Reference
  3. Bind an SSO connection to an organization

Bind an SSO connection to an organization

POST/api/v1/organizations/{id}/sso-connections

Binds an end_user SSO connection to the organization: a login through the connection lands in this organization, joining as a member with default_role_id when the identity is provisioned or is not yet a member, and the session starts here. The connection must already be bound to the organization's Environment (that binding routes the email domain), and the role must belong to the Environment (400 otherwise). A connection binds to one organization per Environment (409). Requires the hierarchy.manage permission at the organization and emits organization.sso_connection.bound.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required

Request body

application/json

sso_connection_idstring Required

An end-user SSO connection already bound to the organization's Environment.

default_role_idstring Required

The membership role a login through this connection receives when it joins the organization. Must belong to the organization's Environment.

Responses

application/json

  • dataOrganizationSsoConnectionResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

OrganizationSsoConnectionResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/organizations/value/sso-connections" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sso_connection_id": "string",
    "default_role_id": "string"
  }'
Response
{
  "data": {
    "organization_node_id": "string",
    "sso_connection_id": "string",
    "sso_connection": {
      "id": "string",
      "name": "string",
      "type": "saml",
      "status": "string"
    },
    "default_role_id": "string",
    "default_role": {
      "id": "string",
      "name": "string"
    },
    "created_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList organizations
POSTCreate an organization
DELETEDelete every organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
GETGet an organization's authentication policy
PATCHUpdate an organization's authentication policy
GETList an organization's SSO connections
DELETEUnbind an SSO connection from an organization
GETList an organization's members
POSTAdd a member to an organization
PATCHChange a member's role
DELETERemove a member from an organization
GETList an organization's invitations
POSTInvite a member into an organization
DELETERevoke an organization invitation
 Was this page helpful?

Tell us how we can improve this guide.

Canopy