Users

Users represent clients accessing the Qlik Cloud tenant.

Download specification

List users

Returns a list of users using cursor-based pagination.

Facts

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

Query Parameters

  • fieldsstring

    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.

  • 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.

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

    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")
  • limitnumber

    The number of user entries to retrieve.

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

  • nextstring

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

  • prevstring

    Get users that come before this cursor value when sorted. 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""_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"

  • totalResultsboolean

    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.

  • emailstringDeprecated

    The email to filter by. Deprecated. Use the new filter parameter to provide an advanced query filter.

    format = "email"

  • endingBeforestringDeprecated

    Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use prev instead.

  • rolestringDeprecated

    The role to filter by. Deprecated.

  • sortBystringDeprecated

    The user parameter to sort by. Deprecated. Use sort instead.

    Can be one of: "name"

    default = "name"

  • sortOrderstringDeprecated

    The sort order, either ascending or descending. Deprecated. Use sort instead.

    Can be one of: "asc""desc"

    default = "asc"

  • startingAfterstringDeprecated

    Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with endingBefore. Deprecated. Use next instead.

  • statusstringDeprecated

    The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new filter parameter to provide an advanced query filter.

    Can be one of: "active""invited""disabled""deleted""provisioned"

    default = "active"

  • subjectstringDeprecated

    The subject to filter by. Deprecated. Use the new filter parameter to provide an advanced query filter.

  • tenantIdstringDeprecated

    The tenant ID to filter by. Deprecated.

    format = "uid"

Responses

200

Successful query, returns an array of users

  • application/jsonobject
    Show application/json properties
    • dataarray of objects

      List of users.

      Show data properties
      • idstring
        RequiredFilterable

        The unique user identifier.

        format = "uid"

      • namestring
        RequiredFilterable

        The name of the user.

      • emailstring

        The email address for the user.

      • linksobject

        Pagination links to the user.

        Show links properties
        • selfobject
          Required

          A link to this user.

          Show self properties
          • hrefstring
            Required

            URL that defines the resource.

            format = "uri"

      • rolesarray of stringsDeprecated

        List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use assignedRoles instead.

        Values may be any of: "TenantAdmin""Developer""AnalyticsAdmin""DataAdmin""DataSpaceCreator""ManagedSpaceCreator""SharedSpaceCreator"

      • localestring

        Represents the end-user's language tag.

      • statusstring

        The status of the user within the tenant.

        Can be one of: "active""invited""disabled""deleted""provisioned"

      • createdstringDeprecated

        Deprecated. Use createdAt instead.

        format = "date"

      • picturestring

        A static url linking to the avatar of the user.

        format = "url"

      • subjectstring
        RequiredFilterable

        The unique user identitier from an identity provider.

      • tenantIdstring
        Required

        The tenant that the user belongs too.

        format = "uid"

      • zoneinfostring

        Represents the end-user's time zone.

      • createdAtstring

        The timestamp for when the user record was created.

        format = "date-time"

      • lastUpdatedstringDeprecated

        Deprecated. Use lastUpdatedAt instead.

        format = "date"

      • inviteExpirynumber

        The Unix timestamp indicating when the invite will expire.

      • 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
          RequiredFilterable

          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 user record was last updated.

        format = "date-time"

      • assignedGroupsarray of objects

        An array of group references.

        Show assignedGroups properties
        • idstring
          Required

          The unique group identitier

          format = "uid"

        • namestring
          Required

          The group name

        • providerTypestring

          The provider type of the group

          Can be one of: "idp""custom"

        • 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
            RequiredFilterable

            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"

      • assignedScopesarray of strings

        An array of scopes assigned to a user

      • preferredLocalestring

        Represents the end-user's preferred language tag.

      • preferredZoneinfostring

        Represents the end-user's preferred time zone.
    • linksobject

      Pagination links

      Show links properties
      • nextobject

        Link information for next page

        Show next properties
        • hrefstring
          Required

          URL to the next page of records
      • prevobject

        Link information for previous page

        Show prev properties
        • hrefstring
          Required

          URL to the previous page of records
      • selfobject
        Required

        Link information for current page

        Show self properties
        • hrefstring
          Required

          URL to the current page of records
    • totalResultsinteger

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

