Class Audit

Index

Constructors

constructor

Methods

createAuditRecord exportAuditRecords getAuditRecords getAuditRecordsForTimePeriod getRetentionPeriod setRetentionPeriod

Constructors

constructor

new Audit(client: Client): Audit
Parameters
- client: Client
Returns Audit
- Defined in src/api/audit.ts:8

Methods

createAuditRecord

createAuditRecord<T = AuditRecord>(
parameters: undefined | CreateAuditRecord,
callback: Callback<T>,
): Promise<void>
Creates a record in the audit log.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = AuditRecord
Parameters
- parameters: undefined | CreateAuditRecord
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/audit.ts:59
createAuditRecord<T = AuditRecord>(
parameters?: CreateAuditRecord,
callback?: undefined,
): Promise<T>
Creates a record in the audit log.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = AuditRecord
Parameters
- Optionalparameters: CreateAuditRecord
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/audit.ts:69

exportAuditRecords

exportAuditRecords<T = unknown>(
parameters: undefined | ExportAuditRecords,
callback: Callback<T>,
): Promise<void>
Exports audit records as a CSV file or ZIP file.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = unknown
Parameters
- parameters: undefined | ExportAuditRecords
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/audit.ts:103
exportAuditRecords<T = unknown>(
parameters?: ExportAuditRecords,
callback?: undefined,
): Promise<T>
Exports audit records as a CSV file or ZIP file.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = unknown
Parameters
- Optionalparameters: ExportAuditRecords
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/audit.ts:113

getAuditRecords

getAuditRecords<T = AuditRecordArray>(
parameters: undefined | GetAuditRecords,
callback: Callback<T>,
): Promise<void>
Returns all records in the audit log, optionally for a certain date range. This contains information about events like space exports, group membership changes, app installations, etc. For more information, see Audit log in the Confluence administrator's guide.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = AuditRecordArray
Parameters
- parameters: undefined | GetAuditRecords
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/audit.ts:18
getAuditRecords<T = AuditRecordArray>(
parameters?: GetAuditRecords,
callback?: undefined,
): Promise<T>
Returns all records in the audit log, optionally for a certain date range. This contains information about events like space exports, group membership changes, app installations, etc. For more information, see Audit log in the Confluence administrator's guide.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = AuditRecordArray
Parameters
- Optionalparameters: GetAuditRecords
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/audit.ts:30

getAuditRecordsForTimePeriod

getAuditRecordsForTimePeriod<T = AuditRecordArray>(
parameters: undefined | GetAuditRecordsForTimePeriod,
callback: Callback<T>,
): Promise<void>
Returns records from the audit log, for a time period back from the current date. For example, you can use this method to get the last 3 months of records.

This contains information about events like space exports, group membership changes, app installations, etc. For more information, see Audit log in the Confluence administrator's guide.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = AuditRecordArray
Parameters
- parameters: undefined | GetAuditRecordsForTimePeriod
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/audit.ts:204
getAuditRecordsForTimePeriod<T = AuditRecordArray>(
parameters?: GetAuditRecordsForTimePeriod,
callback?: undefined,
): Promise<T>
Returns records from the audit log, for a time period back from the current date. For example, you can use this method to get the last 3 months of records.

This contains information about events like space exports, group membership changes, app installations, etc. For more information, see Audit log in the Confluence administrator's guide.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = AuditRecordArray
Parameters
- Optionalparameters: GetAuditRecordsForTimePeriod
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/audit.ts:219

getRetentionPeriod

getRetentionPeriod<T = RetentionPeriod>(callback: Callback<T>): Promise<void>
Returns the retention period for records in the audit log. The retention period is how long an audit record is kept for, from creation date until it is deleted.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = RetentionPeriod
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/audit.ts:139
getRetentionPeriod<T = RetentionPeriod>(callback?: undefined): Promise<T>
Returns the retention period for records in the audit log. The retention period is how long an audit record is kept for, from creation date until it is deleted.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = RetentionPeriod
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/audit.ts:147

setRetentionPeriod

setRetentionPeriod<T = RetentionPeriod>(
parameters: undefined | SetRetentionPeriod,
callback: Callback<T>,
): Promise<void>
Sets the retention period for records in the audit log. The retention period can be set to a maximum of 20 years.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = RetentionPeriod
Parameters
- parameters: undefined | SetRetentionPeriod
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/audit.ts:163
setRetentionPeriod<T = RetentionPeriod>(
parameters?: SetRetentionPeriod,
callback?: undefined,
): Promise<T>
Sets the retention period for records in the audit log. The retention period can be set to a maximum of 20 years.

Permissions required: 'Confluence Administrator' global permission.
Type Parameters
- T = RetentionPeriod
Parameters
- Optionalparameters: SetRetentionPeriod
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/audit.ts:173

Class Audit

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Audit

Methods

createAuditRecord

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

exportAuditRecords

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAuditRecords

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAuditRecordsForTimePeriod

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getRetentionPeriod

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setRetentionPeriod

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page