Skip to content

licenses

Licenses is the resource representing tenant and user entitlements

Endpoints

Skip to section
GET/licenses/consumption
GET/licenses/assignments
POST/licenses/assignments/actions/add
POST/licenses/assignments/actions/delete
POST/licenses/assignments/actions/update
GET/licenses/status
GET/licenses/overview
GET/licenses/settings
PUT/licenses/settings

Retrieves license consumption for the current tenant

Header Parameters GET /licenses/consumption

authorization
string<bearer>

authentication token

Query Parameters GET /licenses/consumption

limit
optional, default=200, minimum=1, maximum=200
integer<int32>

The preferred number of entries returned

page
optional
string

The requested page

sort
optional
string

The field to sort on, can be prefixed with +/- for ascending/descending sort order

filter
optional
string

The filter for finding entries

Responses GET /licenses/consumption

200

successful

400
application/json

bad request, malformed query

401
application/json

unauthorized

403
application/json

insufficient access

GET/licenses/consumption

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

Response GET /licenses/consumption

{
  "data": [
    {
      "id": "string",
      "userId": "string",
      "sessionId": "string",
      "appId": "string",
      "endTime": "string",
      "duration": "string",
      "allotmentId": "string",
      "capacityUsed": 0,
      "minutesUsed": 0,
      "licenseUsage": "string"
    }
  ],
  "links": {}
}

Retrieves assignments for the current tenant

Header Parameters GET /licenses/assignments

authorization
string<bearer>

authentication token

Query Parameters GET /licenses/assignments

limit
optional, default=20, minimum=1, maximum=100
integer<int32>

The preferred number of entries returned

page
optional
string

The requested page

sort
optional
string

The field to sort on, can be prefixed with +/- for ascending/descending sort order

filter
optional
string

The filter for finding entries

Responses GET /licenses/assignments

200
application/json

list of assignments

400
application/json

bad request, invalid query

401
application/json

unauthorized (invalid token)

403
application/json

insufficient access

GET/licenses/assignments

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

Response GET /licenses/assignments

{
  "data": [
    {
      "subject": "qlik\\kalle",
      "type": "analyzer",
      "excess": false,
      "created": "2020-12-03T09:24:48.114Z"
    },
    {
      "subject": "qlik\\nalle",
      "type": false,
      "created": "2020-12-03T09:24:48.114Z"
    }
  ],
  "links": {
    "next": {
      "href": "http://license/v1/licenses/assignments?limit=4&page=bmV4dDpGZ0FBQUFkZmFXUUFYOHBUcTlpM1U4UU1YWHZrQUE%3D"
    },
    "prev": {
      "href": "http://license/v1/licenses/assignments?limit=4&page=cHJldjpGZ0FBQUFkZmFXUUFYOHBUcTlpM1U4UU1YWHZ0QUE%3D"
    }
  }
}

Assigns license access to the given users

Header Parameters POST /licenses/assignments/actions/add

authorization
string<bearer>

authentication token

Request Body POST /licenses/assignments/actions/add

list of subjects to allocate assignments for

Responses POST /licenses/assignments/actions/add

207

processed (the status of the individual assignments are found in the response body)

400
application/json

body is bad or missing

401
application/json

unauthorized (invalid token)

403
application/json

insufficient access

POST/licenses/assignments/actions/add

curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/assignments/actions/add" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"add":[{"subject":"qlik\\kalle","type":"professional"},{"subject":"qlik\\nalle","type":"analyzer"}]}'

Request POST /licenses/assignments/actions/add

{
  "add": [
    {
      "subject": "qlik\\kalle",
      "type": "professional"
    },
    {
      "subject": "qlik\\nalle",
      "type": "analyzer"
    }
  ]
}

Response POST /licenses/assignments/actions/add

{
  "data": [
    {
      "subject": "qlik\\kalle",
      "type": "professional",
      "status": 201
    },
    {
      "subject": "qlik\\nalle",
      "type": "analyzer",
      "status": 403,
      "code": "LICENSES-011",
      "title": "no available allotment error, no available allotment"
    }
  ]
}

