Licenses

Download AsyncAPI spec

License events provide information about license usage, entitlement changes, and license-related transactions across your Qlik Cloud tenant.

Event triggered when a license assignment is deleted.

Payload

object

id string

Unique identifier of the event.
time string

Timestamp of when the event happened.

format = "date-time"
type string

Required

The event type identifier.

default = "com.qlik.license.assignment.deleted"
source string

The source of the event.
specversion string

CloudEvents spec version.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
authtype string

The type of principal that triggered the event.
authclaims string

JSON string representing claims of the principal.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Required
Show data properties
- type string
  
  Assignment type. May be an empty string when the assignment has no allotment name.
- origin string
  
  Required
  
  event origin:
  
  internal - API triggered
  
  external - triggered by a sync operation
  
  Can be one of: "internal""external"
- license string
  
  Required
  
  License number.
- subject string
  
  Required
  
  Subject of the user assigned access.
tenantid string

Unique identifier of the tenant related to the event.
sessionid string

Unique identifier of the session related to the event.

com.qlik.license.assignment.deleted

Example payload of the "Assignment deleted" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.license.assignment.deleted",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "type": "professional",
    "origin": "internal",
    "license": "1234123412341234",
    "subject": "qtsel\\lhr"
  },
  "tenantid": "string",
  "sessionid": "string"
}

Event triggered when a license assignment is rejected.

Payload

object

id string

Unique identifier of the event.
time string

Timestamp of when the event happened.

format = "date-time"
type string

Required

The event type identifier.

default = "com.qlik.license.assignment.rejected"
source string

The source of the event.
specversion string

CloudEvents spec version.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
authtype string

The type of principal that triggered the event.
authclaims string

JSON string representing claims of the principal.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Required
Show data properties
- type string
  
  Assignment type. May be an empty string when the assignment has no allotment name.
- origin string
  
  Required
  
  event origin:
  
  internal - API triggered
  
  external - triggered by a sync operation
  
  Can be one of: "internal""external"
- license string
  
  Required
  
  License number.
- message string
  
  Message about why the assignment was rejected.
- subject string
  
  Required
  
  Subject of the user assigned access.
tenantid string

Unique identifier of the tenant related to the event.
sessionid string

Unique identifier of the session related to the event.

com.qlik.license.assignment.rejected

Example payload of the "Assignment rejected" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.license.assignment.rejected",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "type": "professional",
    "origin": "internal",
    "license": "1234123412341234",
    "message": "string",
    "subject": "qtsel\\lhr"
  },
  "tenantid": "string",
  "sessionid": "string"
}

Event triggered when a license assignment is updated.

Payload

object

id string

Unique identifier of the event.
time string

Timestamp of when the event happened.

format = "date-time"
type string

Required

The event type identifier.

default = "com.qlik.license.assignment.updated"
source string

The source of the event.
specversion string

CloudEvents spec version.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
authtype string

The type of principal that triggered the event.
authclaims string

JSON string representing claims of the principal.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Required
Show data properties
- type string
  
  Assignment type (e.g. 'analyzer_time', 'professional', etc.). May be an empty string when the assignment has no allotment name.
- origin string
  
  Required
  
  event origin:
  
  internal - API triggered
  
  external - triggered by a sync operation
  
  Can be one of: "internal""external"
- license string
  
  Required
  
  License number.
- subject string
  
  Required
  
  Subject of the user assigned access.
tenantid string

Unique identifier of the tenant related to the event.
sessionid string

Unique identifier of the session related to the event.

com.qlik.license.assignment.updated

Example payload of the "Assignment updated" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.license.assignment.updated",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "type": "professional",
    "origin": "internal",
    "license": "1234123412341234",
    "subject": "qtsel\\lhr"
  },
  "tenantid": "string",
  "sessionid": "string"
}

Event triggered when data volume consumption is reported.

Payload

object

id string

Unique identifier of the event.
time string

Timestamp of when the event happened.

format = "date-time"
type string

Required

The event type identifier.

