1. Docs
  2. API Reference
  3. Revoke an organization invitation

Revoke an organization invitation

DELETE/api/v1/organizations/{id}/invites/{inviteId}

Revokes an invitation on this organization; the emailed link stops working immediately. Returns 404 when the invitation does not belong to this organization. Requires the identity.manage permission and emits invite.revoked.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required
inviteIdstring Required

Responses

Invitation revoked

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

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

(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
DELETERemove a member from an organization
GETList an organization's invitations
POSTInvite a member into an organization
 Was this page helpful?

Tell us how we can improve this guide.

Canopy