1. Docs
  2. API Reference
  3. Remove a member from an organization

Remove a member from an organization

DELETE/api/v1/organizations/{id}/members/{identityId}

Removes the member from this organization, revoking their role here and nothing else — the identity and its memberships in other organizations are untouched. Returns 404 when the identity is not a member. Responds 204 No Content, requires the rbac.manage_assignments permission at the organization, and emits organization.member.removed.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required
identityIdstring Required

Responses

Member removed

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

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

(empty body)
 Related endpoints
GETList organizations
POSTCreate an organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
GETList an organization's members
POSTAdd a member to an organization
PATCHChange a member's role
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