Sign in
roles

List roles

Returns a list of roles using cursor-based pagination.

get/api/v1/roles

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 uid
Example:507f191e810c19729de860ea

The next page cursor.

prevstring uid
Example:507f191e810c19729de86gea

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.

Response

An array of roles, and pagination links.

totalResultsinteger

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

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"
        }
      },
      "tenantId": "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f",
      "createdAt": "2021-03-21T17:32:28Z",
      "description": "Grants permission to edit resource 'foo'",
      "permissions": [
        "edit_foo"
      ],
      "lastUpdatedAt": "2021-03-22T10:01:02Z",
      "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"
    }
  }
}

Changes