400

Invalid request parameters for querying users.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

401

Not authorized.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

500

Internal server error.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.
GET /api/v1/users 
import { createQlikApi } from '@qlik/api'


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


await qlik.users.getUsers({})
qlik user ls
curl "https://your-tenant.us.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"
        }
      },
      "roles": [
        "TenantAdmin"
      ],
      "locale": "string",
      "status": "active",
      "created": "string",
      "picture": "http://example.com",
      "subject": "string",
      "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "zoneinfo": "string",
      "createdAt": "2018-10-30T07:06:22Z",
      "lastUpdated": "string",
      "inviteExpiry": 42,
      "assignedRoles": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "Developer",
          "type": "default",
          "level": "user"
        }
      ],
      "lastUpdatedAt": "2018-10-30T07:06:22Z",
      "assignedGroups": [
        {
          "id": "507f191e810c19729de860eb",
          "name": "Finance",
          "providerType": "idp",
          "assignedRoles": [
            {
              "id": "507f191e810c19729de860ea",
              "name": "Developer",
              "type": "default",
              "level": "user"
            }
          ]
        }
      ],
      "assignedScopes": [
        "string"
      ],
      "preferredLocale": "string",
      "preferredZoneinfo": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  },
  "totalResults": 42
}

Create user

Creates an invited user.

Facts

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

Request Body

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

      The name of the user.

    • emailstring

      The email address for the user. This is a required field when inviting a user.

    • rolesarray of stringsDeprecated

      List of system roles to which the user has been assigned. Only returned when permitted by access control.

      Values may be any of: "TenantAdmin""Developer""AnalyticsAdmin""DataAdmin""DataSpaceCreator""ManagedSpaceCreator""SharedSpaceCreator"

    • statusstring

      The status of the created user within the tenant.

      Can be one of: "invited"

    • picturestring

      A static url linking to the avatar of the user.

      format = "url"

    • subjectstring
      Required

      The unique user identitier from an identity provider.

    • tenantIdstring

      The tenant that the user will belong too.

      format = "uid"

    • assignedRolesarray

      The roles to assign to the user.

      One of:
      • RefIDsarray of objects

        An array of entity reference identifiers (e.g. roles, groups).

        Show RefIDs properties
        • idstring
          Required

          The unique identitier

          format = "uid"

      • RefNamesarray of objects

        An array of reference names (e.g. roles).

        Show RefNames properties
        • namestring
          Required

          The name of the entity

Responses

201

User created successfully.

  • application/jsonobject

    A user object.

    Show application/json properties
    • idstring
      RequiredFilterable

      The unique user identifier.

      format = "uid"

    • namestring
      RequiredFilterable

      The name of the user.

    • emailstring

      The email address for the user.

    • linksobject

      Pagination links to the user.

      Show links properties
      • selfobject
        Required

        A link to this user.

        Show self properties
        • hrefstring
          Required

          URL that defines the resource.

          format = "uri"

    • rolesarray of stringsDeprecated

      List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use assignedRoles instead.

      Values may be any of: "TenantAdmin""Developer""AnalyticsAdmin""DataAdmin""DataSpaceCreator""ManagedSpaceCreator""SharedSpaceCreator"

    • localestring

      Represents the end-user's language tag.

    • statusstring

      The status of the user within the tenant.

      Can be one of: "active""invited""disabled""deleted""provisioned"

    • createdstringDeprecated

      Deprecated. Use createdAt instead.

      format = "date"

    • picturestring

      A static url linking to the avatar of the user.

      format = "url"

    • subjectstring
      RequiredFilterable

      The unique user identitier from an identity provider.

    • tenantIdstring
      Required

      The tenant that the user belongs too.

      format = "uid"

    • zoneinfostring

      Represents the end-user's time zone.

    • createdAtstring

      The timestamp for when the user record was created.

      format = "date-time"

    • lastUpdatedstringDeprecated

      Deprecated. Use lastUpdatedAt instead.

      format = "date"

    • inviteExpirynumber

      The Unix timestamp indicating when the invite will expire.

    • 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
        RequiredFilterable

        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 user record was last updated.

      format = "date-time"

    • assignedGroupsarray of objects

      An array of group references.

      Show assignedGroups properties
      • idstring
        Required

        The unique group identitier

        format = "uid"

      • namestring
        Required

        The group name

      • providerTypestring

        The provider type of the group

        Can be one of: "idp""custom"

      • 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
          RequiredFilterable

          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"

    • assignedScopesarray of strings

      An array of scopes assigned to a user

    • preferredLocalestring

      Represents the end-user's preferred language tag.

    • preferredZoneinfostring

      Represents the end-user's preferred time zone.

