Endpoints
Skip to sectionGET | /v1/groups |
GET | /v1/groups/{groupId} |
DELETE | /v1/groups/{groupId} |
POST | /v1/groups/actions/filter |
GET | /v1/groups/settings |
PATCH | /v1/groups/settings |
List groups.
Returns a list of groups with cursor-based pagination.
Query Parameters GET /v1/groups
filter string | 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. |
limit default=20, minimum=1, maximum=100 number | The number of groups to retrieve. |
next string<uuid> | The next page cursor. |
prev string<uuid> | The previous page cursor. |
sort string | Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. |
totalResults boolean | Whether to return a total match count in the result. Defaults to false. |
Responses GET /v1/groups
200 application/json | An array of groups, and pagination links. |
400 application/json | Invalid request parameters for querying groups. |
401 application/json | Unauthorized, JWT is invalid or not provided. |
403 application/json | All operations failed due to insufficient permissions. |
429 application/json | Request has been rate limited. |
500 application/json | Internal server error. |
GET/v1/groups
curl "https://your-tenant.us.qlikcloud.com/api/v1/groups" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/groups
{
"data": [
{
"id": "507f191e810c19729de860ea",
"name": "Development",
"idpId": "4ecbe7f9e8c1c9092c000027",
"links": {
"self": {
"href": "http://mytenant.us.qlikcloud.com/api/v1/groups/507f191e810c19729de860ea"
}
},
"status": "active",
"tenantId": "12345678-1234-5678-1234-567812345678",
"createdAt": "2021-03-21T17:32:28Z",
"assignedRoles": [
{
"id": "507f191e810c19729de860ea",
"name": "Developer",
"type": "default",
"level": "admin",
"permissions": [
"app:create"
]
}
],
"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": 0
}
Get group by id
Returns the requested group.
Path Parameters GET /v1/groups/{groupId}
groupId string | The group's unique identifier |
Responses GET /v1/groups/{groupId}
200 application/json | Request successfully completed. |
403 application/json | The operation failed due to insufficient permissions. |
404 application/json | Group ID not found or Invalid format. |
429 application/json | Request has been rate limited. |
500 application/json | Internal Server Error. |
GET/v1/groups/{groupId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/{groupId}" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/groups/{groupId}
{
"id": "507f191e810c19729de860ea",
"name": "Development",
"idpId": "4ecbe7f9e8c1c9092c000027",
"links": {
"self": {
"href": "http://mytenant.us.qlikcloud.com/api/v1/groups/507f191e810c19729de860ea"
}
},
"status": "active",
"tenantId": "12345678-1234-5678-1234-567812345678",
"createdAt": "2021-03-21T17:32:28Z",
"assignedRoles": [
{
"id": "507f191e810c19729de860ea",
"name": "Developer",
"type": "default",
"level": "admin",
"permissions": [
"app:create"
]
}
],
"lastUpdatedAt": "2021-03-22T10:01:02Z"
}
Delete group by id
Path Parameters DELETE /v1/groups/{groupId}
groupId string<uid> | The ID of the group to delete. |
Responses DELETE /v1/groups/{groupId}
204 object | Group deleted successfully. |
401 application/json | Unauthorized. |
404 application/json | Group ID not found or Invalid format. |
429 application/json | Request has been rate limited. |
DELETE/v1/groups/{groupId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/{groupId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
Filter groups
Retrieves a list of groups matching the filter using advanced query string.
Query Parameters POST /v1/groups/actions/filter
limit optional, default=20, minimum=1, maximum=100 number | The number of user entries to retrieve. |
next optional string | Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with prev. |
prev optional string | Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with next. |
sort optional, default='+name' string | The field to sort by, with +/- prefix indicating sort order Enum: name +name -name |
Request Body POST /v1/groups/actions/filter
application/json | Will contain the query filter to apply. It shall not contain more than 50 ids. |
Responses POST /v1/groups/actions/filter
200 application/json | Groups retrieved. |
400 application/json | Advanced query filter syntax error or query params format error or filter too complex. |
401 application/json | Unauthorized, JWT invalid or not provided. |
403 application/json | The operation failed due to insufficient permissions. |
429 application/json | Request has been rate limited. |
500 application/json | Internal server error. |
POST/v1/groups/actions/filter
curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/actions/filter" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"filter":"(id eq \"626949b9017b657805080bbd\" or id eq \"626949bf017b657805080bbe\") and (status eq \"active\" or status eq \"deleted\")"}'
Request POST /v1/groups/actions/filter
{
"filter": "(id eq \"626949b9017b657805080bbd\" or id eq \"626949bf017b657805080bbe\") and (status eq \"active\" or status eq \"deleted\")"
}
Response POST /v1/groups/actions/filter
{
"data": [
{
"id": "507f191e810c19729de860ea",
"name": "Development",
"idpId": "4ecbe7f9e8c1c9092c000027",
"links": {
"self": {
"href": "http://mytenant.us.qlikcloud.com/api/v1/groups/507f191e810c19729de860ea"
}
},
"status": "active",
"tenantId": "12345678-1234-5678-1234-567812345678",
"createdAt": "2021-03-21T17:32:28Z",
"assignedRoles": [
{
"id": "507f191e810c19729de860ea",
"name": "Developer",
"type": "default",
"level": "admin",
"permissions": [
"app:create"
]
}
],
"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": 0
}
Get group settings
Returns the active tenant's group settings.
Responses GET /v1/groups/settings
200 application/json | The requested tenant's group settings. |
401 application/json | Not authorized. |
403 application/json | The operation failed due to insufficient permissions. |
429 application/json | Request has been rate limited. |
500 application/json | Internal server error. |
GET/v1/groups/settings
curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/settings" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/groups/settings
{
"links": {
"self": {
"href": "http://mytenant.us.qlikcloud.com/api/v1/groups/settings"
}
},
"tenantId": "string",
"syncIdpGroups": true,
"autoCreateGroups": true
}
Update group settings
Request Body PATCH /v1/groups/settings
application/json | No description |
Responses PATCH /v1/groups/settings
204 object | Config updated successfully. |
400 application/json | Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid. |
401 application/json | Not authorized. |
403 application/json | The operation failed due to insufficient permissions. |
429 application/json | Request has been rate limited. |
500 application/json | Internal server error. |
PATCH/v1/groups/settings
curl "https://your-tenant.us.qlikcloud.com/api/v1/groups/settings" \
-X PATCH \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '[{"op":"replace","path":"/syncIdpGroups","value":true}]'
Request PATCH /v1/groups/settings
[
{
"op": "replace",
"path": "/syncIdpGroups",
"value": true
}
]
Error
objectAn error object describing the error.
Properties
code string | The error code. |
meta optional object | Additional properties relating to the error. |
title string | Summary of the problem. |
detail optional string | A human-readable explanation specific to this occurrence of the problem. |
source optional | References to the source of the error. |
status optional integer | The HTTP status code. |
Errors
objectThe error response object describing the error from the handling of an HTTP request.
Properties
errors | An array of errors related to the operation. |
traceId string | A unique identifier for tracing the error. |
Filter
An advanced query filter to be used for complex user querying in the tenant.
Properties
filter string | The advanced filtering to be applied the query. All conditional statements within this query parameter are case insensitive. |
Group
objectrepresents a Group document
Properties
id string<uuid> | The unique identifier for the group |
name string | The name of the group. |
idpId optional string<uuid> | The unique identifier for the source IDP. |
links optional | Contains Links for current document |
status string | The state of the group. Enum: active disabled |
tenantId string<uuid> | The tenant identifier associated with the given group |
createdAt string<date-time> | The timestamp for when the group record was created. |
assignedRoles optional | No description |
lastUpdatedAt string<date-time> | The timestamp for when the group record was last updated. |
Groups
objectA result object when listing groups.
Properties
data | An array of groups. |
links optional | No description |
totalResults integer | Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. |
GroupSettings
objectrepresents a GroupSetting document
Properties
links optional | Contains Links for current document |
tenantId string<UUID> | The unique tenant identifier. |
syncIdpGroups boolean | Determines if groups should be created on login. |
autoCreateGroups boolean | Determines if groups should be created on login. |
SettingsPatch
objectA JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
Properties
op string | The operation to be performed. Enum: replace |
path string | A JSON Pointer. Enum: /autoCreateGroups /syncIdpGroups |
value boolean | The value to be used for this operation. |
SettingsPatchSchema
Array<SettingsPatch>An array of JSON Patches for the groups settings.
Properties
op string | The operation to be performed. Enum: replace |
path string | A JSON Pointer. Enum: /autoCreateGroups /syncIdpGroups |
value boolean | The value to be used for this operation. |