tenantSettingHistory

Requires permission settings:tenant:read.

Lists who changed a setting, when, and from what to what, newest first. A per-user setting's history is visible only to the user it belongs to; for anyone else the list is empty. Needs settings:tenant:read.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query TenantSettingHistory($category: String!, $key: String!) {
  tenantSettingHistory(category: $category, key: $key) {
    id
    performedByName
    action
    ipAddress
    metadata
    newDataType
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TenantSettingHistory($category: String!, $key: String!) {\n  tenantSettingHistory(category: $category, key: $key) {\n    id\n    performedByName\n    action\n    ipAddress\n    metadata\n    newDataType\n  }\n}",
  "variables": {
    "category": "string",
    "key": "string"
  }
}
EOF

Variables:

{
  "category": "string",
  "key": "string"
}

Response:

{
  "data": {
    "tenantSettingHistory": [
      {
        "id": "id",
        "performedByName": "string",
        "action": "BULK_UPDATE",
        "ipAddress": "string",
        "metadata": {},
        "newDataType": "string"
      }
    ]
  }
}

tenantSettingHistory(
  category: String!
  key: String!
  limit: Int
): [SettingAudit!]!

Arguments

tenantSettingHistory.category ● String! non-null scalar

The settings category. Not case sensitive.

tenantSettingHistory.key ● String! non-null scalar

The setting's key within the category.

tenantSettingHistory.limit ● Int scalar

The most entries to return. Defaults to 50.

Type

SettingAudit object

A record of one change to a setting.