Tenants

Download AsyncAPI spec

Events emitted when tenants are created, updated, deleted, deactivated, or reactivated in Qlik Cloud. These events enable monitoring of tenant lifecycle and status changes.

Preferred events

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

Published when deactivation is allowed for a tenant.

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

Describes the type of event related to the originating occurrence.

default = "com.qlik.core.tenant.allowed-deactivate"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/tenants"
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.
authtypestring

Type of authentication context for the actor that triggered the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
authclaimsstring

Serialized authentication claims for the actor that triggered the event.
toplevelresourceidstring

Identifier of the top-level resource related to the event. Only present on the Talend metadata updated event.
dataobject

Details of the tenant. Contains the full tenant object.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- namestring
  Required
  
  Tenant name.
- hostnamesarray of strings
  Required
  
  List of hostname(s) associated with the tenant.

com.qlik.core.tenant.allowed-deactivate

Example payload of the "Tenant deactivation allowed" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.tenant.allowed-deactivate",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "authtype": "tenants",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "authclaims": "{\"sub\":\"507f1f77bcf86cd799439011\"}",
  "toplevelresourceid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "Example Tenant",
    "hostnames": [
      "example-tenant.us.qlikcloud.com",
      "example-tenant.eu.qlikcloud.com"
    ]
  }
}

Published when a new tenant 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

Describes the type of event related to the originating occurrence.

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

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/tenants"
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.
authtypestring

Type of authentication context for the actor that triggered the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
authclaimsstring

Serialized authentication claims for the actor that triggered the event.
toplevelresourceidstring

Identifier of the top-level resource related to the event. Only present on the Talend metadata updated event.
dataobject

Details of the created tenant. Contains the full tenant object.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- namestring
  Required
  
  Tenant name.
- hostnamesarray of strings
  Required
  
  List of hostname(s) associated with the tenant.

com.qlik.core.tenant.created

Example payload of the "Tenant created" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.tenant.created",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "authtype": "tenants",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "authclaims": "{\"sub\":\"507f1f77bcf86cd799439011\"}",
  "toplevelresourceid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "Example Tenant",
    "hostnames": [
      "example-tenant.us.qlikcloud.com",
      "example-tenant.eu.qlikcloud.com"
    ]
  }
}

Published when the tenant is deactivated, either when its status changes from active to disabled or when its disallowed statuses are 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

Describes the type of event related to the originating occurrence.

default = "com.qlik.core.tenant.deactivated"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/tenants"
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.
authtypestring

Type of authentication context for the actor that triggered the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
authclaimsstring

Serialized authentication claims for the actor that triggered the event.
toplevelresourceidstring

Identifier of the top-level resource related to the event. Only present on the Talend metadata updated event.
dataobject

Details of the deactivated tenant.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- namestring
  Required
  
  Tenant name.
- hostnamesarray of strings
  Required
  
  List of hostname(s) associated with the tenant.
- purgeDatestring
  
  Scheduled purge date when a user or OEM deactivates the tenant.
  
  format = "date-time"
- statusesDisallowedarray of strings
  
  List of statuses that are disallowed for the tenant.

com.qlik.core.tenant.deactivated

Example payload of the "Tenant deactivated" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.tenant.deactivated",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "authtype": "tenants",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "authclaims": "{\"sub\":\"507f1f77bcf86cd799439011\"}",
  "toplevelresourceid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "Example Tenant",
    "hostnames": [
      "example-tenant.us.qlikcloud.com",
      "example-tenant.eu.qlikcloud.com"
    ],
    "purgeDate": "2026-06-24T18:28:31.301Z",
    "statusesDisallowed": [
      "active"
    ]
  }
}

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

Describes the type of event related to the originating occurrence.

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

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/tenants"
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.
authtypestring

Type of authentication context for the actor that triggered the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
authclaimsstring

Serialized authentication claims for the actor that triggered the event.
toplevelresourceidstring

Identifier of the top-level resource related to the event. Only present on the Talend metadata updated event.
dataobject

Details of the deleted tenant. Contains the full tenant object.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- namestring
  Required
  
  Tenant name.
- hostnamesarray of strings
  Required
  
  List of hostname(s) associated with the tenant.

