Groups

Groups is the resource representing a group in the system.

Endpoints

GET

/v1/groups
POST

/v1/groups
GET

/v1/groups/{groupId}
PATCH

/v1/groups/{groupId}
DELETE

/v1/groups/{groupId}
POST

/v1/groups/actions/filter
GET

/v1/groups/settings
PATCH

/v1/groups/settings

Returns a list of groups with cursor-based pagination.

Facts

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

Query Parameters

filterstring

The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive.
limitnumber

The number of groups 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.
systemGroupsboolean

Return system groups (e.g. Everyone) instead of regular groups. Cannot be combined with any other query parameters.

default = false
totalResultsboolean

Whether to return a total match count in the result. Defaults to false.

Responses

200

application/json

An array of groups, and pagination links.

A result object when listing groups.

application/jsonobject

A result object when listing groups.
Show application/json properties
- dataarray of objects
  
  An array of groups.
  
  Show data properties
  
  idstring
  Required
  
  The unique identifier for the group
  
  format = "uid"
  
  namestring
  Required
  
  The name of the group.
  
  minLength = 1, maxLength = 256
  
  linksobject
  Required
  
  Contains Links for current document
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  Link to the current group document
  
  format = "uri"
  
  statusstring
  Required
  
  The state of the group.
  
  Can be one of: "active""disabled"
  
  tenantIdstring
  Required
  
  The tenant identifier associated with the given group
  
  format = "uid"
  
  createdAtstring
  Required
  
  The timestamp for when the group record was created.
  
  format = "date-time"
  
  assignedRolesarray of objects
  
  An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  lastUpdatedAtstring
  Required
  
  The timestamp for when the group record was last updated.
  
  format = "date-time"
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  Link to the next page of items
  
  format = "uri"
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  Link to the previous page of items
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  Link to the current page of items
  
  format = "uri"
- 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 groups.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

401

application/json

Unauthorized, JWT is invalid or not provided.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

403

application/json

All operations failed due to insufficient permissions.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal server error.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

GET /v1/groups

curl "https://your-tenant.us.qlikcloud.com/api/v1/groups" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/groups',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik group ls

Response

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Development",
      "links": {
        "self": {
          "href": "http://mytenant.us.qlikcloud.com/api/v1/groups/507f191e810c19729de860ea"
        }
      },
      "status": "active",
      "tenantId": "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f",
      "createdAt": "2021-03-21T17:32:28Z",
      "assignedRoles": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "Developer",
          "type": "default",
          "level": "admin"
        }
      ],
      "lastUpdatedAt": "2021-03-22T10:01:02Z"
    }
  ],
  "links": {
    "next": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/groups?next=FgAAAAdfaWQAYF33ydumcVj1cawoAA"
    },
    "prev": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/groups?prev=FgAACAdfaWQAYF33ydumcVj1cawoAA"
    },
    "self": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/groups"
    }
  },
  "totalResults": 42
}

Creates a group. The maximum number of groups a tenant can have is 10,000.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Request Body

Required

application/json

application/jsonobject
Show application/json properties
- namestring
  Required
  
  The name of the group (maximum length of 256 characters).
- statusstring
  
  The status of the created group within the tenant. Defaults to active if empty.
  
  Can be one of: "active"
- assignedRolesarray
  
  The roles to assign to the group (limit of 100 roles per group).
  
  One of:
  
  AssignedRolesRefIDsarray of objects
  
  An array of role reference identifiers.
  
  Show AssignedRolesRefIDs properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  AssignedRolesRefNamesarray of objects
  
  An array of role reference names.
  
  Show AssignedRolesRefNames properties
  
  namestring
  Required
  
  The name of the role

Responses

201

application/json

Group was successfully created.

represents a Group document

application/jsonobject

represents a Group document
Show application/json properties
- idstring
  Required
  
  The unique identifier for the group
  
  format = "uid"
- namestring
  Required
  
  The name of the group.
  
  minLength = 1, maxLength = 256
- linksobject
  Required
  
  Contains Links for current document
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  Link to the current group document
  
  format = "uri"
- statusstring
  Required
  
  The state of the group.
  
  Can be one of: "active""disabled"
