Tenancy

One-call signup provisioning (tenant + owner + app + API key)

Atomically creates a tenant, its first owner member, a default application, and a long-lived API key. api_key and client_secret are returned ONCE. Guarded by the dedicated provision secret (the X-Provision-Secret header or a Bearer token) so the customer console's server can hold this narrow secret instead of the operator management key. It also mints the workspace default key (see POST /tenants/{tenant_id}/default-key) and returns it ONCE as default_api_key with its id; both fields are absent if it could not be made, and the default key route makes it later.

post/tenants:provision

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/tenants:provision
  • Auth: API key in header X-Provision-Secret

Request body

tenant_namestring required
app_namestring
owner_emailstring
environment'production' | 'staging' | 'development'

Response

Provisioned (api_key + client_secret shown once)

tenant_idstring required
application_idstring required
api_keystring required

cd_live_… or cd_test_…; shown once

client_secretstring required

mints widget JWTs; shown once

default_api_keystring

The workspace default key, cd_live_… or cd_test_…; shown once. Absent when it could not be made.

default_api_key_idstring

The default key's id; present with default_api_key.

Changes

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