audit_records
Creates, updates, deletes, gets or lists an audit_records
resource.
Overview
Name | audit_records |
Type | Resource |
Id | pagerduty.users.audit_records |
Fields
The following fields are returned by SELECT
queries:
- list_users_audit_records
Records matching the query criteria.
Name | Datatype | Description |
---|---|---|
id | string | |
action | string | (example: create) |
actors | array | |
details | object | Additional details to provide further information about the action or the resource that has been audited. |
execution_context | object | Action execution context |
execution_time | string (date-time) | The date/time the action executed, in ISO8601 format and millisecond precision. |
method | object | The method information |
root_resource | object | |
self | string | Record URL. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list_users_audit_records | select | id | Accept , Content-Type , limit , cursor , since , until | The response will include audit records with changes that are made to the identified user not changes made by the identified user. The returned records are sorted by the execution_time from newest to oldest.See Cursor-based pagination for instructions on how to paginate through the result set.For more information see the Audit API Document. Scoped OAuth requires: audit_records.read |
_list_users_audit_records | exec | id | Accept , Content-Type , limit , cursor , since , until | The response will include audit records with changes that are made to the identified user not changes made by the identified user. The returned records are sorted by the execution_time from newest to oldest.See Cursor-based pagination for instructions on how to paginate through the result set.For more information see the Audit API Document. Scoped OAuth requires: audit_records.read |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
id | string | The ID of the resource. |
Accept | string | The Accept header is used as a versioning header. |
Content-Type | string | |
cursor | string | Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set. |
limit | integer | The minimum of the limit parameter used in the request or the maximum request size of the API. |
since | string (date-time) | The start of the date range over which you want to search. If not specified, defaults to now() - 24 hours (past 24 hours) |
until | string (date-time) | The end of the date range over which you want to search. If not specified, defaults to now() . May not be more than 31 days after since . |
SELECT
examples
- list_users_audit_records
The response will include audit records with changes that are made to the identified user not changes made by the identified user.
The returned records are sorted by the execution_time
from newest to oldest.
See Cursor-based pagination
for instructions on how to paginate through the result set.
For more information see the Audit API Document.
Scoped OAuth requires: audit_records.read
SELECT
id,
action,
actors,
details,
execution_context,
execution_time,
method,
root_resource,
self
FROM pagerduty.users.audit_records
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
;
Lifecycle Methods
- _list_users_audit_records
The response will include audit records with changes that are made to the identified user not changes made by the identified user.
The returned records are sorted by the execution_time
from newest to oldest.
See Cursor-based pagination
for instructions on how to paginate through the result set.
For more information see the Audit API Document.
Scoped OAuth requires: audit_records.read
EXEC pagerduty.users.audit_records._list_users_audit_records
@id='{{ id }}' --required,
@Accept='{{ Accept }}',
@Content-Type='{{ Content-Type }}',
@limit='{{ limit }}',
@cursor='{{ cursor }}',
@since='{{ since }}',
@until='{{ until }}'
;