Removes license access for the given users

Header Parameters POST /licenses/assignments/actions/delete

authorization
string<bearer>

authentication token

Request Body POST /licenses/assignments/actions/delete

list of assignments to delete

Responses POST /licenses/assignments/actions/delete

207

processed (the status of the individual assignments are found in the response body)

400
application/json

body is bad or missing

401
application/json

unauthorized (invalid token)

403
application/json

insufficient access

POST/licenses/assignments/actions/delete

curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/assignments/actions/delete" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"delete":[{"subject":"qlik\\malik","type":"analyzer"}]}'

Request POST /licenses/assignments/actions/delete

{
  "delete": [
    {
      "subject": "qlik\\malik",
      "type": "analyzer"
    }
  ]
}

Response POST /licenses/assignments/actions/delete

{
  "data": [
    {
      "subject": "qlik\\malik",
      "type": "professional",
      "status": 200
    },
    {
      "status": 404,
      "code": "LICENSES-016",
      "title": "Assignment not found",
      "subject": "qlik\\no",
      "type": "analyzer"
    }
  ]
}

Updates license access for the given users

Header Parameters POST /licenses/assignments/actions/update

authorization
string<bearer>

authentication token

Request Body POST /licenses/assignments/actions/update

list of assignments to update

Responses POST /licenses/assignments/actions/update

207

processed (the status of the individual assignments are found in the response body)

400
application/json

body is bad or missing

401
application/json

unauthorized (invalid token)

403
application/json

insufficient access

POST/licenses/assignments/actions/update

curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/assignments/actions/update" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"update":[{"subject":"qlik\\malik","type":"professional","sourceType":"analyzer"}]}'

Request POST /licenses/assignments/actions/update

{
  "update": [
    {
      "subject": "qlik\\malik",
      "type": "professional",
      "sourceType": "analyzer"
    }
  ]
}

Response POST /licenses/assignments/actions/update

{
  "data": [
    {
      "subject": "qlik\\malik",
      "type": "professional",
      "sourceType": "analyzer",
      "status": 200
    },
    {
      "sourceType": "analyzer",
      "subject": "qlik/sara",
      "status": 404,
      "code": "LICENSES-016",
      "title": "Assignment not found"
    }
  ]
}

Gets the license status information of the current tenant

Header Parameters GET /licenses/status

authorization
string<bearer>

authentication token

Responses GET /licenses/status

200
application/json

licenses status info

400
application/json

invalid tenant

401
application/json

unauthorized (invalid token)

GET/licenses/status

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

Response GET /licenses/status

{
  "status": "Ok",
  "valid": "2018-01-01/2018-12-31",
  "type": "Signed",
  "origin": "Internal",
  "trial": false,
  "product": "Qlik Sense Business"
}

Gets the general information of the license applied to the current tenant

Header Parameters GET /licenses/overview

authorization
string<bearer>

authentication token

Responses GET /licenses/overview

200
application/json

licenses overview info

400
application/json

invalid tenant

401
application/json

unauthorized (invalid token)

404
application/json

license not found

GET/licenses/overview

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

Response GET /licenses/overview

