Skip to main content

TenantCreationResult

Handle for an async tenant-creation workflow. The mutation returns immediately; poll tenantCreationStatus with the workflowId for progress and the final tenant id.

type TenantCreationResult {
  workflowId: String!
  status: String!
  tenantId: String
}

Fields​

TenantCreationResult.workflowId ● String! non-null scalar​

Workflow id for the creation run.

TenantCreationResult.status ● String! non-null scalar​

Current workflow status (e.g. RUNNING, COMPLETED, FAILED).

TenantCreationResult.tenantId ● String scalar​

The created tenant id, available once the workflow has completed.

Returned By​

tenantCreationInitiate mutation ● tenantCreationStatus query