Permanently revoke an Agent Grant and its active token families.

POST

/api/admin/agent-grants/{id}/revoke

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/agent-grants/example/revoke \
  --header 'Authorization: Bearer <token>'

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

/^aag_/

Agent Grant identifier.

Responses

200

Grant state and token-family revocation outbox were committed atomically.

Media type application/json

object

grant_id

required

string

status

required

string

Allowed values: suspended revoked

generation

required

integer

>= 2

token_families_pending_revocation

required

integer

revocation_outbox_id

required

string

key

additional properties

Example

{
  "status": "suspended"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}