1. Docs
  2. API Reference
  3. Delete every organization

Delete every organization

DELETE/api/v1/organizations

Deletes every live organization in the Environment the way the single delete does: memberships and every assignment beneath each organization are removed, pending invitations bound to the organization or its tree are revoked, and each organization is soft-deleted with its subtree. Member identities are untouched. This is the step before switching the container off. Responds 204 No Content, requires the hierarchy.manage permission, and emits organization.deleted_all with the counts.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Responses

Every organization deleted with its memberships, pending invitations, and subtree

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/api/v1/organizations" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 Every organization deleted with its memberships, pending invitations, and subtree

(empty body)
 Related endpoints
GETList organizations
POSTCreate an 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
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