User sessions

Download AsyncAPI spec

Events emitted when user sessions begin or end in a Qlik Cloud tenant. These events enable monitoring of user authentication events for security and audit purposes.

These events are available for consumption via:

Deprecation notice

These events are deprecated and will be removed on or after November 30, 2026.

Use the User sessions events in the core namespace instead. For the full event mapping, see the deprecation notice.

Session begin

Published when a user session 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 event.

    default = "com.qlik.user-session.begin"

  • source string
    Required

    Identifies the context in which an event happened.

    minLength = 1, format = "uri-reference"

  • 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, default = "application/json"

  • userid string

    Unique identifier for the user triggering the event.

  • authtype string

    The type of principal that triggered the occurrence.

  • originip string

    Origin IP address.

  • tenantid string
    Required

    Unique identifier for the tenant related to the event.

  • sessionid string

    Unique identifier for the session related to the event.

  • authclaims string

    A JSON string representing claims of the principal that triggered the event

  • data object
    Required

    Data specific to the user session begin event.

    Show data properties
    • idpId string

      Identifier of the identity provider through which the session was initiated. null if user logged in using Qlik Account.

    • source string

      The source of the event.

      Can be one of: "com.qlik/edge-auth"

    • subject string

      User's subject in our DB.

    • recovery boolean

      Whether the session is part of a recovery login.

    • userType string

      The user's type, only specified for anonymous users.

      Can be one of: "anonymous"

com.qlik.user-session.begin

Example payload of the "Session begin" event

{
  "id": "A234-1234-1234",
  "time": "2026-01-01T12:00:00Z",
  "type": "com.qlik.user-session.begin",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "605a18af2ab08cdbfad09259",
  "authtype": "service_account",
  "originip": "0.0.0.0",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "sessionid": "WZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\\\"iss\\\":\\\"qlik.api.internal/service\\\",\\\"sub\\\":\\\"service\\\",\\\"subType\\\":\\\"service\\\"}",
  "data": {
    "idpId": "661d627cef218789bbd67cc9",
    "source": "com.qlik/edge-auth",
    "subject": "auth0\\foo",
    "recovery": false
  }
}

Session end

Published when a user session ends.

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 event.

    default = "com.qlik.user-session.end"

  • source string
    Required

    Identifies the context in which an event happened.

    minLength = 1, format = "uri-reference"

  • 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, default = "application/json"

  • userid string

    Unique identifier for the user triggering the event.

  • authtype string

    The type of principal that triggered the occurrence.

  • originip string

    Origin IP address.

  • tenantid string
    Required

    Unique identifier for the tenant related to the event.

  • sessionid string

    Unique identifier for the session related to the event.

  • authclaims string

    A JSON string representing claims of the principal that triggered the event

  • data object
    Required

    Data specific to the user session end event.

    Show data properties
    • subject string

      User's subject in our DB.

com.qlik.user-session.end

Example payload of the "Session end" event

{
  "id": "A234-1234-1234",
  "time": "2026-01-01T12:00:00Z",
  "type": "com.qlik.user-session.end",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "605a18af2ab08cdbfad09259",
  "authtype": "service_account",
  "originip": "0.0.0.0",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "sessionid": "WZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\\\"iss\\\":\\\"qlik.api.internal/service\\\",\\\"sub\\\":\\\"service\\\",\\\"subType\\\":\\\"service\\\"}",
  "data": {
    "subject": "auth0\\foo"
  }
}