Roles
Tenant roles are assigned to users or groups in the tenant, and define what permissions they have.
Endpoints
Returns a list of roles using cursor-based pagination.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
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.
- nextstring
The next page cursor.
- prevstring
The previous page cursor.
- 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
application/json properties
- dataarray of objectsRequired
An array of roles.
data properties
- idstringRequired
The unique identifier for the role.
- namestringRequired
The name of the role.
- typestringRequired
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"
- linksobjectRequired
Contains links for the role.
links properties
- selfobjectRequired
self properties
- hrefstringRequired
Link to the role.
-
-
- canEditboolean
Indicate if role can be edited by tenant (Shown as Profile in MC)
- fullUserbooleanDeprecated
DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription.
- tenantIdstringRequired
The tenant unique identifier associated with the given Role.
- canDeleteboolean
Indicate if role can be deleted
- createdAtstringRequired
The timestamp for when the role was created.
- createdBystring
Id of user that created role
- updatedBystring
Id of user that last updated this role
- descriptionstringRequired
Descriptive text for the role.
- permissionsarray of strings
An array of permissions associated with the role.
- lastUpdatedAtstringRequired
The timestamp for when the role was last updated.
- 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.
-
- linksobjectRequired
Contains pagination links
links properties
- nextobject
Link to the next page of items
next properties
- hrefstringRequired
-
- prevobject
Link to the previous page of items
prev properties
- hrefstringRequired
-
- selfobjectRequired
Link to the current page of items
self properties
- hrefstringRequired
-
-
- 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.
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.
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.
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.
application/json properties
- errorsarray of objects
- traceIdstring
A unique identifier for tracing the error.
-
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 | manage |
Path Parameters
- idstringRequired
The role's unique identifier
Responses
200
application/json
Request successfully completed.
- application/jsonobject
application/json properties
- idstringRequired
The unique identifier for the role.
- namestringRequired
The name of the role.
- typestringRequired
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"
- linksobjectRequired
Contains links for the role.
links properties
- selfobjectRequired
self properties
- hrefstringRequired
Link to the role.
-
-
- canEditboolean
Indicate if role can be edited by tenant (Shown as Profile in MC)
- fullUserbooleanDeprecated
DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription.
- tenantIdstringRequired
The tenant unique identifier associated with the given Role.
- canDeleteboolean
Indicate if role can be deleted
- createdAtstringRequired
The timestamp for when the role was created.
- createdBystring
Id of user that created role
- updatedBystring
Id of user that last updated this role
- descriptionstringRequired
Descriptive text for the role.
- permissionsarray of strings
An array of permissions associated with the role.
- lastUpdatedAtstringRequired
The timestamp for when the role was last updated.
- 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.
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.
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.
application/json properties
- errorsarray of objects
- traceIdstring
A unique identifier for tracing the error.
-
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"
}