Audit endpoints allow you to review audit event metadata, including relevant timestamps and statuses, or the actual payload.
Currently, you can retrieve a list of audit events.
Get audit events
Retrieve audit events with their related metadata and payloads based on the criteria you specify with query parameters. Typically, you can use this if you're monitoring user activity within your organization and want to get an idea of what happened and when.
Only Redox organization owners or admins can use this endpoint.
- metaobject
Contains the metadata information for the returned results, including version and pagination information.
- versionstring
Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
- pageobject
Contains the pagination data for the returned results.
- currentPageinteger
Displays the current page number of returned results you're viewing.
- pageTypestring
Displays the type of pagination supported for the returned results. Currently, we only support the
offset
type, which determines the page number by taking the page size and offsetting the number of records from the start. - pageSizeinteger
Displays the number of results included in each page.
- linksobject
Contains the related pagination links for the returned results.
- selfstring
Links to the current page of results.
- nextstring
Links to the next page of results.
- firststring
Links to the first page of results.
- payloadobject
- resultsArray of object
- idstring
Displays the unique identifier of the audit event.
- organizationIdnumber
Identifies the specific Redox organization where the audit event occurred. This field matches the organization ID specified in the request.
- userIdnumber
Displays the unique identifier of the user that performed the audit event.
- requestIpstring
Specifies the IP of the client that performed the audit event.
- routestring
The original request route that resulted in this auditable event.
- createdAtstring
Displays the date-time in ISO 8601 format for when the audit event occurred.
- typestring
Indicates the type of audit event that occurred.
Possible Values:auth-credential-operation
,auth-credential-viewed
,configuration-modifier-link-operation
,configuration-modifier-link-viewed
,configuration-modifier-operation
,configuration-modifier-viewed
,configurations-operation
,customer-alert-link-operation
,customer-alert-link-viewed
,customer-alert-operation
,customer-alert-viewed
,endpoint-operation
,legacy-api-key-operation
,log-inspected
,log-payload-viewed
,log-search
,oauth2-api-key-operation
,organization-loaded
,translation-set-link-operation
,translation-set-link-viewed
,translation-set-operation
,translation-set-viewed
,user-env-role-changed
,user-env-role-removed
,user-invited
,user-joined
,user-org-role-changed
,user-removed
,value-set-operation
,value-set-viewed
- statusstring
Defines the current status of the audit event.
Possible Values:attempted
,successful
,unauthorized
,unauthenticated
,failed
- detailsobject
Contains any extra details about the audit event. Different audit types may include a different set of details.
Contains the payload and metadata returned for Get Audit Events
.