ZITADEL Docs
APIsCore ResourcesV2Authorizations

Deactivate Authorization

DeactivateAuthorization deactivates an existing and active authorization.

Note: Authorization in this context refers to role assignments, not to OAuth authorization.

In case the authorization is already inactive, the request will return a successful response as the desired state is already achieved. You can check the change date in the response to verify if the authorization was deactivated by the request.

Required permissions:

  • "user.grant.write"
POST
/zitadel.authorization.v2.AuthorizationService/DeactivateAuthorization

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

id*string

ID is the unique identifier of the authorization that should be deactivated.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.authorization.v2.AuthorizationService/DeactivateAuthorization" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'
{
  "changeDate": "2023-01-15T01:30:15.01Z"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?