Skip to main content

TenantCreationInput

Input for creation a whole tenant from scratch via a workflow. Collects the tenant name, tenant config, optional mail provider credentials, and the optional initial back-office user.

input TenantCreationInput {
  tenantName: String!
  config: TenantCreationConfigInput!
  mailConfig: TenantMailConfigInput
  initialAdminUser: TenantCreationAdminUserInput
}

Fields​

TenantCreationInput.tenantName ● String! non-null scalar​

Tenant name. Used to derive the tenant id and as the display name.

TenantCreationInput.config ● TenantCreationConfigInput! non-null input​

Tenant-level configuration.

TenantCreationInput.mailConfig ● TenantMailConfigInput input​

Mail provider credentials, stored in the per-tenant secret config. Omit to seed empty credentials.

TenantCreationInput.initialAdminUser ● TenantCreationAdminUserInput input​

Initial back-office user. When provided, the user is created (or an existing one is linked to the tenant); a newly created user is granted owner roles and emailed an invitation.

Member Of​

tenantCreationInitiate mutation