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": [
        {
            "id": "8f..92157e",
            "client_id": "A8AF…​CY7rL",
            "user_email": "support@reachfive.com",
            "entity_name": "clients",
            "user_name": "ReachFive Support",
            "action_name": "update",
            "action_data": { (2)
                "clientId": "A8AF…​CY7rL",
                "updatedKeys": [
                    "account_based_rsa_key_pair",
                    "scope"
                ]
            },
            "ip_address": "192.168.1.1",
            "created_at": "2023-05-22T16:30:47.992029Z",

        },
    ]
}
1 Denotes how many items are in the audit log.
2 action_data varies depending on the entity_name.

Audit log object fields

Field Type Description

id

string

The audit log’s unique ID.

client_id

string

The client ID associated with the specific audit log.

user_email

string

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

user_name

string

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

entity_name

string

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

possible values

  • clients

  • console

  • ip

  • jobs

  • settings

  • users

  • on-demand-scaling

action_name

string

Specifies the type of action such as update or unban.

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

  • jobs

    • jobType

    • updatedKeys

    • jobDefinitionId

  • ip

  • on-demand-scaling

    • PasswordScalingEventId

    • oldStartAt

    • oldEndAt

    • newStartAt

    • newEndAt

  • settings

    • settingsType

    • securitySettingsKeysChanged

  • users

    • userId (user’s ReachFive ID)

    • updatedKeys

    • suspensionReason

    • suspensionStatus

ip_address

string

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

created_at

string<date-time>

The creation date timestamp for the audit log.