Users

Download AsyncAPI spec

Events emitted when users are created or deleted in a Qlik Cloud tenant. These events enable tracking of user lifecycle changes for provisioning and security purposes.

Preferred events

These events replace the legacy Users events. Use these events for all new implementations.

Published when a new user is created.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

The type of the event.

default = "com.qlik.core.user.created"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/identities"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
userid string

Unique identifier for the user triggering the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
data object

The event data payload containing created user details. The payload conforms to the user schema for human users, or the botUser schema for bot (service) accounts.
One of:
- user object
  Show user properties
  
  id string
  
  Required
  
  The unique user identifier.
  
  format = "uid"
  
  name string
  
  Required
  
  The name of the user.
  
  email string
  
  The email address for the user.
  
  groups array of strings
  
  References to IdP groups assigned to the user.
  
  locale string
  
  Represents the end-user's language tag.
  
  status string
  
  The status of the user within the tenant.
  
  Can be one of: "active""invited""disabled""deleted"
  
  picture string
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subject string
  
  Required
  
  The unique user identifier from an identity provider.
  
  tenantId string
  
  Required
  
  The tenant that the user belongs to.
  
  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 number of seconds until the user invitation will expire.
  
  assignedRoles array of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identifier
  
  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
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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"
  
  preferredLocale string
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfo string
  
  Represents the end-user's preferred time zone.
- botUser object
  Show botUser properties
  
  id string
  
  Required
  
  The unique bot user identifier.
  
  format = "uid"
  
  name string
  
  Required
  
  The name of the bot user.
  
  groups array of strings
  
  Group names associated to the bot user.
  
  status string
  
  The status of the bot user within the tenant.
  
  Can be one of: "active""disabled""deleted"
  
  subject string
  
  Required
  
  The unique bot user identifier which incorporates the client ID.
  
  clientId string
  
  Required
  
  The OAuth client ID that the bot user belongs to.
  
  tenantId string
  
  Required
  
  The tenant that the bot user belongs to.
  
  format = "uid"
  
  createdAt string
  
  The timestamp for when the bot user record was created.
  
  format = "date-time"
  
  assignedRoles array of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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 bot user record was last updated.
  
  format = "date-time"
  
  assignedGroups array of objects
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identifier
  
  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
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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"

com.qlik.core.user.created

Example payload of the "User created" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.user.created",
  "source": "com.qlik/identities",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "string",
    "email": "string",
    "groups": [
      "group1",
      "group2"
    ],
    "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": "507f191e810c19729de860ea",
        "name": "Finance",
        "providerType": "custom",
        "assignedRoles": [
          {
            "id": "507f191e810c19729de860ea",
            "name": "My Custom Role",
            "type": "custom",
            "level": "user"
          }
        ]
      }
    ],
    "preferredLocale": "string",
    "preferredZoneinfo": "string"
  }
}

Published when a user is deleted.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

The type of the event.

default = "com.qlik.core.user.deleted"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/identities"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
userid string

Unique identifier for the user triggering the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
data object

The event data payload containing deleted user details. The payload conforms to the user schema for human users, or the botUser schema for bot (service) accounts.
One of:
- user object
  Show user properties
  
  id string
  
  Required
  
  The unique user identifier.
  
  format = "uid"
  
  name string
  
  Required
  
  The name of the user.
  
  email string
  
  The email address for the user.
  
  groups array of strings
  
  References to IdP groups assigned to the user.
  
  locale string
  
  Represents the end-user's language tag.
  
  status string
  
  The status of the user within the tenant.
  
  Can be one of: "active""invited""disabled""deleted"
  
  picture string
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subject string
  
  Required
  
  The unique user identifier from an identity provider.
  
  tenantId string
  
  Required
  
  The tenant that the user belongs to.
  
  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 number of seconds until the user invitation will expire.
  
  assignedRoles array of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identifier
  
  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
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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"
  
  preferredLocale string
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfo string
  
  Represents the end-user's preferred time zone.
- botUser object
  Show botUser properties
  
  id string
  
  Required
  
  The unique bot user identifier.
  
  format = "uid"
  
  name string
  
  Required
  
  The name of the bot user.
  
  groups array of strings
  
  Group names associated to the bot user.
  
  status string
  
  The status of the bot user within the tenant.
  
  Can be one of: "active""disabled""deleted"
  
  subject string
  
  Required
  
  The unique bot user identifier which incorporates the client ID.
  
  clientId string
  
  Required
  
  The OAuth client ID that the bot user belongs to.
  
  tenantId string
  
  Required
  
  The tenant that the bot user belongs to.
  
  format = "uid"
  
  createdAt string
  
  The timestamp for when the bot user record was created.
  
  format = "date-time"
  
  assignedRoles array of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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 bot user record was last updated.
  
  format = "date-time"
  
  assignedGroups array of objects
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identifier
  
  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
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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"

