Roles

Tenant roles are assigned to users or groups in the tenant, and define what permissions they have.

Download OpenAPI spec

List roles

Returns a list of roles using cursor-based pagination.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • filter string

    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.

  • limit number

    The number of roles to retrieve.

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

  • next string

    The next page cursor.

    format = "uid"

  • prev string

    The previous page cursor.

    format = "uid"

  • sort string

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

  • totalResults boolean

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

Responses

200

An array of roles, and pagination links.

  • application/json object
    Show application/json properties
    • data array of objects
      Required

      An array of roles.

      Show data properties
      • id string
        Required Filterable

        The unique identifier for the role.

        format = "uid"

      • name string
        Required Filterable

        The name of the role.

      • type string
        Required Filterable

        The type of role.

        Can be one of: "default""custom"

      • level string

        The level of access associated to the role.

        Can be one of: "admin""user"

      • links object
        Required

        Contains links for the role.

        Show links properties
        • self object
          Required
          Show self properties
          • href string
            Required

            Link to the role.

            format = "uri"

      • canEdit boolean

        Indicate if role can be edited by tenant (Shown as Profile in MC)

        default = false

      • fullUser boolean Deprecated

        DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription.

      • tenantId string
        Required Filterable

        The tenant unique identifier associated with the given Role.

        format = "uid"

      • canDelete boolean

        Indicate if role can be deleted

        default = false

      • createdAt string
        Required Filterable

        The timestamp for when the role was created.

        format = "date-time"

      • createdBy string

        Id of user that created role

      • updatedBy string

        Id of user that last updated this role

      • description string
        Required Filterable

        Descriptive text for the role.

      • permissions array of strings

        An array of permissions associated with the role.

      • lastUpdatedAt string
        Required Filterable

        The timestamp for when the role was last updated.

        format = "date-time"

      • assignedScopes array of strings

        Selection of scopes added to this Role

      • userEntitlementType string

        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.
    • links object
      Required

      Contains pagination links

      Show links properties
      • next object

        Link to the next page of items

        Show next properties
        • href string
          Required

          format = "uri"

      • prev object

        Link to the previous page of items

        Show prev properties
        • href string
          Required

          format = "uri"

      • self object
        Required

        Link to the current page of items

        Show self properties
        • href string
          Required

          format = "uri"

    • totalResults integer

      Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true.

400

Invalid request parameters for querying roles.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

401

Unauthorized, JWT is invalid or not provided.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

500

Internal server error.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.
GET /api/v1/roles 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.roles.getRoles({})
qlik role ls
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/roles" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "My Custom Role",
      "type": "custom",
      "level": "user",
      "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 edit resource 'foo'",
      "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
}

Create role

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)

Request Body

Required
  • application/json object
    Show application/json properties
    • name string
      Required

      Role name, needs to be unique

    • description string

      Role description

    • assignedScopes array of strings

      Selection of scopes to assign to role

Responses

201

Created

  • application/json object
    Show application/json properties
    • id string
      Required Filterable

      The unique identifier for the role.

      format = "uid"

    • name string
      Required Filterable

      The name of the role.

    • type string
      Required Filterable

      The type of role.

      Can be one of: "default""custom"

    • level string

      The level of access associated to the role.

      Can be one of: "admin""user"

    • links object
      Required

      Contains links for the role.

      Show links properties
      • self object
        Required
        Show self properties
        • href string
          Required

          Link to the role.

          format = "uri"

    • canEdit boolean

      Indicate if role can be edited by tenant (Shown as Profile in MC)

      default = false

    • fullUser boolean Deprecated

      DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription.

    • tenantId string
      Required Filterable

      The tenant unique identifier associated with the given Role.

      format = "uid"

    • canDelete boolean

      Indicate if role can be deleted

      default = false

    • createdAt string
      Required Filterable

      The timestamp for when the role was created.

      format = "date-time"

    • createdBy string

      Id of user that created role

    • updatedBy string

      Id of user that last updated this role

    • description string
      Required Filterable

      Descriptive text for the role.

    • permissions array of strings

      An array of permissions associated with the role.

    • lastUpdatedAt string
      Required Filterable

      The timestamp for when the role was last updated.

      format = "date-time"

    • assignedScopes array of strings

      Selection of scopes added to this Role

    • userEntitlementType string

      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

Invalid request was made.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

401

Unauthorized to create role.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

403

Forbidden from creating role.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

500

Internal server error.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.
POST /api/v1/roles 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.roles.createRole({
  assignedScopes: ['string'],
  description: 'string',
  name: 'string',
})
qlik role create \
  --name 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/roles" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","description":"string","assignedScopes":["string"]}'