- tenantIdstring
  Required
  
  The tenant identifier associated with the given group
  
  format = "uid"
- createdAtstring
  Required
  
  The timestamp for when the group record was created.
  
  format = "date-time"
- assignedRolesarray of objects
  
  An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
- lastUpdatedAtstring
  Required
  
  The timestamp for when the group record was last updated.
  
  format = "date-time"

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

401

application/json

Unauthorized to create a group.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

403

application/json

Forbidden from creating a group.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

409

application/json

Name conflict when attempting to create a new group.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

413

application/json

Payload was too large.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal server error.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

POST /v1/groups

curl "https://your-tenant.us.qlikcloud.com/api/v1/groups" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"Development","status":"active","assignedRoles":[{"name":"Developer"}]}'

const https = require('https')
  const data = JSON.stringify({"name":"Development","status":"active","assignedRoles":[{"name":"Developer"}]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/groups',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "name": "Development",
  "status": "active",
  "assignedRoles": [
    {
      "name": "Developer"
    }
  ]
}

Response

{
  "id": "507f191e810c19729de860ea",
  "name": "Development",
  "links": {
    "self": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/groups/507f191e810c19729de860ea"
    }
  },
  "status": "active",
  "tenantId": "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f",
  "createdAt": "2021-03-21T17:32:28Z",
  "assignedRoles": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Developer",
      "type": "default",
      "level": "admin"
    }
  ],
  "lastUpdatedAt": "2021-03-22T10:01:02Z"
}

Returns the requested group.

Facts

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

Path Parameters

groupIdstring
Required

The group's unique identifier

Responses

200

application/json

Request successfully completed.

represents a Group document

application/jsonobject

represents a Group document
Show application/json properties
- idstring
  Required
  
  The unique identifier for the group
  
  format = "uid"
- namestring
  Required
  
  The name of the group.
  
  minLength = 1, maxLength = 256
- linksobject
  Required
  
  Contains Links for current document
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  Link to the current group document
  
  format = "uri"
- statusstring
  Required
  
  The state of the group.
  
  Can be one of: "active""disabled"
- tenantIdstring
  Required
  
  The tenant identifier associated with the given group
  
  format = "uid"
- createdAtstring
  Required
  
  The timestamp for when the group record was created.
  
  format = "date-time"
- assignedRolesarray of objects
  
  An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
- lastUpdatedAtstring
  Required
  
  The timestamp for when the group record was last updated.
  
  format = "date-time"

403

application/json

The operation failed due to insufficient permissions.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

404

application/json

Group 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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal Server Error.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

GET /v1/groups/{groupId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/{groupId}" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/groups/{groupId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik group get <groupId>

Response

{
  "id": "507f191e810c19729de860ea",
  "name": "Development",
  "links": {
    "self": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/groups/507f191e810c19729de860ea"
    }
  },
  "status": "active",
  "tenantId": "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f",
  "createdAt": "2021-03-21T17:32:28Z",
  "assignedRoles": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Developer",
      "type": "default",
      "level": "admin"
    }
  ],
  "lastUpdatedAt": "2021-03-22T10:01:02Z"
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Path Parameters

groupIdstring
Required

The ID of the group to update.

format = "uid"

Request Body

Required

application/json

An array of JSON Patches for a group.

application/jsonarray of objects

An array of JSON Patches for a group.
Show application/json properties
- opstring
  Required
  
  The operation to be performed. Currently "replace" is the only supported operation.
  
  Can be one of: "replace"
- pathstring
  Required
  
  Attribute name of a field of the Groups entity.
  
  Can be one of: "assignedRoles"
- valuearray
  Required
  
  The roles to assign to the group (limit of 100 roles per group).
  
  One of:
  
  AssignedRolesRefIDsarray of objects
  
  An array of role reference identifiers.
  
  Show AssignedRolesRefIDs properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  AssignedRolesRefNamesarray of objects
  
  An array of role reference names.
  
  Show AssignedRolesRefNames properties
  
  namestring
  Required
  
  The name of the role

Responses

204

Group updated successfully.

400

application/json

Invalid request for patching a user.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

401

application/json

Unauthorized to patch a group.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

403

application/json

