Function: getAuditRecords()

function getAuditRecords(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  limit?: number;
  offset?: number;
  records?: object[];
  total?: number;
}>;

Defined in: src/cloud/api/auditRecords.ts:28

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 required:Administer Jira global permission.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ filter?: string; from?: string; limit?: number; offset?: number; to?: string; }	-
parameters.filter?	string	The strings to match with audit field content, space separated.
parameters.from?	string	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.
parameters.limit?	number	The maximum number of results to return.
parameters.offset?	number	The number of records to skip before returning the first result.
parameters.to?	string	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.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; limit?: number; offset?: number; records?: object[]; total?: number; }>