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.

These events are available for consumption via:

Audits (Events)

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

Unique identifier for the event type.

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

Identifies the context in which an event happened.

minLength = 1, 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.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

Details of the tenant.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- namestring
  
  Tenant name.
- hostnamesarray of strings
  
  List of hostname(s) associated with the tenant.
- allowDeactivateUntilstring
  
  Timestamp until which the tenant can be deactivated.
  
  format = "date-time"

com.qlik.v1.tenant.allowed-deactivate

Example payload of the "Tenant allowed deactivate" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.v1.tenant.allowed-deactivate",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "tenantid": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "Example Tenant",
    "hostnames": [
      "example-tenant.us.qlikcloud.com",
      "example-tenant.eu.qlikcloud.com"
    ],
    "allowDeactivateUntil": "2026-06-24T18:28:31.301Z"
  }
}

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

Unique identifier for the event type.

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

Identifies the context in which an event happened.

minLength = 1, 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.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

Details of the created 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.
- licenseIdstring
  
  License identifier associated with the tenant.

com.qlik.tenant.created

Example payload of the "Tenant created" event

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

Published when the tenant status changes from active to disabled.

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

Unique identifier for the event type.

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

Identifies the context in which an event happened.

minLength = 1, 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.
tenantidstring
Required

Unique identifier for the tenant related to the 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.v1.tenant.deactivated

Example payload of the "Tenant deactivated" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.v1.tenant.deactivated",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "tenantid": "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

Unique identifier for the event type.

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

Identifies the context in which an event happened.

minLength = 1, 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.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

Details of the deleted 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.

com.qlik.tenant.deleted

Example payload of the "Tenant deleted" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.tenant.deleted",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "tenantid": "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

Unique identifier for the event type.

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

Identifies the context in which an event happened.

minLength = 1, 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.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

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

com.qlik.v1.tenant.disallowed-deactivate

Example payload of the "Tenant disallowed deactivate" event

{
  "id": "A234-1234-1234",
  "time": "2025-04-21T13:45:30Z",
  "type": "com.qlik.v1.tenant.disallowed-deactivate",
  "source": "com.qlik/tenants",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "507f1f77bcf86cd799439011",
  "tenantid": "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

Unique identifier for the event type.

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

Identifies the context in which an event happened.

minLength = 1, 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.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

Details of the reactivated tenant.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- namestring
  
  Tenant name.
- hostnamesarray of strings
  
  List of hostname(s) associated with the tenant.
- statusesDisallowedarray of strings
  
  List of statuses that are disallowed for the tenant.

com.qlik.v1.tenant.reactivated

Example payload of the "Tenant reactivated" event

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

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

Unique identifier for the event type.

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

Identifies the context in which an event happened.

minLength = 1, 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.
tenantidstring
Required

Unique identifier for the tenant related to the event.
dataobject

Details of the updated tenant.
Show data properties
- idstring
  Required
  
  Identifier of the tenant.
- updatesarray of objects
  Required
  
  Collection of updates performed on the resource.
  
  Show updates properties
  
  newValuestring
  
  Value of the field after the update.
  
  oldValuestring
  
  Value of the field before the update.
  
  propertystring
  
  Property that has changed.
- hostnamesarray of strings
  Required
  
  List of hostname(s) associated with the tenant.
- licenseIdstring
  Required
  
  License identifier associated with the tenant.
- parentTenantIdstring
  
  Parent license identifier associated with the tenant.
- capabilityBankIdstring
  
  Capability bank identifier associated with the license.

com.qlik.tenant.updated

Example payload of the "Tenant updated" event

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