1. Docs
  2. API Reference
  3. Revoke a scoped invitation

Revoke a scoped invitation

DELETE/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/workspace/invitations/{invitationId}

Revokes an invitation so its link can no longer be accepted, and records an invite.revoked audit event. Revoking one that is already revoked changes nothing and records nothing. Requires invitations.manage covering the invitation's node, and an invitation with no node needs Environment-wide authority. Returns 404 when the invitation is not in this Environment, and 400 when it has already been accepted.

Authentication

Bearer TokenAuthorization

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

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

invitationIdstring Required

Responses

Invitation revoked

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/workspace/invitations/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Invitation revoked

(empty body)
 Related endpoints
GETResolve the caller's operational authority in the Environment
GETList identities within the caller's operational scope
GETList an identity's responsibilities within the caller's scope
GETList the identity roles the caller may grant
GETList the hierarchy locations the caller may assign at
GETList the hierarchy nodes the caller can see in this Environment
GETList identity invitations within the caller's scope
POSTInvite an identity into a location with a role
GETList scoped operational activity within the caller's scope
GETDownload the scoped activity feed as CSV
GETHow long activity history is kept for this Account
POSTResend a scoped invitation
POSTGrant an identity a role at a hierarchy node
PATCHMove or re-role an existing assignment
DELETERemove an identity's role assignment
 Was this page helpful?

Tell us how we can improve this guide.

Canopy