API keys

Create an API key

Creates an API key that authenticates as its own principal within the organization. access grants either one organization-wide role (admin, full_editor, or content_editor) or one role (full_editor or content_editor) on at least one website in the organization; the owner role can never be granted, and website ids outside the organization fail with 400. name is 1–200 characters and expiresAt is an ISO 8601 timestamp or null for a key that never expires. The response contains the plaintext secret exactly once — only a SHA-256 hash is stored, so it cannot be retrieved again.

post/apiKeys

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/apiKeys
  • Auth: HTTP bearer

Request body

organizationIdstring required
namestring required

Response

The created key and its plaintextKey secret. Store the secret now; it is never shown again.

plaintextKeystring required

The plaintext secret, a 32-byte base64url string. Store it now; it is never shown again, and only a SHA-256 hash is kept.

Changes

No recorded changes to this operation across all 1 revision of this API.