Tenants

Tenants is the resource representing a tenant.

Endpoints

Skip to section
POST/v1/tenants

Creates a Tenant

Request Body POST /v1/tenants

application/json

No description

Responses POST /v1/tenants

201
application/json

Tenant created.

400
application/json

Invalid request was made.

403
application/json

Invalid request was made.

500
application/json

Internal server error

default
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":"string","hostname":[],"licenseKey":"string"}'

Request POST /v1/tenants

{
  "name": "string",
  "hostname": [],
  "licenseKey": "string"
}

Response POST /v1/tenants

{
  "id": "string",
  "name": "string",
  "links": {
    "self": {
      "href": "string"
    }
  },
  "status": "active",
  "created": "2022-08-15T13:39:44.433Z",
  "hostnames": [],
  "lastUpdated": "2022-08-15T13:39:44.433Z",
  "createdByUser": "string",
  "enableAnalyticCreation": true,
  "autoAssignCreateSharedSpacesRoleToProfessionals": true
}

Error

An error object.

Properties

code
string

The error code.

meta
optional
object

Additional properties relating to the error.

title
string

Summary of the error.

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

An array of error objects.

Properties

errors

No description

Tenant

Properties

id
string<uid>

No description

name
string

No description

links
optional

No description

status
optional
string

No description

Enum:

active

disabled

deleted

created
optional
string<date>

No description

hostnames
optional
Array<string>

No description

lastUpdated
optional
string<date>

No description

createdByUser
optional
string

No description

enableAnalyticCreation
optional, default=false
boolean

No description

autoAssignCreateSharedSpacesRoleToProfessionals
optional, default=true
boolean

No description

TenantCreationRequest

object

Properties

name
string

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

hostname
Array<string>

No description

licenseKey
string

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

v0.392.12
Was this page helpful?