default = "com.qlik.license.data.volume.consumption.aggregated"
source string

The source of the event.
specversion string

CloudEvents spec version.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
authtype string

The type of principal that triggered the event.
authclaims string

JSON string representing claims of the principal.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Required
Show data properties
- total integer
  
  Total data volume consumption across all consumption types.
  
  format = int64
- dataVolume object
  
  Required
  
  Show dataVolume properties
  
  unit string
  
  Required
  
  Unit the reported volumes are expressed in (e.g. 'byte').
  
  volume integer
  
  Consumed data volume for the tenant, mirroring localVolume for backward compatibility. Always emitted even though it is not part of required.
  
  format = int64
  
  localVolume integer
  
  Required
  
  Data volume consumed locally by the tenant.
  
  format = int64
  
  externalVolume integer
  
  Required
  
  Data volume consumed externally by the tenant.
  
  format = int64
  
  consumptionType string
  
  Required
  
  Type of data consumption the volume is reported for.
- globalConsumption integer
  
  Total data volume consumed globally by the tenant.
  
  format = int64
- globalConsumptionUnit string
  
  Unit the global consumption value is expressed in.
- totalLocalConsumption integer
  
  Required
  
  Total data volume consumed locally by the tenant.
  
  format = int64
- licenseHighWatermarkWithinMonth integer
  
  Highest recorded data volume consumption for the tenant within the current month.
  
  format = int64
- licenseHighWatermarkWithinMonthUnit string
  
  Unit the monthly high-watermark value is expressed in.
tenantid string

Unique identifier of the tenant related to the event.

com.qlik.license.data.volume.consumption.aggregated

Example payload of the "Data volume consumption aggregated" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.license.data.volume.consumption.aggregated",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "total": 42,
    "dataVolume": {
      "unit": "string",
      "volume": 42,
      "localVolume": 42,
      "externalVolume": 42,
      "consumptionType": "string"
    },
    "globalConsumption": 42,
    "globalConsumptionUnit": "byte",
    "totalLocalConsumption": 42,
    "licenseHighWatermarkWithinMonth": 42,
    "licenseHighWatermarkWithinMonthUnit": "byte"
  },
  "tenantid": "string"
}

Event triggered when a license definition is updated.

Payload

object

id string

Unique identifier of the event.
time string

Timestamp of when the event happened.

format = "date-time"
type string

Required

The event type identifier.

default = "com.qlik.license.definition.updated"
source string

The source of the event.
specversion string

CloudEvents spec version.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
authtype string

The type of principal that triggered the event.
authclaims string

JSON string representing claims of the principal.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Required
Show data properties
- valid object
  
  The interval during which the definition is valid.
  
  Show valid properties
  
  Stop string
  
  End of the valid interval.
  
  Start string
  
  Start of the valid interval.
- license string
  
  Required
  
  License number.
- validTime string
  
  An ISO 8601 timestamp interval representing the same validity period as "valid", but with second precision instead of day precision (e.g. "2018-01-01T00:00:00Z/2018-12-31T23:59:59Z").
- changeTime string
  
  Timestamp of when the definition change was recorded.
  
  format = "date-time"
- updateTime string
  
  Timestamp of when the definition was updated.
  
  format = "date-time"
- licenseType string
  
  The type of the license.
- parentLicense string
  
  Parent license number.
- latestValidTime string
  
  The latest time the definition is valid. Emitted as null when not set.
  
  format = "date-time"
- capabilityBankId string
  
  Capability bank id.
userid string

Unique identifier of the user related to the event.
tenantid string

Required

Unique identifier of the tenant related to the event.

com.qlik.license.definition.updated

Example payload of the "Definition updated" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.license.definition.updated",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "valid": {
      "Stop": "string",
      "Start": "string"
    },
    "license": "string",
    "validTime": "string",
    "changeTime": "2018-10-30T07:06:22Z",
    "updateTime": "2018-10-30T07:06:22Z",
    "licenseType": "string",
    "parentLicense": "string",
    "latestValidTime": "2018-10-30T07:06:22Z",
    "capabilityBankId": "string"
  },
  "userid": "string",
  "tenantid": "string"
}

