Licenses

Licenses define tenant and user entitlements, and can be used in conjunction with the consumption API to get a picture of entitlement usage.

Download specification

Retrieves assignments for the current tenant

Facts

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

Header Parameters

  • authorizationstring

    Authentication token

    format = "bearer"

Query Parameters

  • filterstring

    The filter for finding entries.

  • limitinteger

    The preferred number of entries to return.

    minimum = 1, maximum = 100, default = 20, format = int32, default = 20

  • orphansboolean

    Only return assignments which are 'orphans' in the current tenant.

  • pagestring

    The requested page.

  • sortstring

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

Responses

200

application/json

List of assignments.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Required
      Show data properties
      • typestring
        Required

        Allotment type

      • excessboolean
        Required

        Assignment excess status.

      • createdstring
        Required

        Assignment created date.

      • subjectstring
        Required

        Subject
    • linksobject
      Required
      Show links properties
      • nextobject
        Show next properties
        • hrefstring

          link
      • prevobject
        Show prev properties
        • hrefstring

          link

400

application/json

Bad request, invalid query.

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

401

application/json

Unauthorized (invalid token).

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

403

application/json

Insufficient access

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message
GET /v1/licenses/assignments 
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/assignments" \
-H "Authorization: Bearer <access_token>"

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

qlik license assignment ls

Response

