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

Revoke an invite

DELETE/portal/v1/accounts/{accountSlug}/user-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

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

Requires capability administrators.manageGovernance

Invite, deactivate, and remove administrators. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

idstring Required

Responses

Invite revoked

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Request
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/user-invites/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Invite revoked

(empty body)
 Related endpoints
GETList invites
POSTCreate an invite
GETGet invite summary
POSTResend an invite
PATCHChange the role a pending invite grants
 Was this page helpful?

Tell us how we can improve this guide.

Canopy