Forbidden from patching a group.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

404

application/json

Group was not found.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal server error.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

PATCH /v1/groups/{groupId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/{groupId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"replace","path":"/assignedRoles","value":[{"name":"TenantAdmin"},{"name":"AnalyticsAdmin"}]}]'

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/assignedRoles","value":[{"name":"TenantAdmin"},{"name":"AnalyticsAdmin"}]}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/groups/{groupId}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

[
  {
    "op": "replace",
    "path": "/assignedRoles",
    "value": [
      {
        "name": "TenantAdmin"
      },
      {
        "name": "AnalyticsAdmin"
      }
    ]
  }
]

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Path Parameters

groupIdstring
Required

The ID of the group to delete.

format = "uid"

Responses

204

Group deleted successfully.

401

application/json

Unauthorized.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

404

application/json

Group 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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

DELETE /v1/groups/{groupId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/{groupId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/groups/{groupId}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik group rm <groupId>

Retrieves a list of groups matching the filter using advanced query string.

Facts

Rate limit	Special (200 requests per minute)
Categories	externalmanage

Query Parameters

limitnumber

The number of user entries to retrieve.

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

Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with prev.
prevstring

Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with next.
sortstring

The field to sort by, with +/- prefix indicating sort order

Can be one of: "name""+name""-name"

default = "+name"

Request Body

application/json

Will contain the query filter to apply. It shall not contain more than 100 ids.

An advanced query filter to be used for complex user querying in the tenant.

application/jsonobject

An advanced query filter to be used for complex user querying in the tenant.
Show application/json properties
- filterstring
  
  The advanced filtering to be applied the query. All conditional statements within this query parameter are case insensitive.

Responses

200

application/json

Groups retrieved.

A result object when listing groups.

application/jsonobject

A result object when listing groups.
Show application/json properties
- dataarray of objects
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  Link to the next page of items
  
  format = "uri"
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  Link to the previous page of items
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  Link to the current page of items
  
  format = "uri"
- totalResultsinteger
  
  Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true.

400

application/json

Advanced query filter syntax error or query params format error or filter too complex.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

401

application/json

Unauthorized, JWT 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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

403

application/json

The operation failed due to insufficient permissions.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal server error.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

POST /v1/groups/actions/filter

curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/actions/filter" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"filter":"(id eq \"626949b9017b657805080bbd\" or id eq \"626949bf017b657805080bbe\") and (status eq \"active\" or status eq \"deleted\")"}'

const https = require('https')
  const data = JSON.stringify({"filter":"(id eq \"626949b9017b657805080bbd\" or id eq \"626949bf017b657805080bbe\") and (status eq \"active\" or status eq \"deleted\")"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/groups/actions/filter',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik group filter \
--filter="(id eq "626949b9017b657805080bbd" or id eq "626949bf017b657805080bbe") and (status eq "active" or status eq "deleted")"

Request

{
  "filter": "(id eq \"626949b9017b657805080bbd\" or id eq \"626949bf017b657805080bbe\") and (status eq \"active\" or status eq \"deleted\")"
}

Response

{
  "data": [
    {}
  ],
  "links": {
    "next": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/groups?next=FgAAAAdfaWQAYF33ydumcVj1cawoAA"
    },
    "prev": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/groups?prev=FgAACAdfaWQAYF33ydumcVj1cawoAA"
    },
    "self": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/groups"
    }
  },
  "totalResults": 42
}

Returns the active tenant's group settings.

Facts

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

Responses

200

application/json

The requested tenant's group settings.

represents a GroupSetting document

application/jsonobject

represents a GroupSetting document
Show application/json properties
- linksobject
  Required
  
  Contains Links for current document
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  Link to the current group settings document
  
  format = "uri"
- tenantIdstring
  Required
  
  The unique tenant identifier.
  
  format = "uid"
- systemGroupsobject
  
  Show systemGroups properties
  
  000000000000000000000001object
  
  Show 000000000000000000000001 properties
  
  idstring
  
  The ID of the Everyone group. This value will not change and is immutable.
  
  Can be one of: "000000000000000000000001"
  
  namestring
  
  The name of the Everyone group. This value will not change and is immutable.
  
  Can be one of: "com.qlik.Everyone"
  
  enabledboolean
  
  For Everyone, this is always true and can't be patched.
  
  default = true
  
  createdAtstring
  
  The timestamp for when the Everyone group was created.
  
  format = "date-time"
  
  assignedRolesarray of objects
  
  An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  lastUpdatedAtstring
  
  The timestamp for when the Everyone group was last updated.
  
  format = "date-time"
- syncIdpGroupsboolean
  Required
  
  Determines if groups should be created on login.
- autoCreateGroupsboolean
  Required
  
  Determines if groups should be created on login.

401

application/json

Not authorized.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

403

application/json

The operation failed due to insufficient permissions.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal server error.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

GET /v1/groups/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/settings" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/groups/settings',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik group settings ls

Response

{
  "links": {
    "self": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/groups/settings"
    }
  },
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "systemGroups": {
    "000000000000000000000001": {
      "id": "000000000000000000000001",
      "name": "com.qlik.Everyone",
      "enabled": true,
      "createdAt": "2021-03-22T10:01:02Z",
      "assignedRoles": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "Developer",
          "type": "default",
          "level": "admin"
        }
      ],
      "lastUpdatedAt": "2021-03-22T10:01:02Z"
    }
  },
  "syncIdpGroups": false,
  "autoCreateGroups": false
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Request Body

