Licenses

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
  Required
  
  Assignment type.
- 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"
}

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
  Required
  
  Assignment type.
- 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"
}

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
  Required
  
  Assignment type (e.g. 'analyzer_time', 'professional', etc.).
- 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"
}

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
  
  format = int64
- dataVolumeobject
  Required
  
  Show dataVolume properties
  
  unitstring
  Required
  
  volumeinteger
  
  format = int64
  
  localVolumeinteger
  Required
  
  format = int64
  
  externalVolumeinteger
  Required
  
  format = int64
  
  consumptionTypestring
  Required
- globalConsumptioninteger
  
  format = int64
- globalConsumptionUnitstring
- totalLocalConsumptioninteger
  Required
  
  format = int64
- licenseHighWatermarkWithinMonthinteger
  
  format = int64
- licenseHighWatermarkWithinMonthUnitstring
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"
}

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
- licensestring
  Required
  
  License number.
- parentLicensestring
  
  Parent license number.
- 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": {
    "license": "string",
    "parentLicense": "string",
    "capabilityBankId": "string"
  },
  "userid": "string",
  "tenantid": "string"
}

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
- sizeinteger
  Required
- excessboolean
  Required
- licensestring
  Required
- resourcestring
  Required
- createdAtstring
  Required
  
  format = "date-time"
- updatedAtstring
  Required
  
  format = "date-time"
- excessQuantityinteger
  Required
  
  format = int64
- leasedQuantityinteger
  Required
  
  format = int64
- licenseQuantityinteger
  Required
  
  format = int64
- licenseUnlimitedboolean
  Required
useridstring
tenantidstring
sessionidstring

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

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
- sizeinteger
  Required
- excessboolean
  Required
- licensestring
  Required
- resourcestring
  Required
- createdAtstring
  Required
  
  format = "date-time"
- updatedAtstring
  Required
  
  format = "date-time"
- excessQuantityinteger
  Required
  
  format = int64
- leasedQuantityinteger
  Required
  
  format = int64
- licenseQuantityinteger
  Required
  
  format = int64
- licenseUnlimitedboolean
  Required
useridstring
tenantidstring
sessionidstring

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

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
- sizeinteger
  Required
- excessboolean
  Required
- licensestring
  Required
- _updatesarray of objects
  
  Show _updates properties
  
  pathstring
  Required
  
  newValueany
  Required
  
  oldValueany
  Required
- resourcestring
  Required
- createdAtstring
  Required
  
  format = "date-time"
- updatedAtstring
  Required
  
  format = "date-time"
- excessQuantityinteger
  Required
  
  format = int64
- leasedQuantityinteger
  Required
  
  format = int64
- licenseQuantityinteger
  Required
  
  format = int64
- licenseUnlimitedboolean
  Required
useridstring
tenantidstring
sessionidstring

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": "amlDepModel1",
    "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 tenant resources are purged as part of a tenant purge operation

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.licenses.purged"
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
- purgeIdstring
  Required
- successboolean
  Required
- purgedCountnumber
  Required
- errorMessagestring
- resourceTypestring
  Required
tenantidstring
Required

Unique identifier of the tenant related to the event.

com.qlik.v1.licenses.purged

Example payload of the "Tenant resources purged" event

{
  "id": "string",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.licenses.purged",
  "source": "string",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "authtype": "string",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "data": {
    "purgeId": "string",
    "success": true,
    "purgedCount": 42,
    "errorMessage": "string",
    "resourceType": "string"
  },
  "tenantid": "string"
}

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
- parentLicensestring
  Required
- previousLicensestring
- capabilityBankIdstring
- previousParentLicensestring
useridstring
tenantidstring
Required

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",
    "parentLicense": "string",
    "previousLicense": "string",
    "capabilityBankId": "string",
    "previousParentLicense": "string"
  },
  "userid": "string",
  "tenantid": "string"
}