Skip to content
AcrivaDocs

RevokeApiKey

POST
/api/v1/t/{tenant}/identity/api-keys/{keyId}/revoke
curl --request POST \
  --url https://example.com/api/v1/t/example/identity/api-keys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/revoke

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

keyId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string format: uuid
name
required
string
prefix
required
string
scopes
required
Array<string>
roleId
required
string format: uuid
roleName
required
string
state
required
Allowed values: Active Expired Revoked
expiresAt
required
string format: date-time
lastUsedAt
required
null | string format: date-time
createdBy
required
string format: uuid
createdAt
required
string format: date-time
revokedAt
required
null | string format: date-time
Example
{
  "state": "Active"
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}