Tenants

Tenants is the resource representing a tenant.

Endpoints

POST

/v1/tenants
GET

/v1/tenants/{tenantId}
PATCH

/v1/tenants/{tenantId}
POST

/v1/tenants/{tenantId}/actions/deactivate
POST

/v1/tenants/{tenantId}/actions/reactivate
GET

/v1/tenants/me

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Request Body

Required

application/json

application/jsonobject
Show application/json properties
- datacenterstring
  
  The datacenter where the tenant is located.
- licenseKeystring
  
  The signed license key of the license that will be associated with the created tenant.

Responses

201

application/json

Tenant created.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  The unique tenant identifier.
  
  format = "uid"
- namestring
  Required
  
  The display name of the tenant.
- linksobject
  
  Show links properties
  
  selfobject
  Required
  
  A link to this tenant.
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- statusstring
  
  The status of the tenant.
  
  Can be one of: "active""disabled""deleted"
- createdstring
  
  The timestamp for when the tenant record was created (1970-01-01T00:00:00.001Z for static tenants).
  
  format = "date"
- hostnamesarray of strings
  
  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
  
  The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants).
  
  format = "date"
- createdByUserstring
  
  The user ID who created the tenant.
- enableAnalyticCreationboolean
  
  default = false
- autoAssignCreateSharedSpacesRoleToProfessionalsboolean
  
  default = true
- autoAssignDataServicesContributorRoleToProfessionalsboolean
  
  default = true
- autoAssignPrivateAnalyticsContentCreatorRoleToProfessionalsboolean
  
  default = true

400

application/json

Invalid request was made.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

403

application/json

Invalid request was made.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal server error

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

default

application/json

Unexpected error.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

POST /v1/tenants

curl "https://your-tenant.us.qlikcloud.com/api/v1/tenants" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"datacenter":"us-east-1","licenseKey":1234567890}'

const https = require('https')
  const data = JSON.stringify({"datacenter":"us-east-1","licenseKey":1234567890})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tenants',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik tenant create \
--licenseKey="1234567890"

Request

{
  "datacenter": "us-east-1",
  "licenseKey": 1234567890
}

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "name": "QlikTenant",
  "links": {
    "self": {
      "href": "http://foo.example/api/v1/tenants/TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
    }
  },
  "status": "active",
  "created": "string",
  "hostnames": [
    "foo.example"
  ],
  "datacenter": "us-east-1",
  "lastUpdated": "string",
  "createdByUser": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy7A",
  "enableAnalyticCreation": false,
  "autoAssignCreateSharedSpacesRoleToProfessionals": true,
  "autoAssignDataServicesContributorRoleToProfessionals": true,
  "autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals": true
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Path Parameters

tenantIdstring
Required

The id of the tenant to retrieve

format = "uid"

Responses

200

application/json

Tenant found.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  The unique tenant identifier.
  
  format = "uid"
- namestring
  Required
  
  The display name of the tenant.
- linksobject
  
  Show links properties
  
  selfobject
  Required
  
  A link to this tenant.
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- statusstring
  
  The status of the tenant.
  
  Can be one of: "active""disabled""deleted"
- createdstring
  
  The timestamp for when the tenant record was created (1970-01-01T00:00:00.001Z for static tenants).
  
  format = "date"
- hostnamesarray of strings
  
  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
  
  The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants).
  
  format = "date"
- createdByUserstring
  
  The user ID who created the tenant.
- enableAnalyticCreationboolean
  
  default = false
- autoAssignCreateSharedSpacesRoleToProfessionalsboolean
  
  default = true
- autoAssignDataServicesContributorRoleToProfessionalsboolean
  
  default = true
- autoAssignPrivateAnalyticsContentCreatorRoleToProfessionalsboolean
  
  default = true

404

application/json

Tenant not found.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

default

application/json

Unexpected error

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

GET /v1/tenants/{tenantId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/tenants/{tenantId}" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tenants/{tenantId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "name": "QlikTenant",
  "links": {
    "self": {
      "href": "http://foo.example/api/v1/tenants/TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
    }
  },
  "status": "active",
  "created": "string",
  "hostnames": [
    "foo.example"
  ],
  "datacenter": "us-east-1",
  "lastUpdated": "string",
  "createdByUser": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy7A",
  "enableAnalyticCreation": false,
  "autoAssignCreateSharedSpacesRoleToProfessionals": true,
  "autoAssignDataServicesContributorRoleToProfessionals": true,
  "autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals": true
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Path Parameters

tenantIdstring
Required

The id of the tenant to update

format = "uid"

Request Body

Required

application/json

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.

application/jsonarray of objects

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  A JSON Pointer value that references a location within the target document where the operation is performed.
  
  Can be one of: "/name""/hostnames/1""/autoAssignCreateSharedSpacesRoleToProfessionals""/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals""/autoAssignDataServicesContributorRoleToProfessionals""/enableAnalyticCreation"
- valuestring|boolean
  Required
  
  The value to be used for this operation.
  
  One of:
  
  string
  
  boolean

Responses

204

Tenant updated successfully

400

application/json

Invalid PATCH request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  codestring
  
  The error code.
  
  titlestring
  
  Summary of the problem.
  
  titlestring
  Required
  
  Summary of the problem.
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON Pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.

403

application/json

Forbidden

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

404

application/json

Tenant not found.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

default

application/json

Unexpected error

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

PATCH /v1/tenants/{tenantId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/tenants/{tenantId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"replace","path":"/name","value":"Corp"},{"op":"replace","path":"/hostnames/1","value":"example-tenant.us.qlikcloud.com"},{"op":"replace","path":"/autoAssignCreateSharedSpacesRoleToProfessionals","value":true},{"op":"replace","path":"/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals","value":false},{"op":"replace","path":"/autoAssignDataServicesContributorRoleToProfessionals","value":true},{"op":"replace","path":"/enableAnalyticCreation","value":false}]'

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/name","value":"Corp"},{"op":"replace","path":"/hostnames/1","value":"example-tenant.us.qlikcloud.com"},{"op":"replace","path":"/autoAssignCreateSharedSpacesRoleToProfessionals","value":true},{"op":"replace","path":"/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals","value":false},{"op":"replace","path":"/autoAssignDataServicesContributorRoleToProfessionals","value":true},{"op":"replace","path":"/enableAnalyticCreation","value":false}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tenants/{tenantId}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

[
  {
    "op": "replace",
    "path": "/name",
    "value": "Corp"
  },
  {
    "op": "replace",
    "path": "/hostnames/1",
    "value": "example-tenant.us.qlikcloud.com"
  },
  {
    "op": "replace",
    "path": "/autoAssignCreateSharedSpacesRoleToProfessionals",
    "value": true
  },
  {
    "op": "replace",
    "path": "/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals",
    "value": false
  },
  {
    "op": "replace",
    "path": "/autoAssignDataServicesContributorRoleToProfessionals",
    "value": true
  },
  {
    "op": "replace",
    "path": "/enableAnalyticCreation",
    "value": false
  }
]

Deactivates a tenant.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Header Parameters

qlik-confirm-hostnamestring
Required

A confirmation string that should match the hostname associated with the tenant resource to be deactivated. Example: unicorn.eu.qlikcloud.com

format = "hostname"

Path Parameters

tenantIdstring
Required

The id of the tenant to deactivate

format = "uid"

Request Body

application/json

A request to deactivate a tenant.

application/jsonobject

A request to deactivate a tenant.
Show application/json properties
- purgeAfterDaysinteger
  
  Sets the number of days to purge the tenant after deactivation. Only available to OEMs.
  
  minimum = 10, maximum = 90, default = 30, default = 30

Responses

200

application/json

Tenant deactivated successfully

The result of tenant deactivation.

application/jsonobject

The result of tenant deactivation.
Show application/json properties
- idstring
  
  The unique tenant identifier.
  
  format = "uid"
- statusstring
  
  The status of the tenant.
  
  Can be one of: "disabled"
- estimatedPurgeDatestring
  
  The estimated date time of when tenant will be purged.
  
  format = "date-time"

400

application/json

Invalid request

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

403

application/json

Forbidden

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

404

application/json

Tenant Not Found

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

412

application/json

Precondition Failed (invalid qlik-confirm-hostname value)

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

default

application/json

Unexpected error

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

POST /v1/tenants/{tenantId}/actions/deactivate

curl "https://your-tenant.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"purgeAfterDays":30}'

const https = require('https')
  const data = JSON.stringify({"purgeAfterDays":30})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tenants/{tenantId}/actions/deactivate',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "purgeAfterDays": 30
}

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "status": "disabled",
  "estimatedPurgeDate": "2023-08-18T00:00:00.000Z"
}

Reactivates a disabled tenant.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Header Parameters

qlik-confirm-hostnamestring
Required

A confirmation string that should match one of the hostnames of the tenant resource to be reactivated. Example: unicorn.eu.qlikcloud.com

Path Parameters

tenantIdstring
Required

The id of the tenant to reactivate

format = "uid"

Request Body

application/json

application/jsonobject

Responses

200

application/json

Tenant reactivated successfully

application/jsonobject

403

application/json

Forbidden

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

404

application/json

Not Found

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

412

application/json

Precondition Failed (invalid qlik-confirm-hostname value)

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

default

application/json

Unexpected error

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

POST /v1/tenants/{tenantId}/actions/reactivate

curl "https://your-tenant.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/reactivate" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{}'

const https = require('https')
  const data = JSON.stringify({})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tenants/{tenantId}/actions/reactivate',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{}

Response

{}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Responses

302

text/html

Successful redirect.

text/htmlstring

GET /v1/tenants/me

curl "https://your-tenant.us.qlikcloud.com/api/v1/tenants/me" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/tenants/me',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Tenants

Endpoints

Creates a Tenant

Facts

Request Body

Responses

201

400

403

500

default

Request

Response

Retrieve a single tenant by id.

Facts

Path Parameters

Responses

200

404

default

Response

Update a tenant by id.

Facts

Path Parameters

Request Body

Responses

204

400

403

404

429

default

Request

Deactivate a tenant

Facts

Header Parameters

Path Parameters

Request Body

Responses

200

400

403

404

412

429

default

Request

Response

Reactivates a tenant

Facts

Header Parameters

Path Parameters

Request Body

Responses

200

403

404

412

429

default

Request

Response

Redirects to current tenant.

Facts

Responses

302