Sign in

v1

latestOpenAPI 3.0.02026-08-0461030.0 KB
tenants

Create a tenant

Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the My Qlik portal to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. https://register.us.qlikcloud.com/api/v1/tenants if interacting with tenants in the us region.

post/api/v1/tenants

Request body

datacenterstring

The datacenter where the tenant is located.

Supported locations for commercial licenses:

  • ap-northeast-1: Japan (jp)
  • ap-southeast-1: Australia (ap)
  • ap-southeast-2: Singapore (sg)
  • eu-central-1: Germany (de)
  • eu-west-1: Ireland (eu)
  • eu-west-2: United Kingdom (uk)
  • us-east-1: United States of America (us)
licenseKeystring

The signed license key of the license that will be associated with the created tenant.

Example request

{
  "datacenter": "us-east-1"
}

Response

Tenant created.

idstring uid required

The unique tenant identifier.

namestring required

The display name of the tenant.

regionstring

The region where the tenant is located.

status'active' | 'disabled' | 'deleted' | 'user-access-disabled'

The status of the tenant.

createdstring date

The timestamp for when the tenant record was created (1970-01-01T00:00:00.001Z for static tenants).

hostnamesstring[]

List of case insensitive hostnames that are mapped to the tenant. The first record maps to the display name and the subsequent entries are aliases.

datacenterstring

The datacenter where the tenant is located.

lastUpdatedstring date

The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants).

createdByUserstring

The user ID who created the tenant.

statusLastUpdatedAtstring date-time

The timestamp for when the tenant status was last changed.

enableAnalyticCreationboolean
enableAppOpeningFeedbackboolean
autoAssignCreateSharedSpacesRoleToProfessionalsboolean
autoAssignDataServicesContributorRoleToProfessionalsboolean
autoAssignPrivateAnalyticsContentCreatorRoleToProfessionalsboolean

Example response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "name": "QlikTenant",
  "links": {
    "self": {
      "href": "http://foo.example/api/v1/tenants/TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
    }
  },
  "region": "us",
  "hostnames": [
    "foo.example"
  ],
  "datacenter": "us-east-1",
  "createdByUser": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy7A",
  "statusLastUpdatedAt": "2023-08-18T12:34:56.789Z"
}