1. Docs
  2. API Reference
  3. Revoke an invite

Revoke an invite

DELETE/api/v1/identity-invites/{id}

Revokes a pending invite in the active Environment, marking it revoked so its token can no longer be accepted. Returns 204 No Content on success. Returns 404 when the invite is not found and 400 when it has already been accepted and can no longer be revoked.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Responses

Invite revoked

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

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

(empty body)
 Related endpoints
GETList invites
POSTCreate an invite
GETGet invite summary
POSTBulk-create invites
POSTResend an invite
 Was this page helpful?

Tell us how we can improve this guide.

Canopy