API keys

Download AsyncAPI spec

Events emitted when API keys are created, updated, deleted, or when validation failed in a Qlik Cloud tenant. These events enable tracking of API key lifecycle for security and access management.

Preferred events

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

Published when an API key is created.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

Identifies the type of event related to the originating occurrence.

default = "com.qlik.core.api-key.created"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1, default = "application/json"
userid string

Unique identifier for the user triggering the event.
authtype string

Representing the type of principal that triggered the occurrence.
originip string

Origin IP address.
tenantid string

Required

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

Unique identifier for the session related to the event.
authclaims string

A JSON string representing claims of the principal that triggered the event.
data object

Details of the created API key.
Show data properties
- id string
  
  Required
  
  API key identifier.
- sub string
  
  Required
  
  Subject identifier.
- subType string
  
  Required
  
  Subject type.
- description string
  
  Required
  
  API key description.
- expiry string
  
  Required
  
  API key expiry date.

com.qlik.core.api-key.created

Example payload of the "API key created" event

{
  "id": "A234-1234-1234",
  "time": "2023-01-01T12:00:00Z",
  "type": "com.qlik.core.api-key.created",
  "source": "com.qlik/my-service",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "api-keys",
  "originip": "0.0.0.0",
  "tenantid": "Rn8kQvY2wZ4pL7mX1jB6tC3dS5fH0gJ9",
  "sessionid": "9fBc2dE4gH6jK8mN0pQ2rS4tV6wX8yZ0",
  "authclaims": "{\"sub\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\"tenantId\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\"}",
  "data": {
    "id": "1fc531f9-1964-46d6-9267-256e707fac45",
    "sub": "62eadf5a01f72ccd31f37041",
    "subType": "user",
    "description": "description text for the key",
    "expiry": "2025-11-08T20:43:24.130Z"
  }
}

Published when an API key is deleted.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

Identifies the type of event related to the originating occurrence.

default = "com.qlik.core.api-key.deleted"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1, default = "application/json"
userid string

Unique identifier for the user triggering the event.
authtype string

Representing the type of principal that triggered the occurrence.
originip string

Origin IP address.
tenantid string

Required

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

Unique identifier for the session related to the event.
authclaims string

A JSON string representing claims of the principal that triggered the event.
data object

Details of the deleted API key.
Show data properties
- id string
  
  Required
  
  API key identifier.
- sub string
  
  Required
  
  Subject identifier.
- subType string
  
  Required
  
  Subject type.
- description string
  
  Required
  
  API key description.
- expiry string
  
  Required
  
  API key expiry date.
- status string
  
  Required
  
  Status of the API key. Set to deleted when triggered by the owner, or revoked when triggered by a tenant admin.

com.qlik.core.api-key.deleted

Example payload of the "API key deleted" event

{
  "id": "A234-1234-1234",
  "time": "2023-01-01T12:00:00Z",
  "type": "com.qlik.core.api-key.deleted",
  "source": "com.qlik/my-service",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "api-keys",
  "originip": "0.0.0.0",
  "tenantid": "Rn8kQvY2wZ4pL7mX1jB6tC3dS5fH0gJ9",
  "sessionid": "9fBc2dE4gH6jK8mN0pQ2rS4tV6wX8yZ0",
  "authclaims": "{\"sub\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\"tenantId\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\"}",
  "data": {
    "id": "1fc531f9-1964-46d6-9267-256e707fac45",
    "sub": "62eadf5a01f72ccd31f37041",
    "subType": "user",
    "description": "description text for the key",
    "expiry": "2025-11-08T20:43:24.130Z",
    "status": "deleted"
  }
}

Published when an API key is updated.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

Identifies the type of event related to the originating occurrence.

default = "com.qlik.core.api-key.updated"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1, default = "application/json"
userid string

Unique identifier for the user triggering the event.
authtype string

Representing the type of principal that triggered the occurrence.
originip string

Origin IP address.
tenantid string

Required

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

Unique identifier for the session related to the event.
authclaims string

A JSON string representing claims of the principal that triggered the event.
data object

Details of the updated API key.
Show data properties
- id string
  
  Required
  
  API key identifier.
- sub string
  
  Required
  
  Subject identifier.
- subType string
  
  Required
  
  Subject type.
- description string
  
  Required
  
  API key description.
- expiry string
  
  Required
  
  API key expiry date.

com.qlik.core.api-key.updated

Example payload of the "API key updated" event

{
  "id": "A234-1234-1234",
  "time": "2023-01-01T12:00:00Z",
  "type": "com.qlik.core.api-key.updated",
  "source": "com.qlik/my-service",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "api-keys",
  "originip": "0.0.0.0",
  "tenantid": "Rn8kQvY2wZ4pL7mX1jB6tC3dS5fH0gJ9",
  "sessionid": "9fBc2dE4gH6jK8mN0pQ2rS4tV6wX8yZ0",
  "authclaims": "{\"sub\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\"tenantId\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\"}",
  "data": {
    "id": "1fc531f9-1964-46d6-9267-256e707fac45",
    "sub": "62eadf5a01f72ccd31f37041",
    "subType": "user",
    "description": "description text for the key",
    "expiry": "2025-11-08T20:43:24.130Z"
  }
}

Published when API key validation fails. Only published for externalClient API keys.

Payload

object

id string

Required

Identifies the event.

minLength = 1
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
type string

Required

Identifies the type of event related to the originating occurrence.

default = "com.qlik.core.api-key.validation.failed"
source string

Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversion string

Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttype string

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1, default = "application/json"
userid string

Unique identifier for the user triggering the event.
authtype string

Representing the type of principal that triggered the occurrence.
originip string

Origin IP address.
tenantid string

Required

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

Unique identifier for the session related to the event.
authclaims string

A JSON string representing claims of the principal that triggered the event.
data object

Details of the failed API key validation.
Show data properties
- jti string
  
  Required
  
  API key identifier (MongoDB ObjectId).
- code string
  
  Required
  
  Error code.
- idpId string
  
  Identity provider identifier tied to the externalClient.
- subType string
  
  Required
  
  API key subType.
- description string
  
  Required
  
  Error description.
- createdByUser string
  
  Identifier of the user who created the key.
toplevelresourceid string

API key identifier.

com.qlik.core.api-key.validation.failed

Example payload of the "API key validation failed" event

{
  "id": "A234-1234-1234",
  "time": "2023-01-01T12:00:00Z",
  "type": "com.qlik.core.api-key.validation.failed",
  "source": "com.qlik/my-service",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "api-keys",
  "originip": "0.0.0.0",
  "tenantid": "Rn8kQvY2wZ4pL7mX1jB6tC3dS5fH0gJ9",
  "sessionid": "9fBc2dE4gH6jK8mN0pQ2rS4tV6wX8yZ0",
  "authclaims": "{\"sub\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\"tenantId\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\"}",
  "data": {
    "jti": "62eadf5a01f72ccd31f37041",
    "code": "APIKEYS-18",
    "idpId": "62eaddcce5ff30cabc6f67e8",
    "subType": "externalClient",
    "description": "The api key is either expired or revoked",
    "createdByUser": "62eadf5a01f72ccd31f37041"
  },
  "toplevelresourceid": "1fc531f9-1964-46d6-9267-256e707fac45"
}