Users

Users is the resource that represents a user in the platform.

Endpoints

Skip to section
GET/users/actions/count
POST/users
GET/users
GET/users/{userId}
PATCH/users/{userId}
DELETE/users/{userId}
GET/users/me
GET/users/metadata

Returns the number of users in a given tenant

Query Parameters GET /users/actions/count

tenantId
optional
string<uid>

The tenant ID to filter by.

Responses GET /users/actions/count

200
application/json

The count of users.

403
application/json

Forbidden from reading the count.

404
application/json

Users are not found.

GET/users/actions/count

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

Response GET /users/actions/count

{
  "total": 0
}

Creates a user in a given tenant.

experimental

Request Body POST /users

application/json

No description

Responses POST /users

201
application/json

User created successfully.

400
application/json

Invalid request was made.

403
application/json

Forbidden from creating a user.

409
application/json

User conflict when attempting to create a new user.

429
application/json

Request has been rate limited.

default
application/json

Unexpected error.

POST/users

curl "https://your-tenant.us.qlikcloud.com/api/v1/users" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"tenantId":"DKNmFJCNo8SGURUdh2ll------TENANT","subject":"foo\\12345","name":"John Smith","picture":"https://some.example/john.png","email":"john@some.example","roles":[],"status":"active"}'

Request POST /users

{
  "tenantId": "DKNmFJCNo8SGURUdh2ll------TENANT",
  "subject": "foo\\12345",
  "name": "John Smith",
  "picture": "https://some.example/john.png",
  "email": "john@some.example",
  "roles": [],
  "status": "active"
}

Response POST /users

{
  "id": "string",
  "tenantId": "string",
  "subject": "string",
  "status": "active",
  "inviteExpiry": 0,
  "name": "string",
  "created": "2021-09-20T08:40:05.114Z",
  "lastUpdated": "2021-09-20T08:40:05.114Z",
  "picture": "string",
  "email": "string",
  "roles": [],
  "zoneinfo": "string",
  "locale": "string",
  "preferredZoneinfo": "string",
  "preferredLocale": "string",
  "links": {
    "self": {
      "href": "string"
    }
  }
}

Retrieves a list of users matching the query.

experimental

Query Parameters GET /users

tenantId
deprecated
optional
string<uid>

The tenant ID to filter by. Deprecated. Use the new filter parameter to provide a SCIM-syntax filter.

subject
deprecated
optional
string

The subject to filter by. Deprecated. Use the new filter parameter to provide a SCIM-syntax filter.

email
deprecated
optional
string<email>

The email to filter by. Deprecated. Use the new filter parameter to provide a SCIM-syntax filter.

status
deprecated
optional, default='active'
string

The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new filter parameter to provide a SCIM-syntax filter.

Enum:

active

invited

disabled

deleted

role
deprecated
optional
string

The role to filter by. Deprecated. Use the new filter parameter to provide a SCIM-syntax filter.

fields
optional
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
optional, default=20, minimum=1, maximum=100
number

The number of user entries to retrieve.

sort
optional, default='-created'
string

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

Enum:

name

+name

-name

sortBy
deprecated
optional, default='name'
string

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

Enum:

name

sortOrder
deprecated
optional, default='asc'
string

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

Enum:

asc

desc

startingAfter
deprecated
optional
string

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

endingBefore
deprecated
optional
string

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

Responses GET /users

200
application/json

An array of users.

400
application/json

Invalid request parameters for querying users.

403
application/json

Forbidden from querying users.

429
application/json

Request has been rate limited.

GET/users

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

Response GET /users

{
  "links": {
    "self": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  },
  "data": [
    {
      "id": "string",
      "tenantId": "string",
      "subject": "string",
      "status": "active",
      "inviteExpiry": 0,
      "name": "string",
      "created": "2021-09-20T08:40:05.114Z",
      "lastUpdated": "2021-09-20T08:40:05.114Z",
      "picture": "string",
      "email": "string",
      "roles": [],
      "zoneinfo": "string",
      "locale": "string",
      "preferredZoneinfo": "string",
      "preferredLocale": "string",
      "links": {
        "self": {
          "href": "string"
        }
      }
    }
  ]
}

Retrieves a user resource.

Path Parameters GET /users/{userId}

userId
string<uid>

The ID of the user to retrieve.

Responses GET /users/{userId}

200
application/json

Returns the user resource.

403
application/json

Forbidden from retrieving the user.

404
application/json

User was not found.

429
application/json

Request has been rate limited.

default
application/json

Unexpected error.

GET/users/{userId}

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

Response GET /users/{userId}

