DevelopersSecurityPricing
Get started
Get started
Contents

ApiKeyCreated

Fields

  • id required Type: string
  • display_prefix required Type: string

    The key's first characters, to recognise it.

  • name required Type: string
  • permissions required Type: Permission[]
  • created_at required Type: string
  • last_used_at required Type: string null
  • revoked_at required Type: string null
  • created_by optional Type: string null

    Who made the key, e.g. user:<id>.

  • owner optional Type: KeyOrg

    The sub-organisation that owns a key you issued for it.

  • issued_by optional Type: KeyOrg

    The parent organisation that issued this key for you.

  • key required Type: string

    The key, shown once.

Example 
{
  "id": "key_01j9x3m8v7k2q4r5s6t7u8v9w0",
  "display_prefix": "unf_live_01AbCdEf",
  "name": "backend",
  "permissions": [
    "nib:checks:create",
    "nib:checks:read",
    "nib:subjects:read"
  ],
  "created_at": "2026-09-25T10:15:30.123Z",
  "last_used_at": null,
  "revoked_at": null,
  "key": "unf_live_01AbCdEf…EXAMPLE"
}

Where you'll see it