API docs by Redocly

Group Access Logs API (1.0.0)

Download OpenAPI specification:

API documentation for retrieving and exporting group access logs.

AccessLogs

Get access logs for a group

Returns a paginated list of access logs for the specified group with advanced filtering capabilities.

Required Permissions:

  • GROUP_OWNER role

Filtering:

  • All text filters (subject, actor, operation, detail) support case-insensitive partial matching
  • Leading/trailing whitespace is automatically trimmed from text filters
  • Date formats must be the same for startDate and endDate if specified
  • Use orMode=true for "search all fields" functionality

Pagination:

  • Default page size: 20 records
  • Maximum page size: 1000 records
  • Use offset parameter to navigate through pages
  • Results are ordered by timestamp descending (newest first)

Timestamps:

  • All log timestamps are in Eastern Time (ET)
  • Default date range is today (midnight to current time in ET)
  • ISO 8601 format in response (e.g., "2026-02-03T20:15:30.000Z")
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The ID of the group

query Parameters
startDate
string

The start date of a date range for filtering search results. Formats supported: 'yyyy-MM-dd' (e.g., '2024-04-02') or 'yyyy-MM-dd HH:mm' (e.g., '2024-04-02 13:31'). If omitted or empty, defaults to today's date.

endDate
string

The end date of a date range for filtering search results. Formats supported: 'yyyy-MM-dd' (e.g., '2024-04-02') or 'yyyy-MM-dd HH:mm' (e.g., '2024-04-02 13:31'). The 'yyyy-MM-dd' format is inclusive of that day. If omitted or empty, defaults to today's date.

offset
integer >= 0
Default: 0

The offset to start the page from for pagination

limit
integer [ 1 .. 1000 ]
Default: 20

The number of results to return per page for pagination (max 1000)

subject
string

Filter to select only the access logs with the subject username provided. Case-insensitive partial matches included.

actor
string

Filter to select only the access logs with the actor username provided. Case-insensitive partial matches included.

operation
string

Filter to select only the access logs with the operation provided. Case-insensitive partial matches included.

detail
string

Filter to select only the access logs with the detail/remarks provided. Case-insensitive partial matches included.

personId
integer

Filter to select logs where the specified person ID is either the actor OR the subject. Use 0 or omit for all persons (matches legacy 'personid' parameter behavior).

orMode
boolean
Default: false

When true, uses OR logic for text filters (subject, actor, operation, detail) instead of AND. Useful for "search all fields" functionality.

Responses

Response samples

Content type
application/json
Example
[
  • {
    }
]

Export access logs for a group to CSV

Returns a CSV file of access logs for the specified group with advanced filtering capabilities.

Authorization: Requires GROUP_OWNER role for the specified group.

CSV Output:

  • RFC 4180 compliant CSV format
  • UTF-8 encoding
  • Header row: Time,Actor,Operation,Target,IP,Detail
  • Time format: yyyy-MM-dd HH:mm:ss (Eastern Time)
  • Fields containing commas, quotes, or newlines are quoted and escaped

Filename Format: access-logs-{groupId}-{yyyyMMdd-HHmmss}.csv

  • Example: access-logs-24453-20260203-201530.csv
  • Timestamp uses UTC time

Filtering:

  • All text filters (subject, actor, operation, detail) support case-insensitive partial matching
  • Leading/trailing whitespace is automatically trimmed from text filters
  • Date formats must be the same for startDate and endDate if specified
  • Use orMode=true for "search all fields" functionality

Performance:

  • Maximum 5000 records per export
  • For larger datasets, use pagination with offset parameter to export in batches
  • Results are ordered by timestamp descending (newest first)
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The ID of the group

query Parameters
startDate
string

The start date of a date range for filtering search results. Formats supported: 'yyyy-MM-dd' (e.g., '2024-04-02') or 'yyyy-MM-dd HH:mm' (e.g., '2024-04-02 13:31'). If omitted or empty, defaults to today's date.

endDate
string

The end date of a date range for filtering search results. Formats supported: 'yyyy-MM-dd' (e.g., '2024-04-02') or 'yyyy-MM-dd HH:mm' (e.g., '2024-04-02 13:31'). The 'yyyy-MM-dd' format is inclusive of that day. If omitted or empty, defaults to today's date.

offset
integer >= 0
Default: 0

The offset to start the page from for pagination

limit
integer [ 1 .. 5000 ]
Default: 5000

The number of results to return per page for pagination (max 5000)

subject
string

Filter to select only the access logs with the subject username provided. Case-insensitive partial matches included.

actor
string

Filter to select only the access logs with the actor username provided. Case-insensitive partial matches included.

operation
string

Filter to select only the access logs with the operation provided. Case-insensitive partial matches included.

detail
string

Filter to select only the access logs with the detail/remarks provided. Case-insensitive partial matches included.

personId
integer

Filter to select logs where the specified person ID is either the actor OR the subject. Use 0 or omit for all persons (matches legacy 'personid' parameter behavior).

orMode
boolean
Default: false

When true, uses OR logic for text filters (subject, actor, operation, detail) instead of AND. Useful for "search all fields" functionality.

Responses

Response samples

Content type
text/csv
Time,Actor,Operation,Target,IP,Detail
2026-02-03 20:15:30,admin.glance.net,user.create,user123.glance.net,192.168.1.100,"Created user: user123"
2026-02-03 20:14:22,admin.glance.net,settings.update,admin.glance.net,192.168.1.100,"Updated settings: cobrowse.enabled=true"