Users

Users represent clients accessing the Qlik Cloud tenant.

Download OpenAPI spec

Endpoints

GET

/api/v1/users
POST

/api/v1/users
GET

/api/v1/users/{userId}
PATCH

/api/v1/users/{userId}
DELETE

/api/v1/users/{userId}
GET

/api/v1/users/actions/count
POST

/api/v1/users/actions/filter
POST

/api/v1/users/actions/invite
GET

/api/v1/users/me

Returns a list of users using cursor-based pagination.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

fields string

A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted.
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.

The following fields support the eq operator: id, subject, name, email, status, clientId, assignedRoles.id, assignedRoles.name, assignedGroups.id, assignedGroupsAssignedRoles.name, assignedScopes

Additionally, the following fields support the co operator: name, email, subject

Queries may be rate limited if they differ greatly from these examples:
```
(id eq "62716ab404a7bd8626af9bd6" or id eq "62716ac4c7e500e13ff5fa22") and (status eq "active" or status eq "disabled")
```
```
name co "query" or email co "query" or subject co "query" or id eq "query" or assignedRoles.name eq "query"
```
Any filters for status must be grouped together and applied to the whole query.

Valid:
```
(name eq "Bob" or name eq "Alice") and (status eq "active" or status eq "disabled")
```
Invalid:
```
name eq "Bob" or name eq "Alice" and (status eq "active" or status eq "disabled")
```
limit number

The number of user entries to retrieve.

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

Get users that come after this cursor value when sorted. Cannot be used in conjunction with prev.
prev string

Get users that come before this cursor value when sorted. Cannot be used in conjunction with next.
sort string

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

Can be one of: "name""+name""-name""_id""+_id""-_id""id""+id""-id""tenantId""+tenantId""-tenantId""clientId""+clientId""-clientId""status""+status""-status""subject""+subject""-subject""email""+email""-email""inviteExpiry""+inviteExpiry""-inviteExpiry""createdAt""+createdAt""-createdAt"
default = "+name"
totalResults boolean

Whether to return a total match count in the result. Defaults to false. It will trigger an extra DB query to count, reducing the efficiency of the endpoint.

Responses

200

Successful query, returns an array of users

application/json object
Show application/json properties
- data array of objects
  
  List of users.
  
  Show data properties
  
  id string
  
  Required Filterable
  
  The unique user identifier.
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The name of the user.
  
  email string
  
  Filterable
  
  The email address for the user.
  
  links object
  
  Pagination links to the user.
  
  Show links properties
  
  self object
  
  Required
  
  A link to this user.
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  format = "uri"
  
  locale string
  
  Represents the end-user's language tag.
  
  status string
  
  Filterable
  
  The status of the user within the tenant.
  
  Can be one of: "active""invited""disabled""deleted""provisioned"
  
  picture string
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subject string
  
  Required Filterable
  
  The unique user identitier from an identity provider.
  
  tenantId string
  
  Required
  
  The tenant that the user belongs too.
  
  format = "uid"
  
  zoneinfo string
  
  Represents the end-user's time zone.
  
  createdAt string
  
  The timestamp for when the user record was created.
  
  format = "date-time"
  
  inviteExpiry number
  
  The Unix timestamp indicating when the invite will expire.
  
  assignedRoles array 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
  
  id string
  
  Required
  
  The unique role identitier
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The role name
  
  type string
  
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  lastUpdatedAt string
  
  The timestamp for when the user record was last updated.
  
  format = "date-time"
  
  assignedGroups array of objects
  
  An array of group references.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identitier
  
  format = "uid"
  
  name string
  
  Required
  
  The group name
  
  providerType string
  
  The provider type of the group
  
  Can be one of: "idp""custom"
  
  assignedRoles array 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
  
  id string
  
  Required
  
  The unique role identitier
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The role name
  
  type string
  
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  assignedScopes array of strings
  
  An array of scopes assigned to a user
  
  preferredLocale string
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfo string
  
  Represents the end-user's preferred time zone.
- links object
  
  Pagination links
  
  Show links properties
  
  next object
  
  Link information for next page
  
  Show next properties
  
  href string
  
  Required
  
  URL to the next page of records
  
  prev object
  
  Link information for previous page
  
  Show prev properties
  
  href string
  
  Required
  
  URL to the previous page of records
  
  self object
  
  Required
  
  Link information for current page
  
  Show self properties
  
  href string
  
  Required
  
  URL to the current page of records
