Download OpenAPI specification:Download
API endpoints for managing groups
Get the access logs in a group. Date formats must be the same for startdate and enddate if specified.
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| startDate | string Default: "today's date, for example, '2024-04-02', or '2024-04-02 13:31'" The start date of a date range for filtering search results, formatted as 'yyyy-MM-dd' (e.g., '2024-04-02') or 'yyyy-MM-dd HH:mm' (e.g., '2024-04-02 13:31'). To include today's date in the search, you can omit this parameter or set it to an empty string. |
| endDate | string Default: "today's date, for example, '2024-04-02', or '2024-04-02 13:31'" The end date of a date range for filtering search results, formatted as 'yyyy-MM-dd' (e.g., '2024-04-02') or 'yyyy-MM-dd HH:mm' (e.g., '2024-04-02 13:31'). 'yyyy-MM-dd' format is inclusive of that day. To include today's date in the search, you can omit this parameter or set it to an empty string. |
| offset | integer Default: 0 The offset to start the page from for pagination |
| limit | integer Default: 20 The number of results to return per page for pagination. |
| subject | string Filter to select only the access logs with the subject name provided. Partial matches included. |
| subjectId | string Filter to select only the access logs with the subjectId provided |
| actor | string Filter to select only the access logs with the actor name provided. Partial matches included. |
| actorId | string Filter to select only the access logs with the actorId provided |
| operation | string Filter to select only the access logs with the operation provided. Partial matches included. |
| detail | string Filter to select only the access logs with the description provided. Partial matches included. |
[- {
- "time": "string",
- "subject": "string",
- "operation": "string",
- "actor": "string",
- "ip": "string",
- "detail": "string"
}
]Export the access logs in a group. Date formats must be the same for startdate and enddate if specified.
| groupId required | integer The group ID (Must be a positive unsigned integer) |
| startDate | string Default: "today's date, for example, '2024-04-02', or '2024-04-02 13:31'" The start date of a date range for filtering search results, formatted as 'yyyy-MM-dd' (e.g., '2024-04-02') or 'yyyy-MM-dd HH:mm' (e.g., '2024-04-02 13:31'). To include today's date in the search, you can omit this parameter or set it to an empty string. |
| endDate | string Default: "today's date, for example, '2024-04-02', or '2024-04-02 13:31'" The end date of a date range for filtering search results, formatted as 'yyyy-MM-dd' (e.g., '2024-04-02') or 'yyyy-MM-dd HH:mm' (e.g., '2024-04-02 13:31'). 'yyyy-MM-dd' format is inclusive of that day. To include today's date in the search, you can omit this parameter or set it to an empty string. |
| offset | integer Default: 0 The offset to start the page from for pagination |
| limit | integer Default: 5000 The number of results to return per page for pagination. |
| subject | string Filter to select only the access logs with the subject name provided. Partial matches included. |
| subjectId | string Filter to select only the access logs with the subjectId provided |
| actor | string Filter to select only the access logs with the actor name provided. Partial matches included. |
| actorId | string Filter to select only the access logs with the actorId provided |
| operation | string Filter to select only the access logs with the operation provided. Partial matches included. |
| detail | string Filter to select only the access logs with the description provided. Partial matches included. |