Licenses

Download AsyncAPI spec

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

Assignment deleted

Event triggered when a license assignment is deleted.

Payload

object
  • idstring

    Unique identifier of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The event type identifier.

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

  • sourcestring

    The source of the event.

  • specversionstring

    CloudEvents spec version.

    Can be one of: "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • authtypestring

    The type of principal that triggered the event.

  • authclaimsstring

    JSON string representing claims of the principal.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required
    Show data properties
    • typestring

      Assignment type. May be an empty string when the assignment has no allotment name.

    • originstring
      Required

      event origin:

      • internal - API triggered
      • external - triggered by a sync operation

      Can be one of: "internal""external"

    • licensestring
      Required

      License number.

    • subjectstring
      Required

      Subject of the user assigned access.
  • tenantidstring

    Unique identifier of the tenant related to the event.

  • sessionidstring

    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"
}

Assignment rejected

Event triggered when a license assignment is rejected.

Payload

object
  • idstring

    Unique identifier of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The event type identifier.

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

  • sourcestring

    The source of the event.

  • specversionstring

    CloudEvents spec version.

    Can be one of: "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • authtypestring

    The type of principal that triggered the event.

  • authclaimsstring

    JSON string representing claims of the principal.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required
    Show data properties
    • typestring

      Assignment type. May be an empty string when the assignment has no allotment name.

    • originstring
      Required

      event origin:

      • internal - API triggered
      • external - triggered by a sync operation

      Can be one of: "internal""external"

    • licensestring
      Required

      License number.

    • messagestring

      Message about why the assignment was rejected.

    • subjectstring
      Required

      Subject of the user assigned access.
  • tenantidstring

    Unique identifier of the tenant related to the event.

  • sessionidstring

    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"
}

Assignment updated

Event triggered when a license assignment is updated.

Payload

object
  • idstring

    Unique identifier of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The event type identifier.

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

  • sourcestring

    The source of the event.

  • specversionstring

    CloudEvents spec version.

    Can be one of: "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • authtypestring

    The type of principal that triggered the event.

  • authclaimsstring

    JSON string representing claims of the principal.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required
    Show data properties
    • typestring

      Assignment type (e.g. 'analyzer_time', 'professional', etc.). May be an empty string when the assignment has no allotment name.

    • originstring
      Required

      event origin:

      • internal - API triggered
      • external - triggered by a sync operation

      Can be one of: "internal""external"

    • licensestring
      Required

      License number.

    • subjectstring
      Required

      Subject of the user assigned access.
  • tenantidstring

    Unique identifier of the tenant related to the event.

  • sessionidstring

    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"
}

Data volume consumption aggregated

Deprecated

Event triggered when data volume consumption is reported.

Payload

object
  • idstring

    Unique identifier of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The event type identifier.

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

  • sourcestring

    The source of the event.

  • specversionstring

    CloudEvents spec version.

    Can be one of: "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • authtypestring

    The type of principal that triggered the event.

  • authclaimsstring

    JSON string representing claims of the principal.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required
    Show data properties
    • totalinteger

      Total data volume consumption across all consumption types.

      format = int64

    • dataVolumeobject
      Required
      Show dataVolume properties
      • unitstring
        Required

        Unit the reported volumes are expressed in (e.g. 'byte').

      • volumeinteger

        Consumed data volume for the tenant, mirroring localVolume for backward compatibility. Always emitted even though it is not part of required.

        format = int64

      • localVolumeinteger
        Required

        Data volume consumed locally by the tenant.

        format = int64

      • externalVolumeinteger
        Required

        Data volume consumed externally by the tenant.

        format = int64

      • consumptionTypestring
        Required

        Type of data consumption the volume is reported for.
    • globalConsumptioninteger

      Total data volume consumed globally by the tenant.

      format = int64

    • globalConsumptionUnitstring

      Unit the global consumption value is expressed in.

    • totalLocalConsumptioninteger
      Required

      Total data volume consumed locally by the tenant.

      format = int64

    • licenseHighWatermarkWithinMonthinteger

      Highest recorded data volume consumption for the tenant within the current month.

      format = int64

    • licenseHighWatermarkWithinMonthUnitstring

      Unit the monthly high-watermark value is expressed in.
  • tenantidstring

    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"
}

Definition updated

Event triggered when a license definition is updated.

Payload

object
  • idstring

    Unique identifier of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The event type identifier.

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

  • sourcestring

    The source of the event.

  • specversionstring

    CloudEvents spec version.

    Can be one of: "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • authtypestring

    The type of principal that triggered the event.

  • authclaimsstring

    JSON string representing claims of the principal.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required
    Show data properties
    • validobject

      The interval during which the definition is valid.

      Show valid properties
      • Stopstring

        End of the valid interval.

      • Startstring

        Start of the valid interval.
    • licensestring
      Required

      License number.

    • changeTimestring

      Timestamp of when the definition change was recorded.

      format = "date-time"

    • updateTimestring

      Timestamp of when the definition was updated.

      format = "date-time"

    • licenseTypestring

      The type of the license.

    • parentLicensestring

      Parent license number.

    • latestValidTimestring

      The latest time the definition is valid. Emitted as null when not set.

      format = "date-time"

    • capabilityBankIdstring

      Capability bank id.
  • useridstring

    Unique identifier of the user related to the event.

  • tenantidstring
    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",
    "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"
}

Lease created

Event triggered when a lease is created.

Payload