- 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 users.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

401

Not authorized.

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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

GET /api/v1/users

import { createQlikApi } from '@qlik/api'

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

await qlik.users.getUsers({})

qlik user ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/users" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "name": "string",
      "email": "string",
      "links": {
        "self": {
          "href": "http://mytenant.elastic.example/api/v1/users/DKNmFJCNo8SGURUdh2ll--------USER"
        }
      },
      "locale": "string",
      "status": "active",
      "picture": "http://example.com",
      "subject": "string",
      "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "zoneinfo": "string",
      "createdAt": "2018-10-30T07:06:22Z",
      "inviteExpiry": 42,
      "assignedRoles": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "My Custom Role",
          "type": "custom",
          "level": "user"
        }
      ],
      "lastUpdatedAt": "2018-10-30T07:06:22Z",
      "assignedGroups": [
        {
          "id": "507f191e810c19729de860eb",
          "name": "Finance",
          "providerType": "idp",
          "assignedRoles": [
            {
              "id": "507f191e810c19729de860ea",
              "name": "My Custom Role",
              "type": "custom",
              "level": "user"
            }
          ]
        }
      ],
      "assignedScopes": [
        "string"
      ],
      "preferredLocale": "string",
      "preferredZoneinfo": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  },
  "totalResults": 42
}

Creates an invited user.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

application/json object
Show application/json properties
- name string
  
  The name of the user.
- email string
  
  The email address for the user. This is a required field when inviting a user.
- status string
  
  The status of the created user within the tenant.
  
  Can be one of: "invited"
- picture string
  
  A static url linking to the avatar of the user.
  
  format = "url"
- subject string
  
  Required
  
  The unique user identitier from an identity provider.
- tenantId string
  
  The tenant that the user will belong too.
  
  format = "uid"
- assignedRoles array
  
  The roles to assign to the user.
  
  One of:
  
  RefIDs array of objects
  
  An array of entity reference identifiers (e.g. roles, groups).
  
  Show RefIDs properties
  
  id string
  
  Required
  
  The unique identitier
  
  format = "uid"
  
  RefNames array of objects
  
  An array of reference names (e.g. roles).
  
  Show RefNames properties
  
  name string
  
  Required
  
  The name of the entity

Responses

201

User created successfully.

application/json object

A user object.
Show application/json properties
- id string
  
  Required Filterable
  
  The unique user identifier.
  
  format = "uid"
- name string
  
  Required Filterable
  
  The name of the user.
- email string
  
  Filterable
  
  The email address for the user.
- links object
  
  Pagination links to the user.
  
  Show links properties
  
  self object
  
  Required
  
  A link to this user.
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  format = "uri"
- locale string
  
  Represents the end-user's language tag.
- status string
  
  Filterable
  
  The status of the user within the tenant.
  
  Can be one of: "active""invited""disabled""deleted""provisioned"
- picture string
  
  A static url linking to the avatar of the user.
  
  format = "url"
- subject string
  
  Required Filterable
  
  The unique user identitier from an identity provider.
- tenantId string
  
  Required
  
  The tenant that the user belongs too.
  
  format = "uid"
- zoneinfo string
  
  Represents the end-user's time zone.
- createdAt string
  
  The timestamp for when the user record was created.
  
  format = "date-time"
- inviteExpiry number
  
  The Unix timestamp indicating when the invite will expire.
- assignedRoles array 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
  
  id string
  
  Required
  
  The unique role identitier
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The role name
  
  type string
  
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  The role level
  
  Can be one of: "admin""user"
- lastUpdatedAt string
  
  The timestamp for when the user record was last updated.
  
  format = "date-time"
- assignedGroups array of objects
  
  An array of group references.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identitier
  
  format = "uid"
  
  name string
  
  Required
  
  The group name
  
  providerType string
  
  The provider type of the group
  
  Can be one of: "idp""custom"
  
  assignedRoles array 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
  
  id string
  
  Required
  
  The unique role identitier
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The role name
  
  type string
  
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  The role level
  
  Can be one of: "admin""user"
- assignedScopes array of strings
  
  An array of scopes assigned to a user
- preferredLocale string
  
  Represents the end-user's preferred language tag.
- preferredZoneinfo string
  
  Represents the end-user's preferred time zone.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

401

Unauthorized to create a user.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

403

Forbidden from creating a user.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

409

User conflict when attempting to create a new user.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

