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

idstring
Required

Identifies the event.

minLength = 1
timestring

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

minLength = 1, format = "date-time"
typestring
Required

The type of the event.

default = "com.qlik.core.user.created"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/identities"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

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

minLength = 1
useridstring

Unique identifier for the user triggering the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

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:
- userobject
  Show user properties
  
  idstring
  Required
  
  The unique user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the user.
  
  emailstring
  
  The email address for the user.
  
  groupsarray of strings
  
  References to IdP groups assigned to the user.
  
  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"
  
  picturestring
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subjectstring
  Required
  
  The unique user identifier from an identity provider.
  
  tenantIdstring
  Required
  
  The tenant that the user belongs to.
  
  format = "uid"
  
  zoneinfostring
  
  Represents the end-user's time zone.
  
  createdAtstring
  
  The timestamp for when the user record was created.
  
  format = "date-time"
  
  inviteExpirynumber
  
  The number of seconds until the user invitation will expire.
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identifier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  providerTypestring
  
  The provider type of the group.
  
  Can be one of: "idp""custom"
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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"
  
  preferredLocalestring
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfostring
  
  Represents the end-user's preferred time zone.
- botUserobject
  Show botUser properties
  
  idstring
  Required
  
  The unique bot user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the bot user.
  
  groupsarray of strings
  
  Group names associated to the bot user.
  
  statusstring
  
  The status of the bot user within the tenant.
  
  Can be one of: "active""disabled""deleted"
  
  subjectstring
  Required
  
  The unique bot user identifier which incorporates the client ID.
  
  clientIdstring
  Required
  
  The OAuth client ID that the bot user belongs to.
  
  tenantIdstring
  Required
  
  The tenant that the bot user belongs to.
  
  format = "uid"
  
  createdAtstring
  
  The timestamp for when the bot user record was created.
  
  format = "date-time"
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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 bot user record was last updated.
  
  format = "date-time"
  
  assignedGroupsarray of objects
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identifier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  providerTypestring
  
  The provider type of the group.
  
  Can be one of: "idp""custom"
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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"

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

idstring
Required

Identifies the event.

minLength = 1
timestring

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

minLength = 1, format = "date-time"
typestring
Required

The type of the event.

default = "com.qlik.core.user.deleted"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/identities"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

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

minLength = 1
useridstring

Unique identifier for the user triggering the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

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:
- userobject
  Show user properties
  
  idstring
  Required
  
  The unique user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the user.
  
  emailstring
  
  The email address for the user.
  
  groupsarray of strings
  
  References to IdP groups assigned to the user.
  
  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"
  
  picturestring
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subjectstring
  Required
  
  The unique user identifier from an identity provider.
  
  tenantIdstring
  Required
  
  The tenant that the user belongs to.
  
  format = "uid"
  
  zoneinfostring
  
  Represents the end-user's time zone.
  
  createdAtstring
  
  The timestamp for when the user record was created.
  
  format = "date-time"
  
  inviteExpirynumber
  
  The number of seconds until the user invitation will expire.
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identifier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  providerTypestring
  
  The provider type of the group.
  
  Can be one of: "idp""custom"
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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"
  
  preferredLocalestring
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfostring
  
  Represents the end-user's preferred time zone.
- botUserobject
  Show botUser properties
  
  idstring
  Required
  
  The unique bot user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the bot user.
  
  groupsarray of strings
  
  Group names associated to the bot user.
  
  statusstring
  
  The status of the bot user within the tenant.
  
  Can be one of: "active""disabled""deleted"
  
  subjectstring
  Required
  
  The unique bot user identifier which incorporates the client ID.
  
  clientIdstring
  Required
  
  The OAuth client ID that the bot user belongs to.
  
  tenantIdstring
  Required
  
  The tenant that the bot user belongs to.
  
  format = "uid"
  
  createdAtstring
  
  The timestamp for when the bot user record was created.
  
  format = "date-time"
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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 bot user record was last updated.
  
  format = "date-time"
  
  assignedGroupsarray of objects
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identifier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  providerTypestring
  
  The provider type of the group.
  
  Can be one of: "idp""custom"
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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"

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

idstring
Required

Identifies the event.

minLength = 1
timestring

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

minLength = 1, format = "date-time"
typestring
Required

The type of the event.

default = "com.qlik.core.user.provisioned"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/identities"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

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

minLength = 1
useridstring

Unique identifier for the user triggering the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

The event data payload containing provisioned user details.
Show data properties
- idstring
  Required
  
  The unique user identifier.
  
  format = "uid"
- namestring
  
  The name of the user.
- emailstring
  
  The email address for the user.
- localestring
  
  Represents the end-user's language tag.
- statusstring
  
  The status of the provisioned user within the tenant.
- picturestring
  
  A static url linking to the avatar of the user.
  
  format = "url"
- subjectstring
  
  The unique user identifier from an identity provider.
- tenantIdstring
  Required
  
  The tenant that the user belongs to.
  
  format = "uid"
- zoneinfostring
  
  Represents the end-user's time zone.
- createdAtstring
  
  The timestamp for when the user record was provisioned.
  
  format = "date-time"
- lastUpdatedAtstring
  
  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

idstring
Required

Identifies the event.

minLength = 1
timestring

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

minLength = 1, format = "date-time"
typestring
Required

The type of the event.

default = "com.qlik.core.user.updated"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/identities"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

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

minLength = 1
useridstring

Unique identifier for the user triggering the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

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:
- userobject
  Show user properties
  
  idstring
  Required
  
  The unique user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the user.
  
  emailstring
  
  The email address for the user.
  
  groupsarray of strings
  
  References to IdP groups assigned to the user.
  
  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"
  
  picturestring
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subjectstring
  Required
  
  The unique user identifier from an identity provider.
  
  tenantIdstring
  Required
  
  The tenant that the user belongs to.
  
  format = "uid"
  
  zoneinfostring
  
  Represents the end-user's time zone.
  
  createdAtstring
  
  The timestamp for when the user record was created.
  
  format = "date-time"
  
  inviteExpirynumber
  
  The number of seconds until the user invitation will expire.
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identifier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  providerTypestring
  
  The provider type of the group.
  
  Can be one of: "idp""custom"
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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"
  
  preferredLocalestring
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfostring
  
  Represents the end-user's preferred time zone.
- botUserobject
  Show botUser properties
  
  idstring
  Required
  
  The unique bot user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the bot user.
  
  groupsarray of strings
  
  Group names associated to the bot user.
  
  statusstring
  
  The status of the bot user within the tenant.
  
  Can be one of: "active""disabled""deleted"
  
  subjectstring
  Required
  
  The unique bot user identifier which incorporates the client ID.
  
  clientIdstring
  Required
  
  The OAuth client ID that the bot user belongs to.
  
  tenantIdstring
  Required
  
  The tenant that the bot user belongs to.
  
  format = "uid"
  
  createdAtstring
  
  The timestamp for when the bot user record was created.
  
  format = "date-time"
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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 bot user record was last updated.
  
  format = "date-time"
  
  assignedGroupsarray of objects
  
  A group assigned to the user.
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identifier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  providerTypestring
  
  The provider type of the group.
  
  Can be one of: "idp""custom"
  
  assignedRolesarray of objects
  
  A role assigned to the user.
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identifier
  
  format = "uid"
  
  namestring
  Required
  
  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"

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"
      }
    ],
    "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"
  }
}