400

Invalid request was made.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

401

Unauthorized to create a user.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

403

Forbidden from creating a user.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

409

User conflict when attempting to create a new user.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

413

Payload was too large (limit of 500kB)

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

500

Internal server error.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.
POST /api/v1/users 
import { createQlikApi } from '@qlik/api'


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


await qlik.users.createUser({
  assignedRoles: [{ name: 'Developer' }],
  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='{"name":"Developer"}' \
--email="john.smith@corp.example" \
--name="John Smith" \
--picture="https://corp.example/docs/jsmith.png" \
--status="invited" \
--subject="1234asdasa6789" \
--tenantId="q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f"
curl "https://your-tenant.us.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":"Developer"}]}'

Example Response

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

Get user by ID

Returns the requested user.

Facts

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

Query Parameters

  • fieldsstring

    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

  • userIdstring
    Required

    The user's unique identifier

    format = "uid"

Responses

200

User resource

  • application/jsonobject

    A user object.

    Show application/json properties
    • idstring
      RequiredFilterable

      The unique user identifier.

      format = "uid"

    • namestring
      RequiredFilterable

      The name of the user.

    • emailstring

      The email address for the user.

    • linksobject

      Pagination links to the user.

      Show links properties
      • selfobject
        Required

        A link to this user.

        Show self properties
        • hrefstring
          Required

          URL that defines the resource.

          format = "uri"

    • rolesarray of stringsDeprecated

      List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use assignedRoles instead.

      Values may be any of: "TenantAdmin""Developer""AnalyticsAdmin""DataAdmin""DataSpaceCreator""ManagedSpaceCreator""SharedSpaceCreator"

    • localestring

      Represents the end-user's language tag.

    • statusstring

      The status of the user within the tenant.

      Can be one of: "active""invited""disabled""deleted""provisioned"

    • createdstringDeprecated

      Deprecated. Use createdAt instead.

      format = "date"

    • picturestring

      A static url linking to the avatar of the user.

      format = "url"

    • subjectstring
      RequiredFilterable

      The unique user identitier from an identity provider.

    • tenantIdstring
      Required

      The tenant that the user belongs too.

      format = "uid"

    • zoneinfostring

      Represents the end-user's time zone.

    • createdAtstring

      The timestamp for when the user record was created.

      format = "date-time"

    • lastUpdatedstringDeprecated

      Deprecated. Use lastUpdatedAt instead.

      format = "date"

    • inviteExpirynumber

      The Unix timestamp indicating when the invite will expire.

    • 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
        RequiredFilterable

        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 user record was last updated.

      format = "date-time"

    • assignedGroupsarray of objects

      An array of group references.

      Show assignedGroups properties
      • idstring
        Required

        The unique group identitier

        format = "uid"

      • namestring
        Required

        The group name

      • providerTypestring

        The provider type of the group

        Can be one of: "idp""custom"

      • 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
          RequiredFilterable

          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"

    • assignedScopesarray of strings

      An array of scopes assigned to a user

    • preferredLocalestring

      Represents the end-user's preferred language tag.

    • preferredZoneinfostring

      Represents the end-user's preferred time zone.