413

Payload was too large (limit of 500kB)

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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

POST /api/v1/users

import { createQlikApi } from '@qlik/api'

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

await qlik.users.createUser({
  assignedRoles: [{ name: 'My Custom Role' }],
  email: 'john.smith@corp.example',
  name: 'John Smith',
  picture: 'https://corp.example/docs/jsmith.png',
  status: 'invited',
  subject: '1234asdasa6789',
  tenantId: 'q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f',
})

qlik user create \
  --assignedRoles-id '' \
  --assignedRoles-name '' \
  --subject '1234asdasa6789'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/users" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"John Smith","email":"john.smith@corp.example","status":"invited","picture":"https://corp.example/docs/jsmith.png","subject":"1234asdasa6789","tenantId":"q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f","assignedRoles":[{"name":"My Custom Role"}]}'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "name": "string",
  "email": "string",
  "links": {
    "self": {
      "href": "http://mytenant.elastic.example/api/v1/users/DKNmFJCNo8SGURUdh2ll--------USER"
    }
  },
  "locale": "string",
  "status": "active",
  "picture": "http://example.com",
  "subject": "string",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "zoneinfo": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "inviteExpiry": 42,
  "assignedRoles": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "My Custom Role",
      "type": "custom",
      "level": "user"
    }
  ],
  "lastUpdatedAt": "2018-10-30T07:06:22Z",
  "assignedGroups": [
    {
      "id": "507f191e810c19729de860eb",
      "name": "Finance",
      "providerType": "idp",
      "assignedRoles": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "My Custom Role",
          "type": "custom",
          "level": "user"
        }
      ]
    }
  ],
  "assignedScopes": [
    "string"
  ],
  "preferredLocale": "string",
  "preferredZoneinfo": "string"
}

Returns the requested user.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

fields string

A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted.

Path Parameters

userId string

Required

The user's unique identifier

format = "uid"

Responses

200

User resource

application/json object

A user object.
Show application/json properties
- id string
  
  Required Filterable
  
  The unique user identifier.
  
  format = "uid"
- name string
  
  Required Filterable
  
  The name of the user.
- email string
  
  Filterable
  
  The email address for the user.
- links object
  
  Pagination links to the user.
  
  Show links properties
  
  self object
  
  Required
  
  A link to this user.
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  format = "uri"
- locale string
  
  Represents the end-user's language tag.
- status string
  
  Filterable
  
  The status of the user within the tenant.
  
  Can be one of: "active""invited""disabled""deleted""provisioned"
- picture string
  
  A static url linking to the avatar of the user.
  
  format = "url"
- subject string
  
  Required Filterable
  
  The unique user identitier from an identity provider.
- tenantId string
  
  Required
  
  The tenant that the user belongs too.
  
  format = "uid"
- zoneinfo string
  
  Represents the end-user's time zone.
- createdAt string
  
  The timestamp for when the user record was created.
  
  format = "date-time"
- inviteExpiry number
  
  The Unix timestamp indicating when the invite will expire.
- assignedRoles array 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
  
  id string
  
  Required
  
  The unique role identitier
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The role name
  
  type string
  
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  The role level
  
  Can be one of: "admin""user"
- lastUpdatedAt string
  
  The timestamp for when the user record was last updated.
  
  format = "date-time"
- assignedGroups array of objects
  
  An array of group references.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identitier
  
  format = "uid"
  
  name string
  
  Required
  
  The group name
  
  providerType string
  
  The provider type of the group
  
  Can be one of: "idp""custom"
  
  assignedRoles array 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
  
  id string
  
  Required
  
  The unique role identitier
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The role name
  
  type string
  
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  The role level
  
  Can be one of: "admin""user"
- assignedScopes array of strings
  
  An array of scopes assigned to a user
- preferredLocale string
  
  Represents the end-user's preferred language tag.
- preferredZoneinfo string
  
  Represents the end-user's preferred time zone.

403

Forbidden from getting a user.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

404

User was not found.

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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

GET /api/v1/users/{userId}

import { createQlikApi } from '@qlik/api'

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

await qlik.users.getUser(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  {},
)