object
  • idstring

    Unique identifier of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The event type identifier.

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

  • sourcestring

    The source of the event.

  • specversionstring

    CloudEvents spec version.

    Can be one of: "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • authtypestring

    The type of principal that triggered the event.

  • authclaimsstring

    JSON string representing claims of the principal.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required
    Show data properties
    • namestring
      Required

      Name of the leased resource.

    • sizeinteger
      Required

      Size of the lease.

    • excessboolean
      Required

      Whether the lease exceeds the licensed quantity.

    • licensestring
      Required

      License number.

    • resourcestring
      Required

      Identifier of the leased resource.

    • createdAtstring
      Required

      Timestamp when the lease was created. Emitted as null when the lease has no recorded creation time.

      format = "date-time"

    • updatedAtstring
      Required

      Timestamp when the lease was last updated.

      format = "date-time"

    • excessQuantityinteger
      Required

      Quantity leased in excess of the licensed quantity.

      format = int64

    • leasedQuantityinteger
      Required

      Quantity currently leased.

      format = int64

    • licenseQuantityinteger
      Required

      Total quantity granted by the license.

      format = int64

    • licenseUnlimitedboolean
      Required

      Whether the license grants an unlimited quantity.
  • useridstring

    Unique identifier of the user related to the event.

  • tenantidstring

    Unique identifier of the tenant related to the event.

  • sessionidstring

    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"
}

Lease deleted

Event triggered when a lease is deleted.

Payload

object
  • idstring

    Unique identifier of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The event type identifier.

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

  • sourcestring

    The source of the event.

  • specversionstring

    CloudEvents spec version.

    Can be one of: "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • authtypestring

    The type of principal that triggered the event.

  • authclaimsstring

    JSON string representing claims of the principal.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required
    Show data properties
    • namestring
      Required

      Name of the leased resource.

    • sizeinteger
      Required

      Size of the lease.

    • excessboolean
      Required

      Whether the lease exceeds the licensed quantity.

    • licensestring
      Required

      License number.

    • resourcestring
      Required

      Identifier of the leased resource.

    • createdAtstring
      Required

      Timestamp when the lease was created. Emitted as null when the lease has no recorded creation time.

      format = "date-time"

    • updatedAtstring
      Required

      Timestamp when the lease was last updated.

      format = "date-time"

    • excessQuantityinteger
      Required

      Quantity leased in excess of the licensed quantity.

      format = int64

    • leasedQuantityinteger
      Required

      Quantity currently leased.

      format = int64

    • licenseQuantityinteger
      Required

      Total quantity granted by the license.

      format = int64

    • licenseUnlimitedboolean
      Required

      Whether the license grants an unlimited quantity.
  • useridstring

    Unique identifier of the user related to the event.

  • tenantidstring

    Unique identifier of the tenant related to the event.

  • sessionidstring

    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"
}

Lease updated

Event triggered when a lease is updated.

Payload

object
  • idstring

    Unique identifier of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The event type identifier.

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

  • sourcestring

    The source of the event.

  • specversionstring

    CloudEvents spec version.

    Can be one of: "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • authtypestring

    The type of principal that triggered the event.

  • authclaimsstring

    JSON string representing claims of the principal.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required
    Show data properties
    • namestring
      Required

      Name of the leased resource.

    • sizeinteger
      Required

      Size of the lease.

    • excessboolean
      Required

      Whether the lease exceeds the licensed quantity.

    • licensestring
      Required

      License number.

    • _updatesarray of objects

      List of changes applied to the lease during the update.

      Show _updates properties
      • pathstring
        Required

        JSON path of the field that changed.

      • newValueany
        Required

        Value of the field after the update.

      • oldValueany
        Required

        Value of the field before the update.
    • resourcestring
      Required

      Identifier of the leased resource.

    • createdAtstring
      Required

      Timestamp when the lease was created. Emitted as null when the lease has no recorded creation time.

      format = "date-time"

    • updatedAtstring
      Required

      Timestamp when the lease was last updated.

      format = "date-time"

    • excessQuantityinteger
      Required

      Quantity leased in excess of the licensed quantity.

      format = int64

    • leasedQuantityinteger
      Required

      Quantity currently leased.

      format = int64

    • licenseQuantityinteger
      Required

      Total quantity granted by the license.

      format = int64

    • licenseUnlimitedboolean
      Required

      Whether the license grants an unlimited quantity.
  • useridstring

    Unique identifier of the user related to the event.

  • tenantidstring

    Unique identifier of the tenant related to the event.

  • sessionidstring

    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"
}

Tenant associated

Event triggered when a tenant gets associated to a license.

Payload

object
  • idstring

    Unique identifier of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The event type identifier.

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

  • sourcestring

    The source of the event.

  • specversionstring

    CloudEvents spec version.

    Can be one of: "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • authtypestring

    The type of principal that triggered the event.

  • authclaimsstring

    JSON string representing claims of the principal.

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

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

  • dataobject
    Required
    Show data properties
    • licensestring
      Required

      License number.

    • updateTimestring

      Timestamp of when the tenant association was updated.

      format = "date-time"

    • parentLicensestring
      Required

      Parent license number.

    • previousLicensestring

      License number prior to the association.

    • capabilityBankIdstring

      Identifier of the capability bank associated with the license.

    • previousParentLicensestring

      Parent license number prior to the association.
  • useridstring

    Unique identifier of the user related to the event.

  • tenantidstring
    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"
}