403

Forbidden from getting a user.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

404

User was not found.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

500

Internal server error.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.
GET /api/v1/users/{userId} 
import { createQlikApi } from '@qlik/api'


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


await qlik.users.getUser(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  {},
)
qlik user get <userId>
curl "https://your-tenant.us.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"
    }
  },
  "roles": [
    "TenantAdmin"
  ],
  "locale": "string",
  "status": "active",
  "created": "string",
  "picture": "http://example.com",
  "subject": "string",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "zoneinfo": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "lastUpdated": "string",
  "inviteExpiry": 42,
  "assignedRoles": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Developer",
      "type": "default",
      "level": "user"
    }
  ],
  "lastUpdatedAt": "2018-10-30T07:06:22Z",
  "assignedGroups": [
    {
      "id": "507f191e810c19729de860eb",
      "name": "Finance",
      "providerType": "idp",
      "assignedRoles": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "Developer",
          "type": "default",
          "level": "user"
        }
      ]
    }
  ],
  "assignedScopes": [
    "string"
  ],
  "preferredLocale": "string",
  "preferredZoneinfo": "string"
}

Update user by ID

Updates fields for a user resource

Facts

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

Path Parameters

  • userIdstring
    Required

    The ID of the user to update.

    format = "uid"

Request Body

Required
  • application/jsonarray of objects

    An array of JSON Patch documents

    Show application/json properties
    • opstring
      Required

      The operation to be performed. The fields set and unset are deprecated.

      Can be one of: "replace""set""unset""add""renew""remove-value"

    • pathstring
      Required

      A JSON Pointer. The field roles is deprecated.

      Can be one of: "/name""/roles""/assignedRoles""/inviteExpiry""/preferredZoneinfo""/preferredLocale""/status""/assignedGroups"

    • valuestring|boolean|array
      Required

      The value to be used for this operation.

      One of:
      • string
      • boolean
      • array
      • RefIDsarray of objects

        An array of entity reference identifiers (e.g. roles, groups).

        Show RefIDs properties
        • idstring
          Required

          The unique identitier

          format = "uid"

      • RefNamesarray of objects

        An array of reference names (e.g. roles).

        Show RefNames properties
        • namestring
          Required

          The name of the entity
      • AssignedGroupsRefNamesarray of objects

        An array of group reference names and provider type.

        Show AssignedGroupsRefNames properties
        • namestring
          Required

          The name of the group

        • providerTypestring
          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/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

400

Invalid request for patching a user.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

403

Forbidden from patching a user.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

404

User was not found.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.
PATCH /api/v1/users/{userId} 
import { createQlikApi } from '@qlik/api'


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


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


    {
      op: 'replace',
      path: '/assignedRoles',
      value: [{ name: 'Developer' }],
    },


    {
      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 <userId> \
--body='[{"op":"replace","path":"/name","value":"John"},{"op":"replace","path":"/assignedRoles","value":[{"name":"Developer"}]},{"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"}}]'
curl "https://your-tenant.us.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":"Developer"}]},{"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"
}

Delete user by ID

Deletes the requested user.

Facts

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

Path Parameters

  • userIdstring
    Required

    The ID of the user to delete.

    format = "uid"

Responses

204

User deleted successfully.

400

Invalid request for deleting a user.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

403

Forbidden from deleting a user.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

404

User was not found.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.
DELETE /api/v1/users/{userId} 
import { createQlikApi } from '@qlik/api'


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


await qlik.users.deleteUser(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)
qlik user rm <userId>
curl "https://your-tenant.us.qlikcloud.com/api/v1/users/{userId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Count users

Returns the number of users in a given tenant

Facts

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

Query Parameters

  • tenantIdstringDeprecated

    The tenant ID to filter by.

    format = "uid"

Responses

200