qlik user get 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/users/{userId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "name": "string",
  "email": "string",
  "links": {
    "self": {
      "href": "http://mytenant.elastic.example/api/v1/users/DKNmFJCNo8SGURUdh2ll--------USER"
    }
  },
  "locale": "string",
  "status": "active",
  "picture": "http://example.com",
  "subject": "string",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "zoneinfo": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "inviteExpiry": 42,
  "assignedRoles": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "My Custom Role",
      "type": "custom",
      "level": "user"
    }
  ],
  "lastUpdatedAt": "2018-10-30T07:06:22Z",
  "assignedGroups": [
    {
      "id": "507f191e810c19729de860eb",
      "name": "Finance",
      "providerType": "idp",
      "assignedRoles": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "My Custom Role",
          "type": "custom",
          "level": "user"
        }
      ]
    }
  ],
  "assignedScopes": [
    "string"
  ],
  "preferredLocale": "string",
  "preferredZoneinfo": "string"
}

Updates fields for a user resource

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

userId string

Required

The ID of the user to update.

format = "uid"

Request Body

Required

application/json array of objects

An array of JSON Patch documents
Show application/json properties
- op string
  
  Required
  
  The operation to be performed. The fields set and unset are deprecated.
  
  Can be one of: "replace""set""unset""add""renew""remove-value"
- path string
  
  Required
  
  A JSON Pointer. The field roles is deprecated.
  
  Can be one of: "/name""/roles""/assignedRoles""/inviteExpiry""/preferredZoneinfo""/preferredLocale""/status""/assignedGroups"
- value string|boolean|array
  
  Required
  
  The value to be used for this operation.
  
  One of:
  
  string
  
  boolean
  
  array
  
  RefIDs array of objects
  
  An array of entity reference identifiers (e.g. roles, groups).
  
  Show RefIDs properties
  
  id string
  
  Required
  
  The unique identitier
  
  format = "uid"
  
  RefNames array of objects
  
  An array of reference names (e.g. roles).
  
  Show RefNames properties
  
  name string
  
  Required
  
  The name of the entity
  
  AssignedGroupsRefNames array of objects
  
  An array of group reference names and provider type.
  
  Show AssignedGroupsRefNames properties
  
  name string
  
  Required
  
  The name of the group
  
  providerType string
  
  Required
  
  The type of provider for the group.
  
  Can be one of: "idp""custom"

Responses

204

User updated successfully.

207

User update was partially successful with non-critical failures.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

400

Invalid request for patching a user.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

403

Forbidden from patching a user.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

404

User was not found.

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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

PATCH /api/v1/users/{userId}

import { createQlikApi } from '@qlik/api'

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

await qlik.users.patchUser(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'John',
    },

    {
      op: 'replace',
      path: '/assignedRoles',
      value: [{ name: 'My Custom Role' }],
    },

    {
      op: 'replace',
      path: '/email',
      value: 'unicorn@corp.example',
    },

    {
      op: 'replace',
      path: '/preferredZoneInfo',
      value: 'America/Halifax',
    },

    {
      op: 'replace',
      path: '/preferredLocale',
      value: 'en_US_POSIX',
    },

    {
      op: 'replace',
      path: '/status',
      value: 'active',
    },

    {
      op: 'add',
      path: '/assignedRoles/-',
      value: { name: 'TenantAdmin' },
    },

    {
      op: 'remove-value',
      path: '/assignedRoles',
      value: { id: '67ac386d2bab6dd4925008e8' },
    },
  ],
)

qlik user patch 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69' \
  --op 'replace' \
  --path '/name' \
  --value John \
  --value-id '' \
  --value-name '' \
  --value-providerType ''

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/users/{userId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"John"},{"op":"replace","path":"/assignedRoles","value":[{"name":"My Custom Role"}]},{"op":"replace","path":"/email","value":"unicorn@corp.example"},{"op":"replace","path":"/preferredZoneInfo","value":"America/Halifax"},{"op":"replace","path":"/preferredLocale","value":"en_US_POSIX"},{"op":"replace","path":"/status","value":"active"},{"op":"add","path":"/assignedRoles/-","value":{"name":"TenantAdmin"}},{"op":"remove-value","path":"/assignedRoles","value":{"id":"67ac386d2bab6dd4925008e8"}}]'

Example Response

{
  "errors": [
    {
      "code": "USERS-7",
      "title": "Not found",
      "status": 404
    }
  ],
  "traceId": "000000000000000079cf1ebeae103de1"
}

Deletes the requested user.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

userId string

Required

The ID of the user to delete.

format = "uid"

Responses

204

User deleted successfully.

400

Invalid request for deleting a user.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

403