{
  "id": "string",
  "tenantId": "string",
  "subject": "string",
  "status": "active",
  "inviteExpiry": 0,
  "name": "string",
  "created": "2021-09-20T08:40:05.114Z",
  "lastUpdated": "2021-09-20T08:40:05.114Z",
  "picture": "string",
  "email": "string",
  "roles": [],
  "zoneinfo": "string",
  "locale": "string",
  "preferredZoneinfo": "string",
  "preferredLocale": "string",
  "links": {
    "self": {
      "href": "string"
    }
  }
}

Updates a user resource.

experimental

Path Parameters PATCH /users/{userId}

userId
string<uid>

The ID of the user to update.

Request Body PATCH /users/{userId}

application/json

No description

Responses PATCH /users/{userId}

204
application/json
object

User updated successfully.

207
application/json

User updated successfully, but with partial update failures.

400
application/json

Invalid request for patching a user.

403
application/json

Forbidden from patching a user.

404
application/json

User was not found.

429
application/json

Request has been rate limited.

PATCH/users/{userId}

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

Request PATCH /users/{userId}

[
  {
    "op": "replace",
    "path": "/name",
    "value": "John"
  }
]

Response PATCH /users/{userId}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "status": 0,
      "detail": "string",
      "meta": {},
      "source": {
        "parameter": "string",
        "pointer": "string"
      }
    }
  ]
}

Deletes a user resource.

experimental

Path Parameters DELETE /users/{userId}

userId
string<uid>

The ID of the user to delete.

Responses DELETE /users/{userId}

204
application/json
object

User deleted successfully.

400
application/json

Invalid request for deleting a user.

403
application/json

Forbidden from deleting a user.

404
application/json

User was not found.

429
application/json

Request has been rate limited.

DELETE/users/{userId}

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

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

Responses GET /users/me

301
text/html
string

Successful redirect.

GET/users/me

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

Returns the metadata with regard to the user configuration.

Deprecated, use GET /v1/roles instead.

Responses GET /users/metadata

200
application/json

User configuration

GET/users/metadata

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

Response GET /users/metadata

{
  "valid_roles": []
}

Metadata

object

Properties

valid_roles
Array<string>

List of system roles to which the user can be assigned.

Users

object

Properties

links

No description

data

No description

User

object

Properties

id
string<uid>

No description

tenantId
string<uid>

No description

subject
string

No description

status
optional
string

No description

Enum:

active

invited

disabled

inviteExpiry
optional
number

No description

name
string

No description

created
deprecated
optional
string<date>

Deprecated. Use createdAt instead.

lastUpdated
deprecated
optional
string<date>

Deprecated. Use lastUpdatedAt instead.

picture
optional
string<url>

No description

email
optional
string

Email is a required field when tenantAdmin creates users with status as 'invited'

roles
deprecated
optional
Array<string>

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

zoneinfo
optional
string

Represents the end-user's time zone.

locale
optional
string

Represents the end-user's language tag.

preferredZoneinfo
optional
string

Represents the end-user's preferred time zone.

preferredLocale
optional
string

Represents the end-user's preferred language tag.

links

No description

UserCount

object

Properties

total
number

No description

UserPostSchema

object

Properties

tenantId
string<uid>

No description

subject
string

No description

status
optional
string

No description

Enum:

active

invited

name
string

No description

picture
optional
string<url>

No description

email
optional
string

Email is a required field when tenantAdmin creates users with status as 'invited'

roles
optional
Array<string>

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

UserPatchSchema

Array<UserPatch>

An array of JSON Patch documents

Properties

op
string

The operation to be performed.

Enum:

replace

set (Deprecated, /roles path only)

unset (Deprecated, /roles path only)

add

renew

path
string

A JSON Pointer.

Enum:

/name

/roles

/inviteExpiry

/zoneinfo

/locale

/preferredZoneinfo

/preferredLocale

value

The value to be used for this operation.

UserPatch

object

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.

Properties

op
string

The operation to be performed.

Enum:

replace

set (Deprecated, /roles path only)

unset (Deprecated, /roles path only)

add

renew

path
string

A JSON Pointer.

Enum:

/name

/roles

/inviteExpiry

/zoneinfo

/locale

/preferredZoneinfo

/preferredLocale

value

The value to be used for this operation.

Errors

object

A representation of the errors encountered from the HTTP request.

Properties

errors

No description

Error

object

An error object.

Properties

code
string

The error code.

title
string

Summary of the problem.

status
optional
number

The HTTP status code.

detail
optional
string

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

meta
optional
object

Additional properties relating to the error.

source
optional

References to the source of the error.

v1.6.0
Was this page helpful?