{
  "licenseNumber": "9999000000001204",
  "licenseKey": "hejhbGciOiJSUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6IktFWTEifQ.eyJqdGkiOiIxZjZkZTc0Zi04MDcyLTRjMTQtYjc1OS02ZjlkYmJmYWM5MjAiLCJsaWNlbnNlIjoiOTk5OTAwMDAwMDAwMTIzNCJ9.fwa6l6gY1MR_Ja2OMnV65V68fbzQYW5OAKUFnLfG9oZjNAbjhdDkZvS2S2zHaBnSrSva1ARh5iq_S0KTBOKKcJJDTb7jRVURyaAvbCuBDk_0ITrUudHaT9U_Mc9EKkfT8mR6vthhZxVzEhyYPFS7gDw7M6bav2ntpDsoJFPgous",
  "valid": "2018-01-01/2018-12-31",
  "status": "Ok",
  "origin": "Internal",
  "trial": false,
  "allotments": [
    {
      "name": "analyzer_time",
      "usageClass": "time",
      "unitsUsed": 242,
      "units": 300,
      "overage": 100
    },
    {
      "name": "professional",
      "usageClass": "assigned",
      "unitsUsed": 15,
      "units": 200
    }
  ],
  "product": "Qlik Sense Enterprise SaaS",
  "parameters": [
    {
      "name": "qlikAlerting",
      "valid": "./.",
      "values": {
        "saas_alerting": "FULL"
      }
    }
  ]
}

Get auto assign settings for tenant

Header Parameters GET /licenses/settings

authorization
string<bearer>

authentication token

Responses GET /licenses/settings

200
application/json

auto assign settings

400
application/json

missing or invalid tenant

401
application/json

not allowed

403
application/json

insufficient access

GET/licenses/settings

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

Response GET /licenses/settings

{
  "autoAssignProfessional": false,
  "autoAssignAnalyzer": true
}

Set auto assign settings for tenant

Header Parameters PUT /licenses/settings

authorization
string<bearer>

authentication token

Request Body PUT /licenses/settings

application/json

No description

Responses PUT /licenses/settings

200
application/json

auto assign settings

400
application/json

missing or invalid tenant

401
application/json

action not allowed

403
application/json

insufficient access

PUT/licenses/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/settings" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"autoAssignProfessional":false,"autoAssignAnalyzer":true}'

Request PUT /licenses/settings

{
  "autoAssignProfessional": false,
  "autoAssignAnalyzer": true
}

Response PUT /licenses/settings

{
  "autoAssignProfessional": false,
  "autoAssignAnalyzer": true
}

errorResponse

object

Properties

errors

No description

error
deprecated
string

error type

message
deprecated
string

error message

verifyTenantsAllowedBody

object

Properties

number
string

license number

verifyTenantsAllowedResponse

object

Properties

available
boolean

shows if more tenants are allowed for the license

validateRequestBody

object

Properties

number
string

license number

key
string

signed license key

validateResultResponseBody

object

Properties

valid
boolean

validation result

reason
string

reason for validation failure

settingsBody

object

Properties

autoAssignProfessional
boolean

if professional users are available these will be automatically assigned

autoAssignAnalyzer
boolean

if analyzer users are available these will be automatically assigned

allotmentBody

object

Properties

component
string

No description

allotmentResponse

object

Properties

usage
string

No description

Enum:

time

assigned

allotmentId
string

No description

duration
optional
string<duration>
provision
optional
object

No description

limitsResponse

object

allotmentProvisionResponse

object

Properties

usage
string

No description

Enum:

unlimited

allotmentId
string

No description

duration
optional
string<duration>
provision
optional
object

No description

allotmentProvisionListResponse

Array<object>

Properties

allotmentId
string

No description

usage
string

No description

Enum:

unlimited

provision
object

No description

getAllotmentsResponse

Array<object>

Properties

allotmentId
string

No description

name
optional
string

No description

usage
string

No description

Enum:

time

assigned

duration
optional
string<duration>
provision
optional
object

No description

allotmentsPrioritizedBody

object

Properties

subject
string

No description

requests
Array<string>

No description

allotmentsProvisionBody

object

Properties

provision
string

No description

allotmentsProvisionListBody

object

Properties

provisions
Array<string>

No description

renewBody

Array<object>

Properties

allotmentId
string

No description

sessionCount
integer

No description

licensesResponse

object

Properties

id
string

No description

assignmentsPatchBody

Array<object>

Properties

id
optional
string

the id of the assignment

sourceType
optional
string

No description

subject
optional
string

No description

type
string

the assignment type

Enum:

analyzer

professional

