POST/v1/customers/{external_id}/grants/{grant_id}:revoke

Revoke a grant

Revokes a grant the customer holds, identified by grantId, with an optional reason. Optionally guarded by expectedRevision. Needs customers:write.

curl -X POST 'https://api.entitler.co/v1/customers/ada/grants/<grant_id>:revoke' \
  -H "Authorization: Bearer $ENTITLER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":{"value":1},"reason":"reason","target":{"environmentId":"environmentId","projectId":"projectId","teamId":"teamId"}}'

Credentials

Send any one of these:

Bearer token

Path parameters

Name	Type	Description
`external_id`required	string	The customer's external ID, or `me` for the customer a customer token or identity token names.
`grant_id`required	string

Request body

object

expectedRevisioncommon.Revision-Input
- valueinteger
  at least 0; at most 18446744073709552000
reasonstring
targetProductTarget
- environmentIdstring
- projectIdstring
- teamIdstring

Responses

`200`The RevokeGrantResponse message.

RevokeGrantResponse

changedbooleanrequired
grantGrant
- featureKeystringrequired
- fromintegerrequired
  at least 0; at most 18446744073709552000
- grantedBycommon.Actor
  - idstringrequired
  - typecommon.ActorTyperequired
    One of ACTOR_TYPE_UNSPECIFIED, ACTOR_TYPE_USER, ACTOR_TYPE_KEY, ACTOR_TYPE_SYSTEM.
- idstringrequired
- reasonstringrequired
- revokeReasonstring
- revokedAtinteger
  at least 0; at most 18446744073709552000
- revokedBycommon.Actor
  - idstringrequired
  - typecommon.ActorTyperequired
    One of ACTOR_TYPE_UNSPECIFIED, ACTOR_TYPE_USER, ACTOR_TYPE_KEY, ACTOR_TYPE_SYSTEM.
- untilinteger
  at least 0; at most 18446744073709552000
- valueGrantValue
  - limitcommon.Limit
    - countinteger
      at least 0; at most 18446744073709552000
    - unlimitedcommon.Unlimited
  - onSwitchOn
revisionintegerrequired
at least 0; at most 18446744073709552000

`Error`A refusal, with the HTTP status of its gRPC code.

Error

errorobjectrequired
- codestringrequired
- parametersobjectrequired
  Each value: string
- reasonstringor nullrequired