One-call signup provisioning (tenant + owner + app + API key)
One-call signup provisioning (tenant + owner + app + API key): CustomDomain™ API reference in the tenancy group. Covers parameters, request body and responses.
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.
Authorization
provisionSecret Narrow secret held by the customer console's server, for signup provisioning and its other server to server calls (also accepted as a Bearer token, except on POST /audit, where a Bearer is always a tenant credential).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/tenants:provision" \ -H "Content-Type: application/json" \ -d '{ "tenant_name": "string" }'{ "tenant_id": "string", "application_id": "string", "api_key": "string", "client_secret": "string", "default_api_key": "string", "default_api_key_id": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}