Package io.github.primelib.confluence4j.rest.v1.client

Class ConfluenceRestClientAuditConsumerApi

java.lang.Object
io.github.primelib.confluence4j.rest.v1.client.ConfluenceRestClientAuditConsumerApi
@Generated("io.github.primelib.primecodegen") public class ConfluenceRestClientAuditConsumerApi extends Object
ConfluenceRestClientAuditConsumerApi

  • Constructor Details

  • Method Details

    • GetAuditV1

      public AuditRecordArray GetAuditV1(Consumer<GetAuditV1OperationSpec> spec)
      GetAuditV1 Get audit records 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](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) in the Confluence administrator's guide. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • startDate: Filters the results to the records on or after the `startDate`. The `startDate` must be specified as [epoch time](https://www.epochconverter.com/) in milliseconds.
      • endDate: Filters the results to the records on or before the `endDate`. The `endDate` must be specified as [epoch time](https://www.epochconverter.com/) in milliseconds.
      • searchString: Filters the results to records that have string property values matching the `searchString`.
      • start: The starting index of the returned records.
      • limit: The maximum number of records to return per page. Note, this may be restricted by fixed system limits.

    • PostAuditV1

      public AuditRecord PostAuditV1(Consumer<PostAuditV1OperationSpec> spec)
      PostAuditV1 Create audit record Creates a record in the audit log. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • payload: The record to be created in the audit log.

    • GetAuditExportV1

      public Byte[] GetAuditExportV1(Consumer<GetAuditExportV1OperationSpec> spec)
      GetAuditExportV1 Export audit records Exports audit records as a CSV file or ZIP file. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • startDate: Filters the exported results to the records on or after the `startDate`. The `startDate` must be specified as [epoch time](https://www.epochconverter.com/) in milliseconds.
      • endDate: Filters the exported results to the records on or before the `endDate`. The `endDate` must be specified as [epoch time](https://www.epochconverter.com/) in milliseconds.
      • searchString: Filters the exported results to records that have string property values matching the `searchString`.
      • format: The format of the export file for the audit records.

    • GetAuditRetentionV1

      public RetentionPeriod GetAuditRetentionV1(Consumer<GetAuditRetentionV1OperationSpec> spec)
      GetAuditRetentionV1 Get retention period 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.

    • PutAuditRetentionV1

      public RetentionPeriod PutAuditRetentionV1(Consumer<PutAuditRetentionV1OperationSpec> spec)
      PutAuditRetentionV1 Set retention period Sets the retention period for records in the audit log. The retention period can be set to a maximum of 1 year. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • payload: The updated retention period.

    • GetAuditSinceV1

      public AuditRecordArray GetAuditSinceV1(Consumer<GetAuditSinceV1OperationSpec> spec)
      GetAuditSinceV1 Get audit records for time period 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](https://confluence.atlassian.com/confcloud/audit-log-802164269.html) in the Confluence administrator's guide. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • number: The number of units for the time period.
      • units: The unit of time that the time period is measured in.
      • searchString: Filters the results to records that have string property values matching the `searchString`.
      • start: The starting index of the returned records.
      • limit: The maximum number of records to return per page. Note, this may be restricted by fixed system limits.