VocalDocscontracts 1.65.0

ApiKeyCreateRequest

Creates an API key of the caller's Organization (1.51.0): a Member session with api_keys:write only.

An object with 4 fields.

Fields

FieldTypeRequiredDescription
environmentEnvironmentyes
expires_atRequestTimestampnoWhen the key stops authenticating, in the future (expires_at_not_future); absent, the key does not expire.
namestringyesA name for the console, such as ci.
scopesarray of ApiKeyScopeyesThe permissions the key holds, each once: never one of SESSION_ONLY_PERMISSIONS (scope_session_only), never one the creator's role does not hold (forbidden with scope_not_grantable), and from 1.57.0 never a content scope whose class the creator's visibility cell does not allow (content_scope_not_allowed).

Used by

The operations whose parameters, request body or responses name this shape directly.