Header Parameters
authorization string<bearer> | authentication token |
Request Body
application/json | list of subjects to allocate assignments for |
Responses
207 application/json | 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) |
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
{
"add": [
{
"subject": "qlik\\kalle",
"type": "professional"
},
{
"subject": "qlik\\nalle",
"type": "analyzer"
}
]
}
Response
{
"data": [
{
"subject": "string",
"type": "string",
"status": 0,
"code": "string",
"title": "string"
}
]
}
Header Parameters
authorization string<bearer> | authentication token |
Request Body
application/json | list of assignments to delete |
Responses
207 application/json | 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) |
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
{
"delete": [
{
"subject": "qlik\\malik",
"type": "analyzer"
}
]
}
Response
{
"data": [
{
"subject": "string",
"type": "string",
"status": 0,
"code": "string",
"title": "string"
}
]
}
Header Parameters
authorization string<bearer> | authentication token |
Request Body
application/json | list of assignments to update |
Responses
207 application/json | 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) |
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
{
"update": [
{
"subject": "qlik\\malik",
"type": "professional",
"sourceType": "analyzer"
}
]
}
Response
{
"data": [
{
"subject": "string",
"type": "string",
"sourceType": "string",
"status": 0,
"code": "string",
"title": "string"
}
]
}
Header Parameters
authorization string<bearer> | authentication token |
Responses
200 application/json | licenses status info |
400 application/json | invalid tenant |
401 application/json | unauthorized (invalid token) |
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/status" \
-H "Authorization: Bearer <API-key>"
Response
{
"status": "Ok",
"valid": "string",
"type": "Signed",
"origin": "Internal",
"trial": true,
"product": "string"
}
Header Parameters
authorization string<bearer> | authentication token |
Responses
200 application/json | licenses overview info |
400 application/json | invalid tenant |
401 application/json | unauthorized (invalid token) |
404 application/json | license not found |
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/overview" \
-H "Authorization: Bearer <API-key>"
Response
{
"licenseNumber": "string",
"licenseKey": "string",
"valid": "string",
"status": "Ok",
"origin": "Internal",
"trial": true,
"allotments": [
{
"name": "professional",
"usageClass": "string",
"unitsUsed": 0,
"units": 0,
"overage": 0
}
],
"product": "string",
"parameters": [
{
"name": "string",
"valid": "string",
"values": {},
"access": {
"allotment": "string"
}
}
]
}
errorResponse
objectProperties
errors | No description |
error deprecated string | error type |
message deprecated string | error message |
verifyTenantsAllowedBody
objectProperties
number string | license number |
Properties
available boolean | shows if more tenants are allowed for the license |
validateRequestBody
objectProperties
number string | license number |
key string | signed license key |
Properties
valid boolean | validation result |
reason string | reason for validation failure |
settingsBody
objectProperties
autoAssignProfessional boolean | No description |
autoAssignAnalyzer boolean | No description |
allotmentBody
objectProperties
component string | No description |
allotmentResponse
objectProperties
usage string | No description Enum: time assigned |
allotmentId string | No description |
duration optional string<duration> | ISO 8601 duration: https://en.wikipedia.org/wiki/ISO_8601#Durations |
provision optional object | No description |
limitsResponse
objectProperties
usage string | No description Enum: unlimited |
allotmentId string | No description |
duration optional string<duration> | ISO 8601 duration: https://en.wikipedia.org/wiki/ISO_8601#Durations |
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> | ISO 8601 duration: https://en.wikipedia.org/wiki/ISO_8601#Durations |
provision optional object | No description |
Properties
subject string | No description |
requests Array<string> | No description |
allotmentsProvisionBody
objectProperties
provision string | No description |
Properties
provisions Array<string> | No description |
renewBody
Array<object>Properties
allotmentId string | No description |
sessionCount integer | No description |
licensesResponse
objectProperties
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
objectProperties
subject string | user identifier |
type string | the assignment type Enum: analyzer professional |
assignmentResponse
objectProperties
id string | the id of the assignment |
assignmentsResponse
objectProperties
data | No description |
links | No description |
href
objectProperties
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 |
Properties
assignments | No description |
max integer | No description |
Properties
add | No description |
Properties
data | No description |
Properties
delete | No description |
Properties
data | No description |
Properties
update | No description |
Properties
data | No description |
licenseStatus
objectProperties
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
objectProperties
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 |
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 |
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 |
Properties
key string | license key |
licenseDefinition
objectProperties
licenseNumber string | license serial number |
valid string | time interval for definition validity |
blacklisted string | license blacklist status |
allotments | No description |
features | No description |
allotmentMeResponse
objectProperties
id string | id of the allotment |
allotmentName string | Name of the allotment |
duration optional string<duration> | ISO 8601 duration: https://en.wikipedia.org/wiki/ISO_8601#Durations |
allotments
objectProperties
name string | allotment name |
usage | No description |
units | No description |
provisions | No description |
features
objectProperties
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
objectProperties
name string | No description |
autoAssign optional boolean | whether to do auto assignment if applicable, defaults to false |
select optional | No description |
parametersSelect
objectProperties
name string | No description |
autoAssign optional boolean | whether to do auto assignment if applicable, defaults to false |
parametersPostResponse
objectProperties
parameterSets | No description |
parameterSet
objectProperties
name string | No description |
values optional object | No description |