com.qlik.core.tenant.deleted

Example payload of the "Tenant deleted" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.tenant.deleted",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "authtype": "tenants",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "authclaims": "{\"sub\":\"507f1f77bcf86cd799439011\"}",
  "toplevelresourceid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "Example Tenant",
    "hostnames": [
      "example-tenant.us.qlikcloud.com",
      "example-tenant.eu.qlikcloud.com"
    ]
  }
}

Published when deactivation is disallowed for a tenant.

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

Describes the type of event related to the originating occurrence.

default = "com.qlik.core.tenant.disallowed-deactivate"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/tenants"
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.
authtypestring

Type of authentication context for the actor that triggered the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
authclaimsstring

Serialized authentication claims for the actor that triggered the event.
toplevelresourceidstring

Identifier of the top-level resource related to the event. Only present on the Talend metadata updated event.
dataobject

Details of the tenant. Contains the full tenant object.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- namestring
  Required
  
  Tenant name.
- hostnamesarray of strings
  Required
  
  List of hostname(s) associated with the tenant.

com.qlik.core.tenant.disallowed-deactivate

Example payload of the "Tenant deactivation disallowed" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.tenant.disallowed-deactivate",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "authtype": "tenants",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "authclaims": "{\"sub\":\"507f1f77bcf86cd799439011\"}",
  "toplevelresourceid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "Example Tenant",
    "hostnames": [
      "example-tenant.us.qlikcloud.com",
      "example-tenant.eu.qlikcloud.com"
    ]
  }
}

Published when the tenant status changes from disabled to active.

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

Describes the type of event related to the originating occurrence.

default = "com.qlik.core.tenant.reactivated"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/tenants"
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.
authtypestring

Type of authentication context for the actor that triggered the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
authclaimsstring

Serialized authentication claims for the actor that triggered the event.
toplevelresourceidstring

Identifier of the top-level resource related to the event. Only present on the Talend metadata updated event.
dataobject

Details of the reactivated tenant. Contains the full tenant object.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- namestring
  Required
  
  Tenant name.
- hostnamesarray of strings
  Required
  
  List of hostname(s) associated with the tenant.

com.qlik.core.tenant.reactivated

Example payload of the "Tenant reactivated" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.tenant.reactivated",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "authtype": "tenants",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "authclaims": "{\"sub\":\"507f1f77bcf86cd799439011\"}",
  "toplevelresourceid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "Example Tenant",
    "hostnames": [
      "example-tenant.us.qlikcloud.com",
      "example-tenant.eu.qlikcloud.com"
    ]
  }
}

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

Describes the type of event related to the originating occurrence.

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

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference", default = "com.qlik/tenants"
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.
authtypestring

Type of authentication context for the actor that triggered the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
authclaimsstring

Serialized authentication claims for the actor that triggered the event.
toplevelresourceidstring

Identifier of the top-level resource related to the event. Only present on the Talend metadata updated event.
dataobject

Details of the updated tenant. Contains the full tenant object plus the list of applied updates.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- namestring
  Required
  
  Tenant name.
- hostnamesarray of strings
  Required
  
  List of hostname(s) associated with the tenant.
- _updatesarray of objects
  Required
  
  Collection of updates performed on the resource, in JSON Pointer form.
  
  Show _updates properties
  
  pathstring
  
  JSON Pointer path of the property that has changed.
  
  newValueany
  
  Value of the field after the update. The JSON value type depends on the field identified by path.
  
  oldValueany
  
  Value of the field before the update. The JSON value type depends on the field identified by path.

com.qlik.core.tenant.updated

Example payload of the "Tenant updated" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.core.tenant.updated",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "authtype": "tenants",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "authclaims": "{\"sub\":\"507f1f77bcf86cd799439011\"}",
  "toplevelresourceid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "Example Tenant",
    "hostnames": [
      "example-tenant.us.qlikcloud.com",
      "example-tenant.eu.qlikcloud.com"
    ],
    "_updates": [
      {
        "path": "/name",
        "newValue": "Example Tenant Updated",
        "oldValue": "Example Tenant"
      }
    ]
  }
}