Skip to content
Authrim

List Check API keys.

GET
/api/admin/check-api-keys
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/check-api-keys?page=1&limit=20' \
  --header 'Authorization: Bearer <token>'

Lists Check API keys for the current tenant. Results may be filtered by client and active state and are returned as page-based metadata plus key records without plaintext secrets.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
integer
default: 1 >= 1

One-based result page. Defaults to 1.

limit
integer
default: 20 >= 1 <= 100

Maximum number of keys to return. The implementation caps this at 100.

client_id
string

Filter keys for a specific client.

is_active
boolean

Filter by active or revoked keys.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Check API key list response.

Media type application/json
object
keys
required
Array<object>
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
total
required
integer
page
required
integer
>= 1
limit
required
integer
>= 1
key
additional properties
Example 
{
  "keys": [
    {
      "allowed_operations": [
        "check"
      ],
      "rate_limit_tier": "strict"
    }
  ]
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}