Skip to main content

provisionDevTenant

Requires permission settings:apps:manage.

Provision a dev tenant: a new, separate organization for building and testing apps. It holds synthetic data only, is always in test mode (mail and messages go to a sink, webhooks carry X-ARC-Environment: test), and its first user is you.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

mutation ProvisionDevTenant($input: ProvisionDevTenantInput!) {
  provisionDevTenant(input: $input) {
    onboardingId
    organizationId
    subdomain
  }
}

Variables:

{
  "input": {
    "name": "string",
    "subdomain": "string"
  }
}

Response:

{
  "data": {
    "provisionDevTenant": {
      "onboardingId": "string",
      "organizationId": "id",
      "subdomain": "string"
    }
  }
}
provisionDevTenant(
  input: ProvisionDevTenantInput!
): ProvisionedDevTenant!

Arguments​

provisionDevTenant.input ● ProvisionDevTenantInput! non-null input​

The dev tenant to provision.

Type​

ProvisionedDevTenant object​

A dev tenant that is being set up.