{
  "data": [
    {
      "type": "analyzer",
      "excess": false,
      "created": "2020-12-03T09:24:48.114Z",
      "subject": "qlik\\kalle"
    },
    {
      "type": false,
      "created": "2020-12-03T09:24:48.114Z",
      "subject": "qlik\\nalle"
    }
  ],
  "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

Facts

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

Header Parameters

  • authorizationstring

    Authentication token

    format = "bearer"

Request Body

Required

application/json

List of subjects to allocate assignments for.

  • application/jsonobject
    Show application/json properties
    • addarray of objects
      Required
      Show add properties
      • namestring

        User name

      • typestring
        Required

        Allotment type

      • userIdstringDeprecated

        User ID

      • subjectstring
        Required

        User subject

Responses

207

application/json

Processed. (The status of the individual assignments is found in the response body)

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Required
      Show data properties
      • codestring

        Error code

      • typestring

        Allotment type

      • titlestring

        Error title

      • statusinteger
        Required

        Response status

      • subjectstring
        Required

        Subject

400

application/json

Body is invalid or missing.

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

401

application/json

Unauthorized (invalid token).

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

403

application/json

Insufficient access

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

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

const https = require('https')
  const data = JSON.stringify({"add":[{"type":"professional","subject":"qlik\\kalle"},{"type":"analyzer","subject":"qlik\\nalle"}]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/licenses/assignments/actions/add',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

qlik license assignment add \
--add='{"type":"professional","subject":"qlik\\kalle"},{"type":"analyzer","subject":"qlik\\nalle"}'

Request

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

Response

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

Removes license access for the given users

Facts

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

Header Parameters

  • authorizationstring

    Authentication token

    format = "bearer"

Request Body

Required

application/json

List of assignments to delete.

  • application/jsonobject
    Show application/json properties
    • deletearray of objects
      Required
      Show delete properties
      • typestring
        Required

        Allotment type

      • subjectstring
        Required

        User subject

Responses

207

application/json

Processed. (The status of the individual assignments is found in the response body)

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Required
      Show data properties
      • codestring

        Error code

      • typestring

        Allotment type

      • titlestring

        Error title

      • statusinteger
        Required

        Response status

      • subjectstring

        Subject

400

application/json

Body is invalid or missing.

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

401

application/json

Unauthorized (invalid token).

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

403

application/json

Insufficient access

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

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

const https = require('https')
  const data = JSON.stringify({"delete":[{"type":"analyzer","subject":"qlik\\malik"}]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/licenses/assignments/actions/delete',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

qlik license assignment delete \
--delete='{"type":"analyzer","subject":"qlik\\malik"}'

Request

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

Response

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

Updates license access for the given users

Facts

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

Header Parameters

  • authorizationstring

    Authentication token

    format = "bearer"

Request Body

Required

application/json

List of assignments to update.

  • application/jsonobject
    Show application/json properties
    • updatearray of objects
      Required
      Show update properties
      • typestring

        Target assignment type.

      • subjectstring
        Required

        User subject, the current or the desired after the patch.

      • sourceTypestring

        Current assignment type.

      • sourceSubjectstring

        The current user subject, in case that should be patched.

Responses

207

application/json

Processed. (The status of the individual assignments is found in the response body)

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Required
      Show data properties
      • codestring

        Error code

      • typestring

        Target allotment type.

      • titlestring

        Error title

      • statusinteger
        Required

        HTTP status code indicating the result of the individual assignment operation. A value of 200 represents a successful update, while 201 indicates a new resource was created due to a subject update. Any 400-level status codes indicate an error.

      • subjectstring

        Target subject.

      • sourceTypestring

        Current allotment type.

      • sourceSubjectstring

        Current subject.

400

application/json

Body is invalid or missing.

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

401

application/json

Unauthorized (invalid token).

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

403

application/json

Insufficient access

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

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

const https = require('https')
  const data = JSON.stringify({"update":[{"type":"professional","subject":"qlik\\malik","sourceType":"analyzer"}]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/licenses/assignments/actions/update',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

qlik license assignment update \
--update='{"type":"professional","subject":"qlik\\malik","sourceType":"analyzer"}'

Request

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

Response

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

Retrieves license consumption for the current tenant

Facts

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

Header Parameters

  • authorizationstring

    Authentication token

    format = "bearer"

Query Parameters

  • filterstring

    The SCIM filter for the query. Filterable property is "endTime".

  • limitinteger

    The preferred number of entries to return.

    minimum = 1, maximum = 200, default = 200, format = int32, default = 200

  • pagestring

    The requested page.

  • sortstring

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

Responses

200

application/json

Successful

  • application/jsonobject
    Show application/json properties
    • dataarray of objects
      Required
      Show data properties
      • idstring

        ID

      • appIdstring

        App ID

      • userIdstring

        User ID

      • endTimestring

        Engine session end time.

      • durationstring

        Engine session duration.

      • sessionIdstring

        Engine session ID.

      • allotmentIdstring

        Allotment ID

      • minutesUsedinteger

        Analyzer capacity minutes consumed.

      • capacityUsedinteger

        Analyzer capacity chunks consumed.

      • licenseUsagestring

        License usage
    • linksobject
      Required
      Show links properties
      • nextobject
        Show next properties
        • hrefstring

          link
      • prevobject
        Show prev properties
        • hrefstring

          link

400

application/json

Bad request, malformed query.

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

401

application/json

Unauthorized (invalid token).

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

403

application/json

Insufficient access

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message
GET /v1/licenses/consumption 
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/consumption" \
-H "Authorization: Bearer <access_token>"

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

qlik license consumption ls

Response

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

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

Facts

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

Header Parameters

  • authorizationstring

    Authentication token.

    format = "bearer"

Responses

200

application/json

Licenses overview info.

  • application/jsonobject
    Show application/json properties
    • trialboolean
      Required

      Boolean indicating if it is a trial license.

    • validstring
      Required

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

    • originstring
      Required

      Origin of license key.

      Can be one of: "Internal""External"

    • statusstring
      Required

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

      Can be one of: "Ok""Blacklisted""Expired"

    • productstring
      Required

      The product the license is valid for.

    • updatedstring
      Required

      An ISO 8601 timestamp for when the license was last updated.

    • allotmentsarray of objects
      Required
      Show allotments properties
      • namestring
        Required

        Can be one of: "professional""analyzer""analyzer_time"

      • unitsinteger
        Required
      • overageinteger

        Overage value; -1 means unbounded overage.

      • unitsUsedinteger
        Required
      • usageClassstring
        Required
    • changeTimestring

      An ISO 8601 timestamp for when the license was last changed.

    • licenseKeystring
      Required
    • parametersarray of objects
      Required

      The license parameters.

      Show parameters properties
      • namestring
        Required

        Parameter set (provision) name.

      • validstring
        Required

        Time interval for parameter validity.

        pattern = "^(\.|\d{4}-\d{2}-\d{2})/(\.|\d{4}-\d{2}-\d{2})$"

      • accessobject

        Parameters for licenses to control access to the parameters.

        Show access properties
        • allotmentstring

          Name of an allotment that the user must have access to. to
      • valuesobject

        Parameter values
    • licenseTypestring
    • licenseNumberstring
      Required
    • latestValidTimestring

      An ISO 8601 timestamp for when the latest time the license has been known to be valid, a missing value indicates the indefinite future.

    • secondaryNumberstring
      Required

      The secondary number of a definition.

    • parentLicenseNumberstring

      the parent number of the license. can be shared by multiple license numbers

400

application/json

invalid tenant

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

401

application/json

Unauthorized (invalid token).

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

404

application/json

License not found.

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message
GET /v1/licenses/overview 
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/overview" \
-H "Authorization: Bearer <access_token>"

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

qlik license overview

Response

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

Get auto assign settings for tenant.

Facts

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

Header Parameters

  • authorizationstring

    Authentication token

    format = "bearer"

Responses

200

application/json

Auto assign settings.

  • application/jsonobject
    Show application/json properties
    • autoAssignAnalyzerboolean

      If analyzer users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available.

    • autoAssignProfessionalboolean

      If professional users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available.

400

application/json

Missing or invalid tenant.

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

401

application/json

Not allowed

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

403

application/json

Insufficient access

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message
GET /v1/licenses/settings 
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/settings" \
-H "Authorization: Bearer <access_token>"

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

qlik license settings ls

Response

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

Set auto assign settings for tenant

Facts

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

Header Parameters

  • authorizationstring

    Authentication token

    format = "bearer"

Request Body

application/json

Dynamic assignment settings for professional and analyzer users. If professional users and analyzer users are both set, professional users will be automatically assigned, if available. Otherwise, analyzer users will be assigned. If neither of those users are available, analyzer capacity will be assigned, if available.

  • application/jsonobject
    Show application/json properties
    • autoAssignAnalyzerboolean

      If analyzer users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available.

    • autoAssignProfessionalboolean

      If professional users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available.

Responses

200

application/json

Auto assign settings.

  • application/jsonobject
    Show application/json properties
    • autoAssignAnalyzerboolean

      If analyzer users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available.

    • autoAssignProfessionalboolean

      If professional users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available.

400

application/json

Missing or invalid tenant.

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

401

application/json

Action not allowed.

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

403

application/json

Insufficient access

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

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

const https = require('https')
  const data = JSON.stringify({"autoAssignAnalyzer":true,"autoAssignProfessional":false})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/licenses/settings',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

qlik license settings update \
--autoAssignAnalyzer=true

Request

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

Response

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

Gets the license status information of the current tenant

Facts

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

Header Parameters

  • authorizationstring

    Authentication token

    format = "bearer"

Responses

200

application/json

License status info.

  • application/jsonobject
    Show application/json properties
    • typestring
      Required

      Type of license key.

      Can be one of: "Signed""Plain"

    • trialboolean
      Required

      Boolean indicating if it is a trial license.

    • validstring
      Required

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

    • originstring
      Required

      Origin of license key.

      Can be one of: "Internal""External"

    • statusstring
      Required

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

      Can be one of: "Ok""Blacklisted""Expired""Missing"

    • productstring
      Required

      The product the license is valid for.

400

application/json

invalid tenant

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message

401

application/json

Unauthorized (invalid token).

  • application/jsonobject
    Show application/json properties
    • errorstringDeprecated
      Required

      Error type

    • errorsarray of objects
      Required
      Show errors properties
      • codestring
        Required

        Error code

      • titlestring
        Required

        Error title

      • detailstring

        Additional error detail.
    • messagestringDeprecated
      Required

      Error message
GET /v1/licenses/status 
curl "https://your-tenant.us.qlikcloud.com/api/v1/licenses/status" \
-H "Authorization: Bearer <access_token>"

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

qlik license status

Response

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