Revoke the current user's consent for a client.

DELETE

/api/user/consents/{clientId}

Code sample: Shell / cURL

curl --request DELETE \
  --url https://auth.example.com/api/user/consents/example \
  --header 'Authorization: Bearer <token>'

Deletes the authenticated user’s consent for the requested client, records consent history, optionally revokes related tokens, and publishes a consent revoked event.

Authorizations

• userBearer
• userSessionCookie

Parameters

Path Parameters

clientId

required

string

Responses

200

Successful JSON response.

Media type application/json

object

success

required

boolean

accessTokensRevoked

required

integer

refreshTokensRevoked

required

integer

revokedAt

required

integer

Example

{
  "success": true,
  "accessTokensRevoked": 0,
  "refreshTokensRevoked": 1,
  "revokedAt": 1770000000000
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}