API key configs

Download AsyncAPI spec

Events emitted when API key configuration settings are updated in a Qlik Cloud tenant. These events enable monitoring of API key configuration changes for compliance and security.

Preferred events

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

API key config updated

Published when the API key configuration 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-keys-config.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 configuration.

    Show data properties
    • apiKeysEnabled boolean
      Required

      Determines if API keys functionality is enabled.

    • maxKeysPerUser integer
      Required

      Maximum number of active API keys per user.

    • maxApiKeyExpiry string
      Required

      Maximum allowed lifetime of an API key, in ISO 8601 duration format.

    • scimExternalClientExpiry string
      Required

      Expiry of the SCIM externalClient token in ISO 8601 duration format, for example P365D for 365 days. Set when creating an externalClient API key for a SCIM-compatible identity provider.

com.qlik.core.api-keys-config.updated

Example payload of the "API key config updated" event

{
  "id": "A234-1234-1234",
  "time": "2023-01-01T12:00:00Z",
  "type": "com.qlik.core.api-keys-config.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": {
    "apiKeysEnabled": true,
    "maxKeysPerUser": 5,
    "maxApiKeyExpiry": "PT24H",
    "scimExternalClientExpiry": "P365D"
  }
}