Roles

The resource representing a role in the system.

Endpoints

GET

/v1/roles
GET

/v1/roles/{id}

Returns a list of roles using cursor-based pagination.

Facts

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

Query Parameters

filterstring

The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. All conditional statements within this query parameter are case insensitive.
limitnumber

The number of roles to retrieve.

minimum = 1, maximum = 100, default = 20, default = 20
nextstring

The next page cursor.

format = "uid"
prevstring

The previous page cursor.

format = "uid"
sortstring

Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending.
totalResultsboolean

Determines wether to return a count of the total records matched in the query. Defaults to false.

Responses

200

application/json

An array of roles, and pagination links.

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  An array of roles.
  
  Show data properties
  
  idstring
  Required
  
  The unique identifier for the role.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the role.
  
  typestring
  Required
  
  The type of role.
  
  Can be one of: "default""custom"
  
  levelstring
  
  The level of access associated to the role.
  
  Can be one of: "admin""user"
  
  linksobject
  Required
  
  Contains links for the role.
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  Link to the role.
  
  format = "uri"
  
  canEditboolean
  
  Indicate if role can be edited by tenant (Shown as Profile in MC)
  
  default = false
  
  fullUserbooleanDeprecated
  
  DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription.
  
  tenantIdstring
  Required
  
  The tenant unique identifier associated with the given Role.
  
  format = "uid"
  
  canDeleteboolean
  
  Indicate if role can be deleted
  
  default = false
  
  createdAtstring
  Required
  
  The timestamp for when the role was created.
  
  format = "date-time"
  
  createdBystring
  
  Id of user that created role
  
  updatedBystring
  
  Id of user that last updated this role
  
  descriptionstring
  Required
  
  Descriptive text for the role.
  
  permissionsarray of strings
  
  An array of permissions associated with the role.
  
  lastUpdatedAtstring
  Required
  
  The timestamp for when the role was last updated.
  
  format = "date-time"
  
  assignedScopesarray of strings
  
  Selection of scopes added to this Role
  
  userEntitlementTypestring
  
  Indicate whether this role will trigger promotion of a user from a basic to a full user on tenants with a capacity-based subscription. Does not apply to tenants with a user-based subscription. Returns fullUser if it will trigger promotion.
- linksobject
  Required
  
  Contains pagination links
  
  Show links properties
  
  nextobject
  
  Link to the next page of items
  
  Show next properties
  
  hrefstring
  Required
  
  format = "uri"
  
  prevobject
  
  Link to the previous page of items
  
  Show prev properties
  
  hrefstring
  Required
  
  format = "uri"
  
  selfobject
  Required
  
  Link to the current page of items
  
  Show self properties
  
  hrefstring
  Required
  
  format = "uri"
- totalResultsinteger
  
  Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true.

400

application/json

Invalid request parameters for querying roles.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

401

application/json

Unauthorized, JWT is invalid or not provided.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal server error.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

GET /v1/roles

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

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

qlik role ls

Response

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Developer",
      "type": "default",
      "level": "admin",
      "links": {
        "self": {
          "href": "http://mytenant.us.qlikcloud.com/api/v1/roles/507f191e810c19729de860ea"
        }
      },
      "canEdit": false,
      "fullUser": true,
      "tenantId": "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f",
      "canDelete": false,
      "createdAt": "2021-03-21T17:32:28Z",
      "createdBy": "string",
      "updatedBy": "string",
      "description": "Grants permission to generate API keys",
      "permissions": [
        "edit_foo"
      ],
      "lastUpdatedAt": "2021-03-22T10:01:02Z",
      "assignedScopes": [
        "string"
      ],
      "userEntitlementType": "fullUser"
    }
  ],
  "links": {
    "next": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/roles?next=QaFdFYW6pImZvRgFaDyB1UffNgfs4mRd"
    },
    "prev": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/roles?prev=QaFdFYW6pImZvRgFaDyB1UffNgfs4mRd"
    },
    "self": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/roles"
    }
  },
  "totalResults": 42
}

Returns the requested role.

Facts

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

Path Parameters

idstring
Required

The role's unique identifier

Responses

200

application/json

Request successfully completed.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  The unique identifier for the role.
  
  format = "uid"
- namestring
  Required
  
  The name of the role.
- typestring
  Required
  
  The type of role.
  
  Can be one of: "default""custom"
- levelstring
  
  The level of access associated to the role.
  
  Can be one of: "admin""user"
- linksobject
  Required
  
  Contains links for the role.
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  Link to the role.
  
  format = "uri"
- canEditboolean
  
  Indicate if role can be edited by tenant (Shown as Profile in MC)
  
  default = false
- fullUserbooleanDeprecated
  
  DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription.
- tenantIdstring
  Required
  
  The tenant unique identifier associated with the given Role.
  
  format = "uid"
- canDeleteboolean
  
  Indicate if role can be deleted
  
  default = false
- createdAtstring
  Required
  
  The timestamp for when the role was created.
  
  format = "date-time"
- createdBystring
  
  Id of user that created role
- updatedBystring
  
  Id of user that last updated this role
- descriptionstring
  Required
  
  Descriptive text for the role.
- permissionsarray of strings
  
  An array of permissions associated with the role.
- lastUpdatedAtstring
  Required
  
  The timestamp for when the role was last updated.
  
  format = "date-time"
- assignedScopesarray of strings
  
  Selection of scopes added to this Role
- userEntitlementTypestring
  
  Indicate whether this role will trigger promotion of a user from a basic to a full user on tenants with a capacity-based subscription. Does not apply to tenants with a user-based subscription. Returns fullUser if it will trigger promotion.

404

application/json

Role ID not found or Invalid format.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal Server Error.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

GET /v1/roles/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/roles/{id}" \
-H "Authorization: Bearer <API-key>"

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

qlik role get <roleId>

Response

{
  "id": "507f191e810c19729de860ea",
  "name": "Developer",
  "type": "default",
  "level": "admin",
  "links": {
    "self": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/roles/507f191e810c19729de860ea"
    }
  },
  "canEdit": false,
  "fullUser": true,
  "tenantId": "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f",
  "canDelete": false,
  "createdAt": "2021-03-21T17:32:28Z",
  "createdBy": "string",
  "updatedBy": "string",
  "description": "Grants permission to generate API keys",
  "permissions": [
    "edit_foo"
  ],
  "lastUpdatedAt": "2021-03-22T10:01:02Z",
  "assignedScopes": [
    "string"
  ],
  "userEntitlementType": "fullUser"
}

Roles

Endpoints

List roles

Facts

Query Parameters

Responses

200

400

401

429

500

Response

Get role by ID

Facts

Path Parameters

Responses

200

404

429

500

Response