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
- idstringRequiredFilterable
The unique identifier for the role.
- namestringRequiredFilterable
The name of the role.
- typestringRequiredFilterable
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.
- tenantIdstringRequiredFilterable
The tenant unique identifier associated with the given Role.
- canDeleteboolean
Indicate if role can be deleted
- createdAtstringRequiredFilterable
The timestamp for when the role was created.
- createdBystring
Id of user that created role
- updatedBystring
Id of user that last updated this role
- descriptionstringRequiredFilterable
Descriptive text for the role.
- permissionsarray of strings
An array of permissions associated with the role.
- lastUpdatedAtstringRequiredFilterable
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/roles" \-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/roles', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } 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}
Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the TenantAdmin
role.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Request Body
Requiredapplication/json
- application/jsonobject
application/json properties
- namestringRequired
Role name, needs to be unique
- descriptionstring
Role description
- assignedScopesarray of strings
Selection of scopes to assign to role
-
Responses
201
application/json
Created
- application/jsonobject
application/json properties
- idstringRequiredFilterable
The unique identifier for the role.
- namestringRequiredFilterable
The name of the role.
- typestringRequiredFilterable
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.
- tenantIdstringRequiredFilterable
The tenant unique identifier associated with the given Role.
- canDeleteboolean
Indicate if role can be deleted
- createdAtstringRequiredFilterable
The timestamp for when the role was created.
- createdBystring
Id of user that created role
- updatedBystring
Id of user that last updated this role
- descriptionstringRequiredFilterable
Descriptive text for the role.
- permissionsarray of strings
An array of permissions associated with the role.
- lastUpdatedAtstringRequiredFilterable
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.
-
400
application/json
Invalid request was made.
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
401
application/json
Unauthorized to create role.
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
403
application/json
Forbidden from creating role.
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/roles" \-X POST \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '{"name":"string","description":"string","assignedScopes":["string"]}'
const https = require('https') const data = JSON.stringify({"name":"string","description":"string","assignedScopes":["string"]}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/roles', 'method': 'POST', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "name": "string", "description": "string", "assignedScopes": [ "string" ]}
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"}
Returns the requested role.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Path Parameters
- idstringRequiredFilterable
The unique identifier for the role.
Responses
200
application/json
Request successfully completed.
- application/jsonobject
application/json properties
- idstringRequiredFilterable
The unique identifier for the role.
- namestringRequiredFilterable
The name of the role.
- typestringRequiredFilterable
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.
- tenantIdstringRequiredFilterable
The tenant unique identifier associated with the given Role.
- canDeleteboolean
Indicate if role can be deleted
- createdAtstringRequiredFilterable
The timestamp for when the role was created.
- createdBystring
Id of user that created role
- updatedBystring
Id of user that last updated this role
- descriptionstringRequiredFilterable
Descriptive text for the role.
- permissionsarray of strings
An array of permissions associated with the role.
- lastUpdatedAtstringRequiredFilterable
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/roles/{id}" \-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/roles/{id}', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } 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"}
Updates the requested role. Only applicable to roles of type custom
. Requestor must be assigned the TenantAdmin
role.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- idstringRequiredFilterable
The unique identifier for the role.
Request Body
Requiredapplication/json
An array of JSON Patch documents
- application/jsonarray of objects
An array of JSON Patch documents
application/json properties
- opstringRequired
Can be one of: "replace""add""remove-value"
- pathstringRequired
Can be one of: "/name""/description""/assignedScopes""/assignedScopes/-"
- valuestring|arrayRequiredOne of:
- string
- array of strings
-
-
Responses
204
Updated
400
application/json
Invalid request was made.
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
401
application/json
Unauthorized to update role.
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
403
application/json
Forbidden from updating role.
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/roles/{id}" \-X PATCH \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '[{"op":"replace","path":"/name","value":"Role1"},{"op":"replace","path":"/assignedScopes","value":["knowledgebase"]},{"op":"add","path":"/assignedScopes/-","value":"knowledgebase"},{"op":"remove-value","path":"/assignedScopes","value":"knowledgebase"},{"op":"replace","path":"/description","value":"My custom role description"}]'
const https = require('https') const data = JSON.stringify([{"op":"replace","path":"/name","value":"Role1"},{"op":"replace","path":"/assignedScopes","value":["knowledgebase"]},{"op":"add","path":"/assignedScopes/-","value":"knowledgebase"},{"op":"remove-value","path":"/assignedScopes","value":"knowledgebase"},{"op":"replace","path":"/description","value":"My custom role description"}]) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/roles/{id}', 'method': 'PATCH', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
[ { "op": "replace", "path": "/name", "value": "Role1" }, { "op": "replace", "path": "/assignedScopes", "value": [ "knowledgebase" ] }, { "op": "add", "path": "/assignedScopes/-", "value": "knowledgebase" }, { "op": "remove-value", "path": "/assignedScopes", "value": "knowledgebase" }, { "op": "replace", "path": "/description", "value": "My custom role description" }]
Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type custom
. Requestor must be assigned the TenantAdmin
role.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- idstringRequiredFilterable
The unique identifier for the role.
Responses
204
Deleted successfully.
400
application/json
Invalid request was made.
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
401
application/json
Unauthorized to delete role.
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
403
application/json
Forbidden from deleting role.
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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- 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
An array of errors related to the operation.
errors properties
- codestringRequired
The error code.
- metaobject
Additional properties relating to the error.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
- sourceobject
References to the source of the error.
source properties
- pointerstring
A JSON Pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
-
- traceIdstring
A unique identifier for tracing the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/roles/{id}" \-X DELETE \-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/roles/{id}', 'method': 'DELETE', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli