1. Docs
  2. API Reference
  3. Unbind an SSO connection from an organization

Unbind an SSO connection from an organization

DELETE/api/v1/organizations/{id}/sso-connections/{connectionId}

Removes the binding; logins through the connection fall back to the Environment's placement. Existing memberships are untouched. Returns 404 when the connection is not bound to this organization. Requires the hierarchy.manage permission at the organization and emits organization.sso_connection.unbound.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required
connectionIdstring Required

Responses

Connection unbound

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/api/v1/organizations/value/sso-connections/value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 Connection unbound

(empty body)
 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
POSTBind an SSO connection to 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