Roles

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

Download specification

List roles

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.

    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

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
        RequiredFilterable

        The unique identifier for the role.

        format = "uid"

      • namestring
        RequiredFilterable

        The name of the role.

      • typestring
        RequiredFilterable

        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
        RequiredFilterable

        The tenant unique identifier associated with the given Role.

        format = "uid"

      • canDeleteboolean

        Indicate if role can be deleted

        default = false

      • createdAtstring
        RequiredFilterable

        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
        RequiredFilterable

        Descriptive text for the role.

      • permissionsarray of strings

        An array of permissions associated with the role.

      • lastUpdatedAtstring
        RequiredFilterable

        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

Invalid request parameters for querying roles.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Unauthorized, JWT is invalid or not provided.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Internal server error.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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.
GET /api/v1/roles 
import { createQlikApi } from '@qlik/api'


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


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

Example 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
}

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)
Categories manage

Request Body

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

      Role name, needs to be unique

    • descriptionstring

      Role description

    • assignedScopesarray of strings

      Selection of scopes to assign to role

Responses

201

Created

  • application/jsonobject
    Show application/json properties
    • idstring
      RequiredFilterable

      The unique identifier for the role.

      format = "uid"

    • namestring
      RequiredFilterable

      The name of the role.

    • typestring
      RequiredFilterable

      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
      RequiredFilterable

      The tenant unique identifier associated with the given Role.

      format = "uid"

    • canDeleteboolean

      Indicate if role can be deleted

      default = false

    • createdAtstring
      RequiredFilterable

      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
      RequiredFilterable

      Descriptive text for the role.

    • permissionsarray of strings

      An array of permissions associated with the role.

    • lastUpdatedAtstring
      RequiredFilterable

      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.

400

Invalid request was made.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Unauthorized to create role.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Forbidden from creating role.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Internal server error.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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.
POST /api/v1/roles 
import { createQlikApi } from '@qlik/api'


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


await qlik.roles.createRole({
  assignedScopes: ['string'],
  description: 'string',
  name: 'string',
})
qlik role create \
--assignedScopes='"string"' \
--description="string" \
--name="string"
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"]}'

Example 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"
}

Get role by ID

Returns the requested role.

Facts

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

Path Parameters

  • idstring
    RequiredFilterable

    The unique identifier for the role.

    format = "uid"

Responses

200

Request successfully completed.

  • application/jsonobject
    Show application/json properties
    • idstring
      RequiredFilterable

      The unique identifier for the role.

      format = "uid"

    • namestring
      RequiredFilterable

      The name of the role.

    • typestring
      RequiredFilterable

      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
      RequiredFilterable

      The tenant unique identifier associated with the given Role.

      format = "uid"

    • canDeleteboolean

      Indicate if role can be deleted

      default = false

    • createdAtstring
      RequiredFilterable

      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
      RequiredFilterable

      Descriptive text for the role.

    • permissionsarray of strings

      An array of permissions associated with the role.

    • lastUpdatedAtstring
      RequiredFilterable

      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

Role ID not found or Invalid format.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Internal Server Error.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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.
GET /api/v1/roles/{id} 
import { createQlikApi } from '@qlik/api'


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


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

Example 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"
}

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)
Categories manage

Path Parameters

  • idstring
    RequiredFilterable

    The unique identifier for the role.

    format = "uid"

Request Body

Required
  • application/jsonarray of objects

    An array of JSON Patch documents

    Show application/json properties
    • opstring
      Required

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

    • pathstring
      Required

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

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

Responses

204

Updated

400

Invalid request was made.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Unauthorized to update role.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Forbidden from updating role.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Role ID not found or Invalid format.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Internal server error.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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.
PATCH /api/v1/roles/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.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 <roleId> \
--body='[{"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"}]'
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"}]'

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)
Categories manage

Path Parameters

  • idstring
    RequiredFilterable

    The unique identifier for the role.

    format = "uid"

Responses

204

Deleted successfully.

400

Invalid request was made.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Unauthorized to delete role.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Forbidden from deleting role.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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

Internal server error.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show 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.
DELETE /api/v1/roles/{id} 
import { createQlikApi } from '@qlik/api'


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


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