Contents

ApiKey

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.