Group settings

Download AsyncAPI spec

Events emitted when group settings are updated in a Qlik Cloud tenant. These events enable monitoring of group configuration changes across your tenant.

Preferred events

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

Group settings updated

Published when the group settings are 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-setting.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 settings and the _updates field-level change set.

    Show data properties
    • created string

      Timestamp when the group settings record was created.

      format = "date-time"

    • tenantId string
      Required

      Unique identifier for the tenant.

      format = "uid"

    • lastUpdated string

      Timestamp when the group settings record was last updated.

      format = "date-time"

    • syncIdpGroups boolean Deprecated

      Deprecated. Previously controlled whether groups from the identity provider were synchronized into Qlik Cloud. No longer used; group synchronization is now governed by autoCreateGroups.

    • autoCreateGroups boolean
      Required

      Whether to automatically create groups in Qlik Cloud when they appear in the identity provider.

    • _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-setting.updated

Example payload of the "Group settings updated" event

{
  "id": "A234-1234-1234",
  "time": "2018-04-05T17:31:00Z",
  "type": "com.qlik.core.group-setting.updated",
  "source": "com.qlik/identities",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "created": "2018-10-30T07:06:22Z",
    "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "lastUpdated": "2018-10-30T07:06:22Z",
    "syncIdpGroups": false,
    "autoCreateGroups": false,
    "_updates": [
      {
        "path": "/attributePath",
        "newValue": "Dan",
        "oldValue": "Dylan"
      }
    ]
  }
}