Class AuditService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit

Hierarchy

CommonHttpService
- AuditService

Index

Constructors

Methods

createAuditRecord exportAuditRecords getAuditRecords getAuditRecordsForTimePeriod getRetentionPeriod setRetentionPeriod initialize

Constructors

constructor

new AuditService(getClientInstance): AuditService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns AuditService
Inherited from CommonHttpService.constructor

Methods

createAuditRecord

createAuditRecord(params): Promise<AuditRecord>
Creates a record in the audit log.

Permissions required: 'Confluence Administrator' global permission.
Parameters
- params: {
  auditRecordCreate: AuditRecordCreate;
  }
  - auditRecordCreate: AuditRecordCreate
    The record to be created in the audit log.
Returns Promise<AuditRecord>
Returned if the record is created in the audit log.

Path
POST /wiki/rest/api/audit @scopes-current read:audit-log:confluence, write:audit-log:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-post

exportAuditRecords

exportAuditRecords(params?): Promise<WithResponse<{
    body: Blob;
    mediaType: "application/zip" | "text/csv";
    status: 200;
}>>
Exports audit records as a CSV file or ZIP file.

Permissions required: 'Confluence Administrator' global permission.
Parameters
- params: {
      endDate?: string;
      format?: "csv" | "zip";
      searchString?: string;
      startDate?: string;
  } = {}
  - OptionalendDate?: string
    Filters the exported results to the records on or before the endDate. The endDate must be specified as epoch time in milliseconds.
  - Optionalformat?: "csv" | "zip"
    The format of the export file for the audit records.
  - OptionalsearchString?: string
    Filters the exported results to records that have string property values matching the searchString.
  - OptionalstartDate?: string
    Filters the exported results to the records on or after the startDate. The startDate must be specified as epoch time in milliseconds.
Returns Promise<WithResponse<{
    body: Blob;
    mediaType: "application/zip" | "text/csv";
    status: 200;
}>>
- status: 200, mediaType: application/zip
  
  Returned if the requested export of the audit records is returned.
- status: 200, mediaType: text/csv
  
  Returned if the requested export of the audit records is returned.
Path
GET /wiki/rest/api/audit/export @scopes-current read:audit-log:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-export-get

getAuditRecords

getAuditRecords(params?): Promise<AuditRecordArray>
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.
Parameters
- params: {
      endDate?: string;
      limit?: number;
      searchString?: string;
      start?: number;
      startDate?: string;
  } = {}
  - OptionalendDate?: string
    Filters the results to the records on or before the endDate. The endDate must be specified as epoch time in milliseconds.
  - Optionallimit?: number
    The maximum number of records to return per page. Note, this may be restricted by fixed system limits.
  - OptionalsearchString?: string
    Filters the results to records that have string property values matching the searchString.
  - Optionalstart?: number
    The starting index of the returned records.
  - OptionalstartDate?: string
    Filters the results to the records on or after the startDate. The startDate must be specified as epoch time in milliseconds.
Returns Promise<AuditRecordArray>
Returned if the requested records are returned.

Path
GET /wiki/rest/api/audit @scopes-current read:audit-log:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-get

getAuditRecordsForTimePeriod

getAuditRecordsForTimePeriod(params?): Promise<AuditRecordArray>
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.
Parameters
- params: {
      limit?: number;
      number?: number;
      searchString?: string;
      start?: number;
      units?:
          | "NANOS"
          | "MICROS"
          | "MILLIS"
          | "SECONDS"
          | "MINUTES"
          | "HOURS"
          | "HALF_DAYS"
          | "DAYS"
          | "WEEKS"
          | "MONTHS"
          | "YEARS"
          | "DECADES"
          | "CENTURIES";
  } = {}
  - Optionallimit?: number
    The maximum number of records to return per page. Note, this may be restricted by fixed system limits.
  - Optionalnumber?: number
    The number of units for the time period.
  - OptionalsearchString?: string
    Filters the results to records that have string property values matching the searchString.
  - Optionalstart?: number
    The starting index of the returned records.
  - Optionalunits?:
        | "NANOS"
        | "MICROS"
        | "MILLIS"
        | "SECONDS"
        | "MINUTES"
        | "HOURS"
        | "HALF_DAYS"
        | "DAYS"
        | "WEEKS"
        | "MONTHS"
        | "YEARS"
        | "DECADES"
        | "CENTURIES"
    The unit of time that the time period is measured in.
Returns Promise<AuditRecordArray>
Returned if the requested records are returned.

Path
GET /wiki/rest/api/audit/since @scopes-current read:audit-log:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-since-get

getRetentionPeriod

getRetentionPeriod(): Promise<RetentionPeriod>
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.

Returns Promise<RetentionPeriod>
Returned if the requested retention period is returned.

Path
GET /wiki/rest/api/audit/retention @scopes-current read:audit-log:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-retention-get

setRetentionPeriod

setRetentionPeriod(params): Promise<RetentionPeriod>
Sets the retention period for records in the audit log. The retention period can be set to a maximum of 1 year.

Permissions required: 'Confluence Administrator' global permission.
Parameters
- params: {
  retentionPeriod: RetentionPeriod;
  }
  - retentionPeriod: RetentionPeriod
    The updated retention period.
Returns Promise<RetentionPeriod>
Returned if the retention period is updated.

Path
PUT /wiki/rest/api/audit/retention @scopes-current write:audit-log:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-retention-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class AuditService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns AuditService

Methods

createAuditRecord

Parameters

auditRecordCreate: AuditRecordCreate

Returns Promise<AuditRecord>

Path

See

exportAuditRecords

Parameters

OptionalendDate?: string

Optionalformat?: "csv" | "zip"

OptionalsearchString?: string

OptionalstartDate?: string

Returns Promise<WithResponse<{ body: Blob; mediaType: "application/zip" | "text/csv"; status: 200; }>>

Path

See

getAuditRecords

Parameters

OptionalendDate?: string

Optionallimit?: number

OptionalsearchString?: string

Optionalstart?: number

OptionalstartDate?: string

Returns Promise<AuditRecordArray>

Path

See

getAuditRecordsForTimePeriod

Parameters

Optionallimit?: number

Optionalnumber?: number

OptionalsearchString?: string

Optionalstart?: number

Optionalunits?: | "NANOS" | "MICROS" | "MILLIS" | "SECONDS" | "MINUTES" | "HOURS" | "HALF_DAYS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "DECADES" | "CENTURIES"

Returns Promise<AuditRecordArray>

Path

See

getRetentionPeriod

Returns Promise<RetentionPeriod>

Path

See

setRetentionPeriod

Parameters

retentionPeriod: RetentionPeriod

Returns Promise<RetentionPeriod>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`endDate?: string

`Optional`format?: "csv" | "zip"

`Optional`searchString?: string

`Optional`startDate?: string

Returns Promise<WithResponse<{
body: Blob;
mediaType: "application/zip" | "text/csv";
status: 200;
}>>

`Optional`endDate?: string

`Optional`limit?: number

`Optional`searchString?: string

`Optional`start?: number

`Optional`startDate?: string

`Optional`limit?: number

`Optional`number?: number

`Optional`searchString?: string

`Optional`start?: number

`Optional`units?:
| "NANOS"
| "MICROS"
| "MILLIS"
| "SECONDS"
| "MINUTES"
| "HOURS"
| "HALF_DAYS"
| "DAYS"
| "WEEKS"
| "MONTHS"
| "YEARS"
| "DECADES"
| "CENTURIES"

`Protected` `Static`initialize