API

Accessed REST API

When an actor interacts with Lucid's REST API.

JSON

{
  "eventType": "api.accessedRestApi",
  "endpointName": string,
  "version": string
}

API Key Generated

When a user generates an API key.

JSON

{
  "eventType": "api.apiKeyGenerated",
  "tokenId": string,
  "apiKeyName": string,
  "grants": string[],
  "expiresAt": string | null,
  "generatedBy": number
}

API Key Deleted

When an API key is deleted.

JSON

{
  "eventType": "api.apiKeyDeleted",
  "tokenId": string,
  "apiKeyName": string,
  "deletedBy": number
}

OAuth2 Token Invalidated

When an OAuth2 token is invalidated.

JSON

{
  "eventType": "api.oAuth2TokenInvalidated",
  "tokenId": string,
  "tokenType": string,
  "clientId": string,
  "clientName": string,
  "userId": number | null
}

OAuth2 Token Issued

When an OAuth2 token is issued.

JSON

{
  "eventType": "api.oAuth2TokenIssued",
  "tokenId": string,
  "tokenType": string,
  "clientId": string,
  "scopes": string[],
  "expiresAt": string | null,
  "generatedBy": number | null
}

OAuth2 Token Refreshed

When an OAuth2 token is refreshed.

JSON

{
  "eventType": "api.oAuth2TokenRefreshed",
  "tokenId": string,
  "tokenType": string,
  "clientId": string,
  "clientName": string,
  "newExpiresAt": string,
  "refreshedBy": number | null
}

OAuth2 Token Revoked

When an OAuth2 token is revoked.

JSON

{
  "eventType": "api.oAuth2TokenRevoked",
  "tokenId": string,
  "tokenType": string,
  "clientId": string,
  "clientName": string,
  "expiresAt": string,
  "userId": number | null
}