Event triggered when a lease is created.

Payload

object

id string

Unique identifier of the event.
time string

Timestamp of when the event happened.

format = "date-time"
type string

Required

The event type identifier.

default = "com.qlik.v1.license.lease.created"
source string

The source of the event.
specversion string

CloudEvents spec version.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
authtype string

The type of principal that triggered the event.
authclaims string

JSON string representing claims of the principal.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Required
Show data properties
- name string
  
  Required
  
  Name of the leased resource.
- size integer
  
  Required
  
  Size of the lease.
- excess boolean
  
  Required
  
  Whether the lease exceeds the licensed quantity.
- license string
  
  Required
  
  License number.
- resource string
  
  Required
  
  Identifier of the leased resource.
- createdAt string
  
  Required
  
  Timestamp when the lease was created. Emitted as null when the lease has no recorded creation time.
  
  format = "date-time"
- updatedAt string
  
  Required
  
  Timestamp when the lease was last updated.
  
  format = "date-time"
- excessQuantity integer
  
  Required
  
  Quantity leased in excess of the licensed quantity.
  
  format = int64
- leasedQuantity integer
  
  Required
  
  Quantity currently leased.
  
  format = int64
- licenseQuantity integer
  
  Required
  
  Total quantity granted by the license.
  
  format = int64
- licenseUnlimited boolean
  
  Required
  
  Whether the license grants an unlimited quantity.
userid string

Unique identifier of the user related to the event.
tenantid string

Unique identifier of the tenant related to the event.
sessionid string

Unique identifier of the session related to the event.

com.qlik.v1.license.lease.created

Example payload of the "Lease created" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.license.lease.created",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "name": "amlDepModel1",
    "size": 4,
    "excess": true,
    "license": "1234123412341234",
    "resource": "amlDepModel",
    "createdAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "excessQuantity": 42,
    "leasedQuantity": 42,
    "licenseQuantity": 42,
    "licenseUnlimited": true
  },
  "userid": "string",
  "tenantid": "string",
  "sessionid": "string"
}

Event triggered when a lease is deleted.

Payload

object

id string

Unique identifier of the event.
time string

Timestamp of when the event happened.

format = "date-time"
type string

Required

The event type identifier.

default = "com.qlik.v1.license.lease.deleted"
source string

The source of the event.
specversion string

CloudEvents spec version.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
authtype string

The type of principal that triggered the event.
authclaims string

JSON string representing claims of the principal.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Required
Show data properties
- name string
  
  Required
  
  Name of the leased resource.
- size integer
  
  Required
  
  Size of the lease.
- excess boolean
  
  Required
  
  Whether the lease exceeds the licensed quantity.
- license string
  
  Required
  
  License number.
- resource string
  
  Required
  
  Identifier of the leased resource.
- createdAt string
  
  Required
  
  Timestamp when the lease was created. Emitted as null when the lease has no recorded creation time.
  
  format = "date-time"
- updatedAt string
  
  Required
  
  Timestamp when the lease was last updated.
  
  format = "date-time"
- excessQuantity integer
  
  Required
  
  Quantity leased in excess of the licensed quantity.
  
  format = int64
- leasedQuantity integer
  
  Required
  
  Quantity currently leased.
  
  format = int64
- licenseQuantity integer
  
  Required
  
  Total quantity granted by the license.
  
  format = int64
- licenseUnlimited boolean
  
  Required
  
  Whether the license grants an unlimited quantity.
userid string

Unique identifier of the user related to the event.
tenantid string

Unique identifier of the tenant related to the event.
sessionid string

Unique identifier of the session related to the event.

com.qlik.v1.license.lease.deleted

Example payload of the "Lease deleted" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.license.lease.deleted",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "name": "amlDepModel1",
    "size": 4,
    "excess": true,
    "license": "1234123412341234",
    "resource": "amlDepModel",
    "createdAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "excessQuantity": 42,
    "leasedQuantity": 42,
    "licenseQuantity": 42,
    "licenseUnlimited": true
  },
  "userid": "string",
  "tenantid": "string",
  "sessionid": "string"
}

