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.

These events are available for consumption via:

Deprecation notice

These events are deprecated and will be removed on or after November 30, 2026.

Use the API key configs events in the core namespace instead. For the full event mapping, see the deprecation notice.

API key config updated

Published when the API key configuration is updated.

Payload

object
  • idstring
    Required

    Identifies the event.

    minLength = 1

  • timestring

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

    minLength = 1, format = "date-time"

  • typestring
    Required

    Unique identifier for the event type.

    default = "com.qlik.api-keys-config.updated"

  • sourcestring
    Required

    Identifies the context in which an event happened.

    minLength = 1, format = "uri-reference"

  • specversionstring
    Required

    The version of the CloudEvents specification which the event uses.

    minLength = 1

  • datacontenttypestring

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

    minLength = 1

  • useridstring

    Unique identifier for the user triggering the event.

  • originipstring

    Origin IP address.

  • tenantidstring
    Required

    Unique identifier for the tenant related to the event.

  • sessionidstring

    Unique identifier for the session related to the event.

  • dataobject
    Show data properties
    • apiKeysEnabledboolean
      Required

      Determines if API keys functionality is enabled.

    • maxKeysPerUserstring
      Required

      Maximum number of active API keys per user.

    • maxApiKeyExpirystring
      Required

      Maximum expiry for an API key, in ISO 8601 format.

    • scimExternalClientExpirystring
      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.api-keys-config.updated

Example payload of the "API key config updated" event

{
  "id": "A234-1234-1234",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.api-keys-config.updated",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "string",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "originip": "0.0.0.0",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "sessionid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "data": {
    "apiKeysEnabled": true,
    "maxKeysPerUser": 5,
    "maxApiKeyExpiry": "PT24H",
    "scimExternalClientExpiry": "P365D"
  }
}