Skip to main content

SettingAudit

A record of one change to a setting.

type SettingAudit {
  action: SettingAuditAction!
  id: ID!
  ipAddress: String
  metadata: JSON
  newDataType: String
  newValue: JSON
  oldDataType: String
  oldValue: JSON
  organizationId: String!
  performedAt: DateTime!
  performedBy: String!
  performedByName: String
  reason: String
  settingCategory: String!
  settingId: String
  settingKey: String!
  userAgent: String
}

Fields

`SettingAudit.action` ● `SettingAuditAction!` non-null enum

What was done.

`SettingAudit.id` ● `ID!` non-null scalar

The unique ID of this record.

`SettingAudit.ipAddress` ● `String` scalar

The IP address the change came from.

`SettingAudit.metadata` ● `JSON` scalar

Additional data attached to the record, as JSON.

`SettingAudit.newDataType` ● `String` scalar

The data type after.

`SettingAudit.newValue` ● `JSON` scalar

The value after.

`SettingAudit.oldDataType` ● `String` scalar

The data type before.

`SettingAudit.oldValue` ● `JSON` scalar

The value before.

`SettingAudit.organizationId` ● `String!` non-null scalar

The ID of the organization the record belongs to.

`SettingAudit.performedAt` ● `DateTime!` non-null scalar

When it was changed.

`SettingAudit.performedBy` ● `String!` non-null scalar

The ID of the user who changed it.

`SettingAudit.performedByName` ● `String` scalar

The name of the user who changed it.

`SettingAudit.reason` ● `String` scalar

Why it was changed.

`SettingAudit.settingCategory` ● `String!` non-null scalar

The group the setting is in.

`SettingAudit.settingId` ● `String` scalar

The ID of the setting.

`SettingAudit.settingKey` ● `String!` non-null scalar

The key of the setting.

`SettingAudit.userAgent` ● `String` scalar

The browser or app the change came from.

Returned By

tenantSettingHistory query

Fields
Returned By