provider Audit records GET
/rest/api/3/auditing/record @utdk/jira
/rest/api/3/auditing/record Get audit records
Returns a list of audit records. The list can be filtered to include items:
* where each item in `filter` has at least one match in any of these fields:
* `summary`
* `category`
* `eventSource`
* `objectItem.name` If the object is a user, account ID is available to filter.
* `objectItem.parentName`
* `objectItem.typeName`
* `changedValues.changedFrom`
* `changedValues.changedTo`
* `remoteAddress`
For example, if `filter` contains *man ed*, an audit record containing `summary": "User added to group"` and `"category": "group management"` is returned.
* created on or after a date and time.
* created or or before a date and time.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
- offset query
- The number of records to skip before returning the first result.
- integer
- limit query
- The maximum number of results to return.
- integer
- filter query
- The strings to match with audit field content, space separated.
- string
- from query
- The date and time on or after which returned audit records must have been created. If `to` is provided `from` must be before `to` or no audit records are returned.
- string
- to query
- The date and time on or before which returned audit results must have been created. If `from` is provided `to` must be after `from` or no audit records are returned.
- string
Try it
Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import jira from '@utdk/jira';
await jira.getauditrecords({
"offset": 0,
"limit": 1000
})