com.qlik.core.user.deleted

Example payload of the "User deleted" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.user.deleted",
  "source": "com.qlik/identities",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "string",
    "email": "string",
    "groups": [
      "group1",
      "group2"
    ],
    "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": "507f191e810c19729de860ea",
        "name": "Finance",
        "providerType": "custom",
        "assignedRoles": [
          {
            "id": "507f191e810c19729de860ea",
            "name": "My Custom Role",
            "type": "custom",
            "level": "user"
          }
        ]
      }
    ],
    "preferredLocale": "string",
    "preferredZoneinfo": "string"
  }
}

Published when a new user is provisioned by an IdP.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

The type of the event.

default = "com.qlik.core.user.provisioned"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/identities"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
userid string

Unique identifier for the user triggering the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
data object

The event data payload containing provisioned user details.
Show data properties
- id string
  
  Required
  
  The unique user identifier.
  
  format = "uid"
- name string
  
  The name of the user.
- email string
  
  The email address for the user.
- locale string
  
  Represents the end-user's language tag.
- status string
  
  The status of the provisioned user within the tenant.
- picture string
  
  A static url linking to the avatar of the user.
  
  format = "url"
- subject string
  
  The unique user identifier from an identity provider.
- tenantId string
  
  Required
  
  The tenant that the user belongs to.
  
  format = "uid"
- zoneinfo string
  
  Represents the end-user's time zone.
- createdAt string
  
  The timestamp for when the user record was provisioned.
  
  format = "date-time"
- lastUpdatedAt string
  
  The timestamp for when the user record was last updated.
  
  format = "date-time"

com.qlik.core.user.provisioned

Example payload of the "User provisioned" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.user.provisioned",
  "source": "com.qlik/identities",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "id": "507f191e810c19729de860ea",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "locale": "en-US",
    "status": "provisioned",
    "subject": "auth0\\user123",
    "tenantId": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
    "zoneinfo": "America/New_York",
    "createdAt": "2025-11-25T10:30:00Z",
    "lastUpdatedAt": "2025-11-25T10:30:00Z"
  }
}

Published when a user is updated.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

The type of the event.

default = "com.qlik.core.user.updated"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/identities"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
userid string

Unique identifier for the user triggering the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
data object

The event data payload containing updated user details. It combines the _updates change set (see the updateObject schema) with the updated user record, which conforms to the user schema for human users, or the botUser schema for bot (service) accounts.
One of:
- user object
  Show user properties
  
  id string
  
  Required
  
  The unique user identifier.
  
  format = "uid"
  
  name string
  
  Required
  
  The name of the user.
  
  email string
  
  The email address for the user.
  
  groups array of strings
  
  References to IdP groups assigned to the user.
  
  locale string
  
  Represents the end-user's language tag.
  
  status string
  
  The status of the user within the tenant.
  
  Can be one of: "active""invited""disabled""deleted"
  
  picture string
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subject string
  
  Required
  
  The unique user identifier from an identity provider.
  
  tenantId string
  
  Required
  
  The tenant that the user belongs to.
  
  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 number of seconds until the user invitation will expire.
  
  assignedRoles array of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identifier
  
  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
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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"
  
  preferredLocale string
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfo string
  
  Represents the end-user's preferred time zone.
- botUser object
  Show botUser properties
  
  id string
  
  Required
  
  The unique bot user identifier.
  
  format = "uid"
  
  name string
  
  Required
  
  The name of the bot user.
  
  groups array of strings
  
  Group names associated to the bot user.
  
  status string
  
  The status of the bot user within the tenant.
  
  Can be one of: "active""disabled""deleted"
  
  subject string
  
  Required
  
  The unique bot user identifier which incorporates the client ID.
  
  clientId string
  
  Required
  
  The OAuth client ID that the bot user belongs to.
  
  tenantId string
  
  Required
  
  The tenant that the bot user belongs to.
  
  format = "uid"
  
  createdAt string
  
  The timestamp for when the bot user record was created.
  
  format = "date-time"
  
  assignedRoles array of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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 bot user record was last updated.
  
  format = "date-time"
  
  assignedGroups array of objects
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  id string
  
  Required
  
  The unique group identifier
  
  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
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  The unique role identifier
  
  format = "uid"
  
  name string
  
  Required
  
  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"

com.qlik.core.user.updated

Example payload of the "User updated" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.user.updated",
  "source": "com.qlik/identities",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "_updates": [
      {
        "path": "/name",
        "newValue": "Dan",
        "oldValue": "Dylan"
      },
      {
        "path": "/email",
        "newValue": "dan@example.com",
        "oldValue": "dylan@example.com"
      }
    ]
  }
}