Forbidden from deleting a user.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

404

User was not found.

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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

DELETE /api/v1/users/{userId}

import { createQlikApi } from '@qlik/api'

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

await qlik.users.deleteUser(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)

qlik user rm 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/users/{userId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Returns the number of users in a given tenant

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

200

The count of users.

application/json object

The result object for the user count.
Show application/json properties
- total number
  
  Required
  
  The total number of users in the tenant.

403

Forbidden from reading the count.

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

404

Not found.

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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

GET /api/v1/users/actions/count

import { createQlikApi } from '@qlik/api'

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

await qlik.users.countUsersWithoutQuery()

qlik user count

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/users/actions/count" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "total": 42
}

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

Facts

Rate limit

Special (200 requests per minute)

Query Parameters

fields string

A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted.
limit number

The number of user entries to retrieve.

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

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

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

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

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

Request Body

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

application/json object

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

Responses

200

Users retrieved.

application/json object
Show application/json properties
- data array of objects
  
  List of users.
  
  Show data properties
  
  id string
  
  Required Filterable
  
  The unique user identifier.
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The name of the user.
  
  email string
  
  Filterable
  
  The email address for the user.
  
  links object
  
  Pagination links to the user.
  
  Show links properties
  
  self object
  
  Required
  
  A link to this user.
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  format = "uri"
  
  locale string
  
  Represents the end-user's language tag.
  
  status string
  
  Filterable
  
  The status of the user within the tenant.
  
  Can be one of: "active""invited""disabled""deleted""provisioned"
  
  picture string
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subject string
  
  Required Filterable
  
  The unique user identitier from an identity provider.
  
  tenantId string
  
  Required
  
  The tenant that the user belongs too.
  
  format = "uid"
  
  zoneinfo string
  
  Represents the end-user's time zone.
  
  createdAt string
  
  The timestamp for when the user record was created.
  
  format = "date-time"
  
  inviteExpiry number
  
  The Unix timestamp indicating when the invite will expire.
  
  assignedRoles array 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
  
  id string
  
  Required
  
  The unique role identitier
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The role name
  
  type string
  
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  lastUpdatedAt string
  
  The timestamp for when the user record was last updated.
  
  format = "date-time"
  
  assignedGroups array of objects
  
  An array of group references.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identitier
  
  format = "uid"
  
  name string
  
  Required
  
  The group name
  
  providerType string
  
  The provider type of the group
  
  Can be one of: "idp""custom"
  
  assignedRoles array 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
  
  id string
  
  Required
  
  The unique role identitier
  
  format = "uid"
  
  name string
  
  Required Filterable
  
  The role name
  
  type string
  
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  assignedScopes array of strings
  
  An array of scopes assigned to a user
  
  preferredLocale string
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfo string
  
  Represents the end-user's preferred time zone.
- links object
  
  Pagination links
  
  Show links properties
  
  next object
  
  Link information for next page
  
  Show next properties
  
  href string
  
  Required
  
  URL to the next page of records
  
  prev object
  
  Link information for previous page
  
  Show prev properties
  
  href string
  
  Required
  
  URL to the previous page of records
  
  self object
  
  Required
  
  Link information for current page
  
  Show self properties
  
  href string
  
  Required
  
  URL to the current page of records
- totalResults integer
  
  Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true.

400

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

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

401

Unauthorized, JWT 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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

403

The operation failed due to unsufficient permissions.

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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- 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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

POST /api/v1/users/actions/filter

import { createQlikApi } from '@qlik/api'

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

await qlik.users.filterUsers(
  {},
  {
    filter:
      '(id eq "626949b9017b657805080bbd" or id eq "626949bf017b657805080bbe") and (status eq "active" or status eq "deleted")',
  },
)

qlik user filter

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

Example Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "name": "string",
      "email": "string",
      "links": {
        "self": {
          "href": "http://mytenant.elastic.example/api/v1/users/DKNmFJCNo8SGURUdh2ll--------USER"
        }
      },
      "locale": "string",
      "status": "active",
      "picture": "http://example.com",
      "subject": "string",
      "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "zoneinfo": "string",
      "createdAt": "2018-10-30T07:06:22Z",
      "inviteExpiry": 42,
      "assignedRoles": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "My Custom Role",
          "type": "custom",
          "level": "user"
        }
      ],
      "lastUpdatedAt": "2018-10-30T07:06:22Z",
      "assignedGroups": [
        {
          "id": "507f191e810c19729de860eb",
          "name": "Finance",
          "providerType": "idp",
          "assignedRoles": [
            {
              "id": "507f191e810c19729de860ea",
              "name": "My Custom Role",
              "type": "custom",
              "level": "user"
            }
          ]
        }
      ],
      "assignedScopes": [
        "string"
      ],
      "preferredLocale": "string",
      "preferredZoneinfo": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  },
  "totalResults": 42
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