The count of users.

  • application/jsonobject

    The result object for the user count.

    Show application/json properties
    • totalnumber
      Required

      The total number of users in the tenant.

403

Forbidden from reading the count.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

404

Not found.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.
GET /api/v1/users/actions/count 
import { createQlikApi } from '@qlik/api'


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


await qlik.users.countUsers({})
qlik user count
curl "https://your-tenant.us.qlikcloud.com/api/v1/users/actions/count" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "total": 42
}

Filter users

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

Facts

Rate limit Special (200 requests per minute)
Categories manage

Query Parameters

  • fieldsstring

    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.

  • 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

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

  • 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

Users retrieved.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects

      List of users.

      Show data properties
      • idstring
        RequiredFilterable

        The unique user identifier.

        format = "uid"

      • namestring
        RequiredFilterable

        The name of the user.

      • emailstring

        The email address for the user.

      • linksobject

        Pagination links to the user.

        Show links properties
        • selfobject
          Required

          A link to this user.

          Show self properties
          • hrefstring
            Required

            URL that defines the resource.

            format = "uri"

      • rolesarray of stringsDeprecated

        List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use assignedRoles instead.

        Values may be any of: "TenantAdmin""Developer""AnalyticsAdmin""DataAdmin""DataSpaceCreator""ManagedSpaceCreator""SharedSpaceCreator"

      • localestring

        Represents the end-user's language tag.

      • statusstring

        The status of the user within the tenant.

        Can be one of: "active""invited""disabled""deleted""provisioned"

      • createdstringDeprecated

        Deprecated. Use createdAt instead.

        format = "date"

      • picturestring

        A static url linking to the avatar of the user.

        format = "url"

      • subjectstring
        RequiredFilterable

        The unique user identitier from an identity provider.

      • tenantIdstring
        Required

        The tenant that the user belongs too.

        format = "uid"

      • zoneinfostring

        Represents the end-user's time zone.

      • createdAtstring

        The timestamp for when the user record was created.

        format = "date-time"

      • lastUpdatedstringDeprecated

        Deprecated. Use lastUpdatedAt instead.

        format = "date"

      • inviteExpirynumber

        The Unix timestamp indicating when the invite will expire.

      • 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
          RequiredFilterable

          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 user record was last updated.

        format = "date-time"

      • assignedGroupsarray of objects

        An array of group references.

        Show assignedGroups properties
        • idstring
          Required

          The unique group identitier

          format = "uid"

        • namestring
          Required

          The group name

        • providerTypestring

          The provider type of the group

          Can be one of: "idp""custom"

        • 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
            RequiredFilterable

            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"

      • assignedScopesarray of strings

        An array of scopes assigned to a user

      • preferredLocalestring

        Represents the end-user's preferred language tag.

      • preferredZoneinfostring

        Represents the end-user's preferred time zone.
    • linksobject

      Pagination links

      Show links properties
      • nextobject

        Link information for next page

        Show next properties
        • hrefstring
          Required

          URL to the next page of records
      • prevobject

        Link information for previous page

        Show prev properties
        • hrefstring
          Required

          URL to the previous page of records
      • selfobject
        Required

        Link information for current page

        Show self properties
        • hrefstring
          Required

          URL to the current page of records
    • totalResultsinteger

      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/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

401

Unauthorized, JWT invalid or not provided.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

403

The operation failed due to unsufficient permissions.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

429

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.

500

