Sha256: 6c84da633e4fb693ffaf28e6de0a00c5ca8bf865dded3eeb26d5bee209011bc4
Contents?: true
Size: 1.92 KB
Versions: 21
Compression:
Stored size: 1.92 KB
Contents
# Audit Logs Actions Details on the various actions that can be performed on the Audit Logs resource, including the expected parameters and the potential responses. ##### Contents * [Get](#get) <br/> ## Get Returns the audit logs for the organization ```ruby result = client.audit_logs.get(orgId: my_org_id) puts result ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Organization, all.Organization.read, all.User, all.User.read, auditLogs.*, or auditLogs.get. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 | | sortField | string | N | Field to sort the results by. Accepted values are: creationDate, responseStatus, actorName | creationDate | creationDate | | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | asc | | page | string | N | Which page of results to return | 0 | 0 | | perPage | string | N | How many items to return per page | 1000 | 10 | | start | string | N | Start of time range for audit log query | | 1465790400000 | | end | string | N | End of time range for audit log query | | 1465790400000 | | auditLogFilter | [Audit Log Filter](_schemas.md#audit-log-filter) | N | Filters for the audit log query | | [Audit Log Filter Example](_schemas.md#audit-log-filter-example) | #### Successful Responses | Code | Type | Description | | ---- | ---- | ----------- | | 200 | [Audit Logs](_schemas.md#audit-logs) | Collection of audit logs | #### Error Responses | Code | Type | Description | | ---- | ---- | ----------- | | 400 | [Error](_schemas.md#error) | Error if malformed request | | 404 | [Error](_schemas.md#error) | Error if organization was not found |
Version data entries
21 entries across 21 versions & 1 rubygems