application/json object
Show application/json properties
- invitees array of objects
  
  List of invitees who should receive an invite email.
  
  Show invitees properties
  
  name string
  
  Optional display name for this invitee. Example - "Elvis Presley".
  
  email string
  
  Required
  
  Email address for this invitee. Example - "foo@qlik.com".
  
  resend boolean
  
  Flag - when true invite message is sent to inactive or invited users. Typically used to force email resend to users who are not yet active.
  
  language string
  
  Optional ISO 639-1 2 letter code for invite language. Defaults to 'en' when missing or not found.

Responses

207

Request completed successfully. See Results for ResultDetail on each invite.

application/json object

Data list - ResultItem or ErrorItem for each InviteeItem.
Show application/json properties
- data array of objects
  
  One of:
  
  ResultItem object
  
  Invitee result item
  
  Show ResultItem properties
  
  email string
  
  Required
  
  Email specified for this invitee
  
  status string
  
  Required
  
  Result status = {"ok" (new user; email sent) | "exists" (existing user; no email sent)}
  
  Can be one of: "ok""exists"
  
  userId string
  
  Required
  
  UserId for this invitee
  
  format = "uid"
  
  subject string
  
  Required
  
  IdP generated UUID for this invitee
  
  format = "uuid"
  
  InviteErrorItem object
  
  Error object.
  
  Show InviteErrorItem properties
  
  code string
  
  Required
  
  Error code - | HTTP Status code | 1001 - Active User | 1002 - Disabled User | 1003 - Default External Dependency Error |
  
  title string
  
  Required
  
  Summary of the problem
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem (if applicable)
  
  email string
  
  Required
  
  Invitee email
  
  status string
  
  Required
  
  Result status = "error"
  
  Can be one of: "error"

403

Request denied.

application/json object
Show application/json properties
- errors array of objects
  
  Error object.
  
  Show errors properties
  
  code integer
  
  Required
  
  Error code
  
  title string
  
  Required
  
  Summary of the problem
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem (if applicable)

default

Request error. See Errors.

application/json object
Show application/json properties
- errors array of objects
  
  Error object.
  
  Show errors properties
  
  code integer
  
  Required
  
  Error code
  
  title string
  
  Required
  
  Summary of the problem
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem (if applicable)

POST /api/v1/users/actions/invite

import { createQlikApi } from '@qlik/api'

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

await qlik.users.inviteUsers({
  invitees: [
    {
      email: 'string',
      language: 'string',
      name: 'string',
      resend: true,
    },
  ],
})

qlik user invite \
  --invitees-email ''

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/users/actions/invite" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"invitees":[{"name":"string","email":"string","resend":true,"language":"string"}]}'

Example Response

{
  "data": [
    {
      "email": "string",
      "status": "ok",
      "userId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "subject": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
    }
  ]
}

Redirects to retrieve the user resource associated with the JWT claims.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

301

Successful redirect.

text/html string

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.
  
  status number
  
  The HTTP status code.
- traceId string
  
  A unique identifier for tracing the error.

GET /api/v1/users/me

import { createQlikApi } from '@qlik/api'

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

await qlik.users.getMyUser()

qlik user me

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/users/me" \
-H "Authorization: Bearer <access_token>"

Users

Endpoints

List users

Facts

Query Parameters

Responses

200

400

401

429

500

Example Response

Create user

Facts

Request Body

Responses

201

400

401

403

409

413

429

500

Example Response

Get user by ID

Facts

Query Parameters

Path Parameters

Responses

200

403

404

429

500

Example Response

Update user by ID

Facts

Path Parameters

Request Body

Responses

204

207

400

403

404

429

Example Response

Delete user by ID

Facts

Path Parameters

Responses

204

400

403

404

429

Count users

Facts

Responses

200

403

404

429

Example Response

Filter users

Facts

Query Parameters

Request Body

Responses

200

400

401

403

429

500

Example Response

Invite one or more users by email address.

Facts

Request Body