Groups

Download AsyncAPI spec

Events emitted when groups are created, updated, deleted, or have their user membership modified in a Qlik Cloud tenant. These events enable real-time tracking of group lifecycle and user assignment changes.

Preferred events

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

Published when a group is created in the tenant.

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

Unique identifier for the event type.

default = "com.qlik.core.group.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

Represents a group.
Show data properties
- id string
  
  Required
  
  Unique identifier for the group.
  
  format = "uid"
- name string
  
  Required
  
  Name of the group as it appears in the identity provider.
- idpId string
  
  Unique identifier for the source identity provider.
  
  format = "uid"
- status string
  
  Required
  
  Current status for the group within the platform.
  
  Can be one of: "active""disabled"
- tenantId string
  
  Required
  
  Unique identifier for the tenant associated with the given group.
  
  format = "uid"
- createdAt string
  
  Required
  
  Timestamp when the group was created in the platform.
  
  format = "date-time"
- createdBy string
  
  Unique identifier for the user who created this group.
- updatedBy string
  
  Unique identifier for the user who last updated this group.
- description string
  
  User-defined description for custom groups.
- providerType string
  
  Filterable
  
  The type of provider for the group.
  
  Can be one of: "idp""custom"
- assignedRoles array of objects
  
  A role assigned to the group.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  Unique identifier for this role.
  
  format = "uid"
  
  name string
  
  Required
  
  Name of the role.
  
  type string
  
  Required
  
  Whether the role is a default Qlik role or a custom role.
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  Role level (admin or user).
  
  Can be one of: "admin""user"
- lastUpdatedAt string
  
  Required
  
  Timestamp when the group was last updated in the platform.
  
  format = "date-time"

com.qlik.core.group.created

Example payload of the "Group created" event

{
  "id": "A234-1234-1234",
  "time": "2018-04-05T17:31:00Z",
  "type": "com.qlik.core.group.created",
  "source": "com.qlik/identities",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "id": "507f191e810c19729de860ea",
    "name": "Development",
    "idpId": "4ecbe7f9e8c1c9092c000027",
    "status": "active",
    "tenantId": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
    "createdAt": "2021-03-21T17:32:28Z",
    "createdBy": "string",
    "updatedBy": "string",
    "description": "Development team group",
    "providerType": "idp",
    "assignedRoles": [
      {
        "id": "507f191e810c19729de860ea",
        "name": "My Custom Role",
        "type": "custom",
        "level": "user"
      }
    ],
    "lastUpdatedAt": "2021-03-22T10:01:02Z"
  }
}

Published when a group is removed from the tenant.

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

Unique identifier for the event type.

default = "com.qlik.core.group.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

Represents a group.
Show data properties
- id string
  
  Required
  
  Unique identifier for the group.
  
  format = "uid"
- name string
  
  Required
  
  Name of the group as it appears in the identity provider.
- idpId string
  
  Unique identifier for the source identity provider.
  
  format = "uid"
- status string
  
  Required
  
  Current status for the group within the platform.
  
  Can be one of: "active""disabled"
- tenantId string
  
  Required
  
  Unique identifier for the tenant associated with the given group.
  
  format = "uid"
- createdAt string
  
  Required
  
  Timestamp when the group was created in the platform.
  
  format = "date-time"
- createdBy string
  
  Unique identifier for the user who created this group.
- updatedBy string
  
  Unique identifier for the user who last updated this group.
- description string
  
  User-defined description for custom groups.
- providerType string
  
  Filterable
  
  The type of provider for the group.
  
  Can be one of: "idp""custom"
- assignedRoles array of objects
  
  A role assigned to the group.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  Unique identifier for this role.
  
  format = "uid"
  
  name string
  
  Required
  
  Name of the role.
  
  type string
  
  Required
  
  Whether the role is a default Qlik role or a custom role.
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  Role level (admin or user).
  
  Can be one of: "admin""user"
- lastUpdatedAt string
  
  Required
  
  Timestamp when the group was last updated in the platform.
  
  format = "date-time"

com.qlik.core.group.deleted

Example payload of the "Group deleted" event

{
  "id": "A234-1234-1234",
  "time": "2018-04-05T17:31:00Z",
  "type": "com.qlik.core.group.deleted",
  "source": "com.qlik/identities",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "id": "507f191e810c19729de860ea",
    "name": "Development",
    "idpId": "4ecbe7f9e8c1c9092c000027",
    "status": "active",
    "tenantId": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
    "createdAt": "2021-03-21T17:32:28Z",
    "createdBy": "string",
    "updatedBy": "string",
    "description": "Development team group",
    "providerType": "idp",
    "assignedRoles": [
      {
        "id": "507f191e810c19729de860ea",
        "name": "My Custom Role",
        "type": "custom",
        "level": "user"
      }
    ],
    "lastUpdatedAt": "2021-03-22T10:01:02Z"
  }
}

Published when a group 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

Unique identifier for the event type.

default = "com.qlik.core.group.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 the updated group and the _updates field-level change set.
Show data properties
- id string
  
  Required
  
  Unique identifier for the group.
  
  format = "uid"
- name string
  
  Required
  
  Name of the group as it appears in the identity provider.
- idpId string
  
  Unique identifier for the source identity provider.
  
  format = "uid"
- status string
  
  Required
  
  Current status for the group within the platform.
  
  Can be one of: "active""disabled"
- tenantId string
  
  Required
  
  Unique identifier for the tenant associated with the given group.
  
  format = "uid"
- createdAt string
  
  Required
  
  Timestamp when the group was created in the platform.
  
  format = "date-time"
- createdBy string
  
  Unique identifier for the user who created this group.