Example Response

{
  "id": "507f191e810c19729de860ea",
  "name": "My Custom Role",
  "type": "custom",
  "level": "user",
  "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 edit resource 'foo'",
  "permissions": [
    "edit_foo"
  ],
  "lastUpdatedAt": "2021-03-22T10:01:02Z",
  "assignedScopes": [
    "string"
  ],
  "userEntitlementType": "fullUser"
}

Get role by ID

Returns the requested role.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • id string
    Required Filterable

    The unique identifier for the role.

    format = "uid"

Responses

200

Request successfully completed.

  • application/json object
    Show application/json properties
    • id string
      Required Filterable

      The unique identifier for the role.

      format = "uid"

    • name string
      Required Filterable

      The name of the role.

    • type string
      Required Filterable

      The type of role.

      Can be one of: "default""custom"

    • level string

      The level of access associated to the role.

      Can be one of: "admin""user"

    • links object
      Required

      Contains links for the role.

      Show links properties
      • self object
        Required
        Show self properties
        • href string
          Required

          Link to the role.

          format = "uri"

    • canEdit boolean

      Indicate if role can be edited by tenant (Shown as Profile in MC)

      default = false

    • fullUser boolean Deprecated

      DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription.

    • tenantId string
      Required Filterable

      The tenant unique identifier associated with the given Role.

      format = "uid"

    • canDelete boolean

      Indicate if role can be deleted

      default = false

    • createdAt string
      Required Filterable

      The timestamp for when the role was created.

      format = "date-time"

    • createdBy string

      Id of user that created role

    • updatedBy string

      Id of user that last updated this role

    • description string
      Required Filterable

      Descriptive text for the role.

    • permissions array of strings

      An array of permissions associated with the role.

    • lastUpdatedAt string
      Required Filterable

      The timestamp for when the role was last updated.

      format = "date-time"

    • assignedScopes array of strings

      Selection of scopes added to this Role

    • userEntitlementType string

      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

Role ID not found or Invalid format.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

500

Internal Server Error.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.
GET /api/v1/roles/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.roles.getRole(
  '507f191e810c19729de860ea',
)
qlik role get '507f191e810c19729de860ea'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/roles/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "507f191e810c19729de860ea",
  "name": "My Custom Role",
  "type": "custom",
  "level": "user",
  "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 edit resource 'foo'",
  "permissions": [
    "edit_foo"
  ],
  "lastUpdatedAt": "2021-03-22T10:01:02Z",
  "assignedScopes": [
    "string"
  ],
  "userEntitlementType": "fullUser"
}

Update role by ID

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)

Path Parameters

  • id string
    Required Filterable

    The unique identifier for the role.

    format = "uid"

Request Body

Required
  • application/json array of objects

    An array of JSON Patch documents

    Show application/json properties
    • op string
      Required

      Can be one of: "replace""add""remove-value"

    • path string
      Required

      Can be one of: "/name""/description""/assignedScopes""/assignedScopes/-"

    • value string|array
      Required
      One of:
      • string
      • array of strings

Responses

204

Updated

400

Invalid request was made.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

401

Unauthorized to update role.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

403

Forbidden from updating role.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

404

Role ID not found or Invalid format.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

500

Internal server error.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.
PATCH /api/v1/roles/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.roles.patchRole(
  '507f191e810c19729de860ea',
  [
    {
      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',
    },
  ],
)
qlik role patch '507f191e810c19729de860ea' \
  --op 'replace' \
  --path '/name' \
  --value 'Role1'
curl "https://{tenant}.{region}.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"}]'

Delete role by ID

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)

Path Parameters

  • id string
    Required Filterable

    The unique identifier for the role.

    format = "uid"

Responses

204

Deleted successfully.

400

Invalid request was made.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

401

Unauthorized to delete role.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

403

Forbidden from deleting role.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.

500

Internal server error.

  • application/json object

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

    Show application/json properties
    • errors array of objects

      An array of errors related to the operation.

      Show errors properties
      • code string
        Required

        The error code.

      • meta object

        Additional properties relating to the error.

      • title string
        Required

        Summary of the problem.

      • detail string

        A human-readable explanation specific to this occurrence of the problem.

      • source object

        References to the source of the error.

        Show source properties
        • pointer string

          A JSON Pointer to the property that caused the error.

        • parameter string

          The URI query parameter that caused the error.
    • traceId string

      A unique identifier for tracing the error.
DELETE /api/v1/roles/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.roles.deleteRole(
  '507f191e810c19729de860ea',
)
qlik role rm '507f191e810c19729de860ea'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/roles/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"