Tenants

Tenants is the resource representing a tenant.

Endpoints

Skip to section
POST/v1/tenants

Creates a Tenant

manage

Request Body POST /v1/tenants

optional, application/json

No description

Responses POST /v1/tenants

201
optional, application/json

Tenant created.

400
optional, application/json

Invalid request was made.

403
optional, application/json

Invalid request was made.

500
optional, application/json

Internal server error

default
optional, application/json

Unexpected error.

POST/v1/tenants

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

Request POST /v1/tenants

{
  "name": "bk1672h181jm1b1",
  "hostnames": [
    "bk1672h181jm1b1.us.qlikcloud.com"
  ],
  "licenseKey": 1234567890
}

Response POST /v1/tenants

{
  "id": "string",
  "name": "string",
  "links": {
    "self": {
      "href": "string"
    }
  },
  "status": "active",
  "created": "2022-09-23T14:08:43.995Z",
  "hostnames": [],
  "lastUpdated": "2022-09-23T14:08:43.996Z",
  "createdByUser": "string",
  "enableAnalyticCreation": true,
  "autoAssignCreateSharedSpacesRoleToProfessionals": true
}

Error

object

An error object describing the error.

Properties

code
string

The error code.

meta
optional
object

Additional properties relating to the error.

title
string

Summary of the problem.

detail
optional
string

A human-readable explanation specific to this occurrence of the error.

source
optional

References to the source of the error.

status
string

The HTTP status code.

Errors

object

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

Properties

errors
optional

An array of errors related to the operation.

traceId
optional
string

A unique identifier for tracing the error.

Tenant

Properties

id
string<uid>

The unique tenant identifier.

name
string

The display name of the tenant.

links
optional

No description

status
optional
string

The status of the tenant.

Enum:

active

disabled

deleted

created
optional
string<date>

The timestamp for when the tenant record was created.

hostnames
optional
Array<string>

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.

lastUpdated
optional
string<date>

The timestamp for when the tenant record was last updated.

createdByUser
optional
string

The user ID who created the tenant.

enableAnalyticCreation
optional, default=false
boolean

No description

autoAssignCreateSharedSpacesRoleToProfessionals
optional, default=true
boolean

No description

TenantCreationRequest

object

Properties

name
optional
string

The name of the created tenant, provided by the onboarding service.

hostnames
optional
Array<string>

The hostnames of the created tenant. Can only create with a single entry that lines up wtih the tenant name.

licenseKey
optional
string

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

v0.448.13
Was this page helpful?