- updatedBy string
  
  Unique identifier for the user who last updated this group.
- description string
  
  User-defined description for custom groups.
- providerType string
  
  Filterable
  
  The type of provider for the group.
  
  Can be one of: "idp""custom"
- assignedRoles array of objects
  
  A role assigned to the group.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  Unique identifier for this role.
  
  format = "uid"
  
  name string
  
  Required
  
  Name of the role.
  
  type string
  
  Required
  
  Whether the role is a default Qlik role or a custom role.
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  Role level (admin or user).
  
  Can be one of: "admin""user"
- lastUpdatedAt string
  
  Required
  
  Timestamp when the group was last updated in the platform.
  
  format = "date-time"
- _updates array of objects
  
  Collection of updates performed on the resource.
  
  Show _updates properties
  
  path string
  
  Field that was updated.
  
  newValue any
  
  JSON value of the field after the update. The value can be a scalar, array, object, or null, depending on the field.
  
  oldValue any
  
  JSON value of the field before the update. The value can be a scalar, array, object, or null, depending on the field.

com.qlik.core.group.updated

Example payload of the "Group updated" event

{
  "id": "A234-1234-1234",
  "time": "2018-04-05T17:31:00Z",
  "type": "com.qlik.core.group.updated",
  "source": "com.qlik/identities",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "id": "507f191e810c19729de860ea",
    "name": "Development",
    "idpId": "4ecbe7f9e8c1c9092c000027",
    "status": "active",
    "tenantId": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
    "createdAt": "2021-03-21T17:32:28Z",
    "createdBy": "string",
    "updatedBy": "string",
    "description": "Development team group",
    "providerType": "idp",
    "assignedRoles": [
      {
        "id": "507f191e810c19729de860ea",
        "name": "My Custom Role",
        "type": "custom",
        "level": "user"
      }
    ],
    "lastUpdatedAt": "2021-03-22T10:01:02Z",
    "_updates": [
      {
        "path": "/attributePath",
        "newValue": "Dan",
        "oldValue": "Dylan"
      }
    ]
  }
}

Published when a group has been updated or deleted, with a list of affected users. For large groups, multiple events are sent, each with different affectedUsers, for the same group update/delete event. Check fullyProcessed to determine if additional events are coming.

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

Unique identifier for the event type.

default = "com.qlik.core.group.users.modified"
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 the modified group, affected users, processing status, deletion status, and the _updates field-level change set.
Show data properties
- id string
  
  Required
  
  Unique identifier for the group.
  
  format = "uid"
- name string
  
  Required
  
  Name of the group as it appears in the identity provider.
- idpId string
  
  Unique identifier for the source identity provider.
  
  format = "uid"
- status string
  
  Required
  
  Current status for the group within the platform.
  
  Can be one of: "active""disabled"
- tenantId string
  
  Required
  
  Unique identifier for the tenant associated with the given group.
  
  format = "uid"
- createdAt string
  
  Required
  
  Timestamp when the group was created in the platform.
  
  format = "date-time"
- createdBy string
  
  Unique identifier for the user who created this group.
- updatedBy string
  
  Unique identifier for the user who last updated this group.
- description string
  
  User-defined description for custom groups.
- providerType string
  
  Filterable
  
  The type of provider for the group.
  
  Can be one of: "idp""custom"
- assignedRoles array of objects
  
  A role assigned to the group.
  
  Show assignedRoles properties
  
  id string
  
  Required
  
  Unique identifier for this role.
  
  format = "uid"
  
  name string
  
  Required
  
  Name of the role.
  
  type string
  
  Required
  
  Whether the role is a default Qlik role or a custom role.
  
  Can be one of: "default""custom"
  
  level string
  
  Required
  
  Role level (admin or user).
  
  Can be one of: "admin""user"
- lastUpdatedAt string
  
  Required
  
  Timestamp when the group was last updated in the platform.
  
  format = "date-time"
- _updates array of objects
  
  Collection of updates performed on the resource.
  
  Show _updates properties
  
  path string
  
  Field that was updated.
  
  newValue any
  
  JSON value of the field after the update. The value can be a scalar, array, object, or null, depending on the field.
  
  oldValue any
  
  JSON value of the field before the update. The value can be a scalar, array, object, or null, depending on the field.
- deleted boolean
  
  Describes whether the group was deleted (true) or only updated (false).
- affectedUsers array of strings
  
  A list of user original IDs affected by this group update or delete.
- fullyProcessed boolean
  
  Describes whether all affected users are included in this event or if additional events will be sent for the same group change.

com.qlik.core.group.users.modified

Example payload of the "Group modified affecting multiple users" event

{
  "id": "A234-1234-1234",
  "time": "2018-04-05T17:31:00Z",
  "type": "com.qlik.core.group.users.modified",
  "source": "com.qlik/identities",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "id": "507f191e810c19729de860ea",
    "name": "Development",
    "idpId": "4ecbe7f9e8c1c9092c000027",
    "status": "active",
    "tenantId": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
    "createdAt": "2021-03-21T17:32:28Z",
    "createdBy": "string",
    "updatedBy": "string",
    "description": "Development team group",
    "providerType": "idp",
    "assignedRoles": [
      {
        "id": "507f191e810c19729de860ea",
        "name": "My Custom Role",
        "type": "custom",
        "level": "user"
      }
    ],
    "lastUpdatedAt": "2021-03-22T10:01:02Z",
    "_updates": [
      {
        "path": "/attributePath",
        "newValue": "Dan",
        "oldValue": "Dylan"
      }
    ],
    "deleted": true,
    "affectedUsers": [
      "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT"
    ],
    "fullyProcessed": true
  }
}