Required

application/json

An array of JSON Patches for the groups settings.

application/jsonarray of objects

An array of JSON Patches for the groups settings.
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  A JSON Pointer.
  
  Can be one of: "/autoCreateGroups""/syncIdpGroups""/systemGroups/{id}/assignedRoles"
- valueboolean|array
  Required
  
  The value to be used for this operation.
  
  One of:
  
  boolean
  
  AssignedRolesRefIDsarray of objects
  
  An array of role reference identifiers.
  
  Show AssignedRolesRefIDs properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  AssignedRolesRefNamesarray of objects
  
  An array of role reference names.
  
  Show AssignedRolesRefNames properties
  
  namestring
  Required
  
  The name of the role

Responses

204

Config updated successfully.

400

application/json

Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

401

application/json

Not authorized.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

403

application/json

The operation failed due to insufficient permissions.

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.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

429

application/json

Request has been rate limited.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

500

application/json

Internal server error.

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

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

PATCH /v1/groups/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/settings" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"replace","path":"/syncIdpGroups","value":true},{"op":"replace","path":"/autoCreateGroups","value":true},{"op":"replace","path":"/systemGroups/000000000000000000000001/assignedRoles","value":[{"name":"Steward"}]}]'

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/syncIdpGroups","value":true},{"op":"replace","path":"/autoCreateGroups","value":true},{"op":"replace","path":"/systemGroups/000000000000000000000001/assignedRoles","value":[{"name":"Steward"}]}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/groups/settings',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik group settings patch \
--body='[{"op":"replace","path":"/syncIdpGroups","value":true},{"op":"replace","path":"/autoCreateGroups","value":true},{"op":"replace","path":"/systemGroups/000000000000000000000001/assignedRoles","value":[{"name":"Steward"}]}]'

Request

[
  {
    "op": "replace",
    "path": "/syncIdpGroups",
    "value": true
  },
  {
    "op": "replace",
    "path": "/autoCreateGroups",
    "value": true
  },
  {
    "op": "replace",
    "path": "/systemGroups/000000000000000000000001/assignedRoles",
    "value": [
      {
        "name": "Steward"
      }
    ]
  }
]

Groups

Endpoints

List groups.

Facts

Query Parameters

Responses

200

400

401

403

429

500

Response

Create group.

Facts

Request Body

Responses

201

400

401

403

409

413

429

500

Request

Response

Get group by id

Facts

Path Parameters

Responses

200

403

404

429

500

Response

Update group by id

Facts

Path Parameters

Request Body

Responses

204

400

401

403

404

429

500

Request

Delete group by id

Facts

Path Parameters

Responses

204

401

404

429

Filter groups

Facts

Query Parameters

Request Body

Responses

200

400

401

403

429

500

Request

Response

Get group settings

Facts

Responses

200

401

403

429

500

Response