Auth API reference

Auth API · Consumer-Tenant-Api-Keys

get/{app_slug}/v1/tenant-api-keys/{key_id}/statusAuth

Why a tenant API key is (in)active

For your own audit trail: record why a key you saw go inactive died (revoked in the console, creator left the tenant, expired, keys suspended). Only keys of this app; another app's key is 404. Requires `auth.tenant.api_keys.introspect` on the app.

Path parameters

app_slug*string

The app slug.

key_id*string

Key id (UUID) or display id (`tak_…`), as `introspect` returned it.

Response · 200 The key status.

status*object

`revoked` (wins over everything), `expired`, `orphaned` (the creator left the tenant or the tenant is not active), `suspended` (the app's tenant keys are suspended or switched off, or the app is not active), `active`.

revoke_reason*object

Why a `revoked` key was revoked; `null` otherwise.

Example

Request

GET https://api.auth.productcraft.co/{app_slug}/v1/tenant-api-keys/{key_id}/status
Authorization: Bearer YOUR_TOKEN

Response

{
  "status": {},
  "revoke_reason": {}
}