assignmentBody

object

Properties

subject
string

user identifier

type
string

the assignment type

Enum:

analyzer

professional

assignmentResponse

object

Properties

id
string

the id of the assignment

assignmentsResponse

object

Properties

data

No description

links

No description

href

object

Properties

href
string

link

patchAssignmentsResponse

Array<object>

Properties

id
optional
string

No description

sourceType
optional
string

No description

subject
optional
string

No description

type
string

No description

status
optional
integer

No description

addAssignmentsListBody

Array<object>

Properties

subject
string

No description

type
string

No description

name
optional
string

human readable display name for the subject

userId
optional
string

deployment unique id for the subject

addAssignmentsListResponse

Array<object>

Properties

id
optional
string

No description

type
string

No description

subject
string

No description

status
integer

No description

deleteAssignmentsListBody

Array<object>

Properties

id
string

No description

type
string

No description

subject
string

No description

deleteAssignmentsListResponse

Array<object>

Properties

id
optional
string

No description

type
optional
string

No description

subject
optional
string

No description

status
integer

No description

getAssignmentsListResponse

object

Properties

assignments

No description

max
integer

No description

assignmentsActionsAddRequest

object

Properties

add

No description

assignmentsActionsAddResponse

object

Properties

data

No description

assignmentsActionsDeleteRequest

object

Properties

delete

No description

assignmentsActionsDeleteResponse

object

Properties

data

No description

assignmentsActionsUpdateRequest

object

Properties

update

No description

assignmentsActionsUpdateResponse

object

Properties

data

No description

licenseStatus

object

Properties

status
string

Enum with status of license. Only status Ok grants license access.

Enum:

Ok

Blacklisted

Expired

Missing

valid
string

Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end.

type
string

Type of license key

Enum:

Signed

Plain

origin
string

Origin of license key

Enum:

Internal

External

trial
boolean

Boolean indicating if it is a trial license

product
string

The product the license is valid for

licenseOverview

object

Properties

licenseNumber
string

No description

licenseKey
string

No description

valid
string

Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end.

status
string

Enum with status of license. Only status Ok grants license access.

Enum:

Ok

Blacklisted

Expired

origin
string

Origin of license key

Enum:

Internal

External

updated
string

An ISO 8601 timestamp the license was last updated

trial
boolean

Boolean indicating if it is a trial license

allotments

No description

product
string

The product the license is valid for

parameters

The license parameters

licenseSignedDefinitionRequestBody

object

Properties

definition
string

base64 encoded license definition

signature
string

base64 encoded signature of the definition

keyId
string

ID of the key used to create the signature

licenseDefinitionRequestBody

object

Properties

key
string

license key

licenseDefinition

object

Properties

licenseNumber
string

license serial number

valid
string

time interval for definition validity

blacklisted
string

license blacklist status

allotments

No description

features

No description

allotmentMeResponse

object

Properties

id
string

id of the allotment

name
string

Name of the allotment

Enum:

professional

analyzer

analyzer_time

duration
optional
string<duration>

allotments

object

Properties

name
string

allotment name

usage

No description

units

No description

provisions

No description

features

object

Properties

name
string

feature name

value
string

feature value

valid
string

time interval for feature validity

auditLogs

Array<object>

Properties

seqNo
integer

audit log sequence number

type
integer

audit log type

message
string

base64 encoded audit log message

signautre
optional
string

audit log message signature

createdDate
string

audit log created date

parametersPostRequest

object

Properties

$allOf

No description

select
optional

No description

parametersSelect

object

Properties

name
string

No description

autoAssign
optional
boolean

whether to do auto assignment if applicable, defaults to false

consume
optional
boolean

whether to consume from a time usage if applicable, defaults to false

parametersPostResponse

object

Properties

parameterSets

No description

parameterSet

object

Properties

name
string

No description

values
optional
object

No description

consumptionEventsResponse

object

Properties

data

No description

links

No description

v6.13.0
Was this page helpful?