Audit

Audit log and compliance queries.

listByOrg

List audit events for an organization

GET

Usage:

const result = await swirls.client.audit.listByOrg({
  orgId: '...',
})

Input:

Parameter	Type	Required
`orgId`	`string`	Yes
`limit`	`number`	No
`cursor`	`string`	No

Output:

Field	Type	Description
`data`	`object[]`
`nextCursor`	`string`

List audit events for a specific actor

GET

Usage:

const result = await swirls.client.audit.listByActor({
  actorId: '...',
})

Input:

Parameter	Type	Required
`actorId`	`string`	Yes
`limit`	`number`	No
`cursor`	`string`	No

Output:

Field	Type	Description
`data`	`object[]`
`nextCursor`	`string`

List audit events for one hosted app

GET

Usage:

const result = await swirls.client.audit.listByApp({
  orgId: '...',
  appId: '...',
})

Input:

Parameter	Type	Required
`orgId`	`string`	Yes
`appId`	`string`	Yes
`from`	`string`	No
`to`	`string`	No
`subjects`	`string[]`	No
`outcomes`	`"success" \| "failure" \| "denied"[]`	No
`limit`	`number`	No
`cursor`	`string`	No

Output:

Field	Type	Description
`data`	`object[]`
`nextCursor`	`string`

Count app-scoped sign-ins and workflow launches

GET

Usage:

const result = await swirls.client.audit.summarizeByApp({
  orgId: '...',
  appId: '...',
})

Input:

Parameter	Type	Required
`orgId`	`string`	Yes
`appId`	`string`	Yes
`from`	`string`	No
`to`	`string`	No

Output:

Field	Type	Description
`signIns`	`number`
`workflowLaunches`	`number`