Actors And Targets

Actors

An actor is represented in the actor parameter within the audit log object and defines the type of actor that triggered the audit log event and its associated details.

The actorIp field is optional and is omitted when no IP address is available.

User

{
  "actorType": "user",
  "actorAccountId": number,
  "actorUserId": number,
  "actorEmail": string,
  "actorClient": string | null,
  "actorIsExternal": boolean,
  "actorIp": string
}

Token

{
  "actorType": "token",
  "actorAccountId": number,
  "actorIsExternal": boolean,
  "actorIp": string,
  "tokenType": "api_key" | "bearer_token" | "oauth2_account" | "oauth2_client" | "oauth2_client_code_verifier" | "oauth2_client_secret" | "oauth2_user" | "unknown",
  "tokenId": string,
  "generatedBy": number | null
}

Internal

An internal actor refers to Lucid's system actions.

{
  "actorType": "internal",
  "actorIp": string
}

Anonymous

{
  "actorType": "anonymous",
  "actorIp": string
}

Unknown

{
  "actorType": "unknown"
}

Targets

Targets are represented in the target array within the audit log object and define the target(s) of the audit log event and their associated details.

Some events may have multiple targets, while other events may have no targets.

User

{
  "targetType": "userTarget",
  "targetId": number,
  "displayName": string,
  "userEmail": string,
  "isExternal": boolean
}

Document

{
  "targetType": "documentTarget",
  "targetId": string,
  "documentName": string
}

Folder

{
  "targetType": "folderTarget",
  "targetId": number,
  "folderName": string
}

Asset

{
  "targetType": "assetTarget",
  "targetId": string,
  "assetName": string
}

Repository

{
  "targetType": "repositoryTarget",
  "targetId": number,
  "repositoryName": string
}

Group

{
  "targetType": "groupTarget",
  "targetId": number,
  "folderName": string
}

Team

{
  "targetType": "teamTarget",
  "targetId": string,
  "teamName": string,
  "teamType": "closed" | "hidden" | "open"
}

Email Invitation

{
  "targetType": "emailInvitationTarget",
  "targetId": string
}

REST API

{
  "targetType": "restApiTarget",
  "targetId": string,
  "resourceType": "Account" | "BillingPoint" | "Credential" | "DataSource" | "Document" | "DocumentEmbed" | "Folder" | "Group" | "JobReference" | "LegalHold" | "License" | "Repository" | "Shape" | "ShapeLibrary" | "ShareLink" | "Subscription" | "Team" | "Thread" | "User"
}

Document Classification

{
  "targetType": "documentClassificationTarget",
  "targetId": string,
  "classificationName": string
}

Unknown

{
  "targetType": "unknownTarget"
}