Audit Log model

An audit log is produced when certain actions happen within the ReachFive Console including changes to clients and other console settings, as well as when jobs are executed. This page describes the AuditLog object and its associated fields.

The Audit Log object

{
    "total": 1, (1)
    "items": [
        {
            "user_email": "support@reachfive.com",
            "entity_name": "clients",
            "user_name": "ReachFive Support",
            "action_name": "update",
            "created_at": "2023-05-22T16:30:47.992029Z",
            "id": "8f..92157e",
            "action_data": {
                "clientId": "A8AF…​CY7rL",
                "updatedKeys": [
                    "account_based_rsa_key_pair",
                    "scope"
                ]
            },
            "client_id": "Console ReachFive"
        },
    ]
}
1 Denotes how many items are in the audit log.

AuthResult object fields

Field Type Description

user_email

string

The user email associated with the event or action that triggered the log.

entity_name

string

Specifies the audit log type. This typically includes some related action_data.

possible values

  • clients

  • console

  • jobs

  • settings

  • users

user_name

string

The name of the user associated with the event or action that triggered the audit log.

action_name

string

Specifies the type of action such as update.

created_at

string<date-time>

The creation date timestamp for the audit log.

id

string

The audit log’s unique ID.

action_data

object

Any associated action data. The data here depends on the entity_name. For the information below, updatedKeys refers to the list of fields that were updated.

  • clients

    • clientId

    • updatedKeys

  • console: action_data is empty.

  • jobs

    • jobType

    • updatedKeys

    • jobDefinitionId

  • settings

    • settingsType

    • securitySettingsKeysChanged

  • users

    • userId (user’s ReachFive ID)

    • updatedKeys

client_id

string

The client ID associated with the specific audit log.