Skip to main content

tenantCreationStatus

Reports the status of a tenant-creation workflow. Returns the created tenant id once the workflow has COMPLETED.

Errors: TENANT_CREATION_STATUS_ERROR if the workflow could not be found or described.

tenantCreationStatus(
workflowId: String!
): TenantCreationResult!

Arguments

tenantCreationStatus.workflowId ● String! non-null scalar

Workflow id returned by the tenantCreationInitiate mutation.

Type

TenantCreationResult object

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