Get a Check API key.

GET

/api/admin/check-api-keys/{id}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/check-api-keys/example \
  --header 'Authorization: Bearer <token>'

Returns metadata for one Check API key. The key hash and plaintext secret are never returned.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Check API key identifier.

Responses

200

Check API key detail response.

Media type application/json

object

id

required

string

tenant_id

required

string

client_id

required

string

name

required

string

key_prefix

required

string

allowed_operations

required

Array<string>

Allowed values: check batch subscribe

rate_limit_tier

required

string

Allowed values: strict moderate lenient

is_active

required

boolean

expires_at

integer | null format: int64

created_by

string | null

created_at

required

integer format: int64

updated_at

required

integer format: int64

key

additional properties

Example

{
  "allowed_operations": [
    "check"
  ],
  "rate_limit_tier": "strict"
}

400

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"
}

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"
}

500

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"
}

503

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"
}