Create a Check API key.

POST

/api/admin/check-api-keys

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/check-api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "client_id": "client_123", "name": "Policy Check API key", "allowed_operations": [ "check", "batch" ], "rate_limit_tier": "moderate", "expires_at": 1770007200 }'

Creates a tenant-scoped Check API key for a client. The plaintext api_key is returned only in this creation response and cannot be retrieved later.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

client_id

required

string

name

required

string

allowed_operations

Array<string>

Allowed values: check batch subscribe

rate_limit_tier

string

Allowed values: strict moderate lenient

expires_at

integer format: int64

key

additional properties

Example

{
  "client_id": "client_123",
  "name": "Policy Check API key",
  "allowed_operations": [
    "check",
    "batch"
  ],
  "rate_limit_tier": "moderate",
  "expires_at": 1770007200
}

Responses

201

Created or rotated Check API key response. The plaintext key is returned only once.

Media type application/json

object

id

required

string

api_key

required

Plaintext API key returned only once.

string

key_prefix

required

string

name

required

string

client_id

required

string

allowed_operations

required

Array<string>

Allowed values: check batch subscribe

rate_limit_tier

required

string

Allowed values: strict moderate lenient

expires_at

integer format: int64

created_at

required

integer format: int64

key

additional properties

Example

{
  "id": "018f3f7c-85b0-7c5d-a6b6-1c3a6e6b9e01",
  "api_key": "ar_chk_live_example",
  "key_prefix": "ar_chk",
  "name": "Policy Check API key",
  "client_id": "client_123",
  "allowed_operations": [
    "check"
  ],
  "rate_limit_tier": "moderate",
  "created_at": 1770000000
}

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

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