Methods for auditing users
On this page:
GET[host]/back-api/backoffice/audit |
Get the audit log
Use this method to obtain a log of user activity based on specified criteria.
Request
Header parameters:
Authorization: Bearer <access_token>
Query parameters:
- from
The earliest date and time for which the data must be obtained:
YYYY-MM-DDThh:mm:ss.When unspecified (
null), all data is returned that was obtained before the latest specified date.- to
The latest date and time for which the data must be obtained:
YYYY-MM-DDThh:mm:ss.When unspecified (
null), all data is returned that was obtained after the earliest specified date.- user
The username or email (to return entries matching this string).
- type
The type of records to be included in the log.
- role
An array of string values, identifying the user roles.
- cursor
The page number, in the range indicated in a previous paging response.
GET[host]/back-api/backoffice/audit
GET /back-api/backoffice/audit
?from=2020-09-01
&to=2020-10-01
&user=user@mailexample.com
&type=users
&role=Admin HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g
Response
- id string
The audit record identifier.
- timestamp string
The activity timestamp.
- email string
The user email.
- roles array
An array of string values, identifying the user roles.
- operationType string
The type of activity that has been logged.
- operationInformation string
The details of activity that has been logged.
- context string
The activity scope.
- registered string
The date and time of user registration.
- lastLogin string
The date and time when the user has last been logged in.
[
{
"id": 1,
"timestamp": "2020-09-02T10:11:49.282907",
"email": "admin@mailexample.com",
"roles": ["Admin"],
"operationType": "Users",
"operationInformation": "Role ‘User' was added for user 'user@mailexample.com’.",
"context": "BackOffice",
"registered": "2020-09-02T10:09:34.198912",
"lastLogin": "2020-09-02T10:10:45.975433"
}
]