Internal server error.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.
POST /api/v1/users/actions/filter 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://your-tenant.us.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 \
--filter="(id eq "626949b9017b657805080bbd" or id eq "626949bf017b657805080bbe") and (status eq "active" or status eq "deleted")"
curl "https://your-tenant.us.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"
        }
      },
      "roles": [
        "TenantAdmin"
      ],
      "locale": "string",
      "status": "active",
      "created": "string",
      "picture": "http://example.com",
      "subject": "string",
      "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "zoneinfo": "string",
      "createdAt": "2018-10-30T07:06:22Z",
      "lastUpdated": "string",
      "inviteExpiry": 42,
      "assignedRoles": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "Developer",
          "type": "default",
          "level": "user"
        }
      ],
      "lastUpdatedAt": "2018-10-30T07:06:22Z",
      "assignedGroups": [
        {
          "id": "507f191e810c19729de860eb",
          "name": "Finance",
          "providerType": "idp",
          "assignedRoles": [
            {
              "id": "507f191e810c19729de860ea",
              "name": "Developer",
              "type": "default",
              "level": "user"
            }
          ]
        }
      ],
      "assignedScopes": [
        "string"
      ],
      "preferredLocale": "string",
      "preferredZoneinfo": "string"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  },
  "totalResults": 42
}

Invite one or more users by email address.

Facts

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

Request Body

Required
  • application/jsonobject
    Show application/json properties
    • inviteesarray of objects

      List of invitees who should receive an invite email.

      Show invitees properties
      • namestring

        Optional display name for this invitee. Example - "Elvis Presley".

      • emailstring
        Required

        Email address for this invitee. Example - "foo@qlik.com".

      • resendboolean

        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.

      • languagestring

        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/jsonobject

    Data list - ResultItem or ErrorItem for each InviteeItem.

    Show application/json properties
    • dataarray of objects
      One of:
      • ResultItemobject

        Invitee result item

        Show ResultItem properties
        • emailstring
          Required

          Email specified for this invitee

        • statusstring
          Required

          Result status = {"ok" (new user; email sent) | "exists" (existing user; no email sent)}

          Can be one of: "ok""exists"

        • userIdstring
          Required

          UserId for this invitee

          format = "uid"

        • subjectstring
          Required

          IdP generated UUID for this invitee

          format = "uuid"

      • InviteErrorItemobject

        Error object.

        Show InviteErrorItem properties
        • codestring
          Required

          Error code - | HTTP Status code | 1001 - Active User | 1002 - Disabled User | 1003 - Default External Dependency Error |

        • titlestring
          Required

          Summary of the problem

        • detailstring

          A human-readable explanation specific to this occurrence of the problem (if applicable)

        • emailstring
          Required

          Invitee email

        • statusstring
          Required

          Result status = "error"

          Can be one of: "error"

403

Request denied.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      Error object.

      Show errors properties
      • codeinteger
        Required

        Error code

      • titlestring
        Required

        Summary of the problem

      • detailstring

        A human-readable explanation specific to this occurrence of the problem (if applicable)

default

Request error. See Errors.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

      Error object.

      Show errors properties
      • codeinteger
        Required

        Error code

      • titlestring
        Required

        Summary of the problem

      • detailstring

        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://your-tenant.us.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.users.inviteUsers({
  invitees: [
    {
      email: 'string',
      language: 'string',
      name: 'string',
      resend: true,
    },
  ],
})
This API is not included yet in qlik-cli
curl "https://your-tenant.us.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"
    }
  ]
}

Get my user

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

Facts

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

Responses

301

Successful redirect.

  • text/htmlstring

429

Request has been rate limited.

  • application/jsonobject

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

    Show application/json properties
    • errorsarray of objects

      An array of errors related to the operation.

      Show errors properties
      • codestring
        Required

        The error code.

      • metaobject

        Additional properties relating to the error.

      • titlestring
        Required

        Summary of the problem.

      • detailstring

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

      • sourceobject

        References to the source of the error.

        Show source properties
        • pointerstring

          A JSON Pointer to the property that caused the error.

        • parameterstring

          The URI query parameter that caused the error.
      • statusnumber

        The HTTP status code.
    • traceIdstring

      A unique identifier for tracing the error.
GET /api/v1/users/me 
import { createQlikApi } from '@qlik/api'


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


await qlik.users.getMyUser()
qlik user me
curl "https://your-tenant.us.qlikcloud.com/api/v1/users/me" \
-H "Authorization: Bearer <access_token>"