Contents

ApiKeyCreate

Fields

name required Type: string
permissions required Type: Permission[]
The key's permissions, at most your own.
org_id optional Type: string
A sub-organisation that will own the key, so requests made with it run there with no Unforged-Org header. Defaults to your own organisation. Needs org:children:access, isn't available while acting in another organisation, and the key can't hold org:keys:manage, org:billing:manage or org:children:manage.

Example

{
  "name": "backend",
  "permissions": [
    "nib:checks:create",
    "nib:checks:read",
    "nib:subjects:read"
  ]
}