Get Audit Events

POST

///method-api-gateway/api/v1/audit/getAuditEvents

POST

/method-api-gateway/api/v1/audit/getAuditEvents

1 curl -X POST /method-api-gateway/api/v1/audit/getAuditEvents \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "startTime": "2024-01-15T09:30:00Z",
6   "endTime": "2024-01-15T09:30:00Z"
7 }'

200Successful

1 {
2   "auditEvents": [
3     {
4       "id": "id",
5       "tenantId": "tenantId",
6       "timestamp": "2024-01-15T09:30:00Z",
7       "actor": {
8         "type": "user",
9         "id": "id",
10         "name": "name",
11         "email": "email",
12         "externalId": "externalId"
13       },
14       "action": {
15         "type": "userLogin"
16       },
17       "resource": {
18         "type": "userAccount",
19         "user": {
20           "id": "id",
21           "name": "name",
22           "email": "email",
23           "externalId": "externalId"
24         }
25       },
26       "context": {
27         "sourceIp": "sourceIp",
28         "userAgent": "userAgent"
29       }
30     },
31     {
32       "id": "id",
33       "tenantId": "tenantId",
34       "timestamp": "2024-01-15T09:30:00Z",
35       "actor": {
36         "type": "user",
37         "id": "id",
38         "name": "name",
39         "email": "email",
40         "externalId": "externalId"
41       },
42       "action": {
43         "type": "userLogin"
44       },
45       "resource": {
46         "type": "userAccount",
47         "user": {
48           "id": "id",
49           "name": "name",
50           "email": "email",
51           "externalId": "externalId"
52         }
53       },
54       "context": {
55         "sourceIp": "sourceIp",
56         "userAgent": "userAgent"
57       }
58     }
59   ],
60   "pagingToken": "pagingToken"
61 }

Retrieves all audit events in the specified time range

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageSizeintegerOptional

tokenstringOptional

Request

This endpoint expects an object.

startTimedatetimeRequired

endTimedatetimeRequired

Response

This endpoint returns an object.

auditEventslist of objects

pagingTokenstring or null