Event triggered when a lease is updated.

Payload

object

id string

Unique identifier of the event.
time string

Timestamp of when the event happened.

format = "date-time"
type string

Required

The event type identifier.

default = "com.qlik.v1.license.lease.updated"
source string

The source of the event.
specversion string

CloudEvents spec version.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
authtype string

The type of principal that triggered the event.
authclaims string

JSON string representing claims of the principal.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Required
Show data properties
- name string
  
  Required
  
  Name of the leased resource.
- size integer
  
  Required
  
  Size of the lease.
- excess boolean
  
  Required
  
  Whether the lease exceeds the licensed quantity.
- license string
  
  Required
  
  License number.
- _updates array of objects
  
  List of changes applied to the lease during the update.
  
  Show _updates properties
  
  path string
  
  Required
  
  JSON path of the field that changed.
  
  newValue any
  
  Required
  
  Value of the field after the update.
  
  oldValue any
  
  Required
  
  Value of the field before the update.
- resource string
  
  Required
  
  Identifier of the leased resource.
- createdAt string
  
  Required
  
  Timestamp when the lease was created. Emitted as null when the lease has no recorded creation time.
  
  format = "date-time"
- updatedAt string
  
  Required
  
  Timestamp when the lease was last updated.
  
  format = "date-time"
- excessQuantity integer
  
  Required
  
  Quantity leased in excess of the licensed quantity.
  
  format = int64
- leasedQuantity integer
  
  Required
  
  Quantity currently leased.
  
  format = int64
- licenseQuantity integer
  
  Required
  
  Total quantity granted by the license.
  
  format = int64
- licenseUnlimited boolean
  
  Required
  
  Whether the license grants an unlimited quantity.
userid string

Unique identifier of the user related to the event.
tenantid string

Unique identifier of the tenant related to the event.
sessionid string

Unique identifier of the session related to the event.

com.qlik.v1.license.lease.updated

Example payload of the "Lease updated" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.license.lease.updated",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "name": "amlDepModel1",
    "size": 4,
    "excess": true,
    "license": "1234123412341234",
    "_updates": [
      {
        "path": "string"
      }
    ],
    "resource": "amlDepModel",
    "createdAt": "2018-10-30T07:06:22Z",
    "updatedAt": "2018-10-30T07:06:22Z",
    "excessQuantity": 42,
    "leasedQuantity": 42,
    "licenseQuantity": 42,
    "licenseUnlimited": true
  },
  "userid": "string",
  "tenantid": "string",
  "sessionid": "string"
}

Event triggered when a tenant gets associated to a license.

Payload

object

id string

Unique identifier of the event.
time string

Timestamp of when the event happened.

format = "date-time"
type string

Required

The event type identifier.

default = "com.qlik.v1.license.tenant.associated"
source string

The source of the event.
specversion string

CloudEvents spec version.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
authtype string

The type of principal that triggered the event.
authclaims string

JSON string representing claims of the principal.
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
data object

Required
Show data properties
- license string
  
  Required
  
  License number.
- updateTime string
  
  Timestamp of when the tenant association was updated.
  
  format = "date-time"
- parentLicense string
  
  Required
  
  Parent license number.
- previousLicense string
  
  License number prior to the association.
- capabilityBankId string
  
  Identifier of the capability bank associated with the license.
- previousParentLicense string
  
  Parent license number prior to the association.
userid string

Unique identifier of the user related to the event.
tenantid string

Required

Unique identifier of the tenant related to the event.

com.qlik.v1.license.tenant.associated

Example payload of the "Tenant associated" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.license.tenant.associated",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "license": "string",
    "updateTime": "2018-10-30T07:06:22Z",
    "parentLicense": "string",
    "previousLicense": "string",
    "capabilityBankId": "string",
    "previousParentLicense": "string"
  },
  "userid": "string",
  "tenantid": "string"
}