openapi: 3.1.0 info: title: Atlassian Admin Account Records API description: The Atlassian Admin API provides programmatic access to manage Atlassian organizations, users, domains, policies, and events. It enables administrators to automate organization management tasks, integrate with identity providers, and ensure appropriate access to Atlassian products. version: 1.0.0 contact: name: Atlassian Developer url: https://developer.atlassian.com/cloud/admin/ license: name: Atlassian Developer Terms url: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ x-logo: url: https://wac-cdn.atlassian.com/assets/img/favicons/atlassian/favicon.png servers: - url: https://api.atlassian.com description: Atlassian Cloud API security: - bearerAuth: [] - oauth2: [] tags: - name: Records paths: /wiki/rest/api/audit/export: get: tags: - Records summary: Atlassian Export Audit Records description: The Export Audit Records operation is a GET endpoint in the Atlassian Confluence Audit API accessible via `/wiki/rest/api/audit/export` that allows administrators to retrieve and download audit log data from their Confluence instance. This endpoint enables users to export audit records in a structured format for compliance, security analysis, archival purposes, or integration with external monitoring and SIEM systems. The operation typically supports filtering parameters to narrow down the audit records by date range, event type, user, or affected content, and returns the data in a downloadable format such as CSV or JSON. This functionality is essential for organizations that need to maintain comprehensive audit trails of user activities, content changes, permission modifications, and system events within their Confluence workspace for regulatory compliance and security auditing requirements. operationId: exportAuditRecords parameters: - name: startDate in: query description: '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.' schema: type: string - name: endDate in: query description: '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.' schema: type: string - name: searchString in: query description: 'Filters the exported results to records that have string property values matching the `searchString`.' schema: type: string - name: format in: query description: The format of the export file for the audit records. schema: type: string default: csv enum: - csv - zip responses: '200': description: Returned if the requested export of the audit records is returned. content: application/zip: schema: type: string format: binary text/csv: schema: type: string format: binary '403': description: 'Returned if the calling user does not have permission to view the audit log.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:audit-log:confluence x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:audit-log:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-connect-scope: INACCESSIBLE x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/audit/since: get: tags: - Records summary: Atlassian Get Audit Records for Time Period description: The Atlassian Confluence Audit API endpoint `/wiki/rest/api/audit/since` using the GET method retrieves audit records that have been created since a specified time period. This operation allows administrators and authorized users to query and review system audit logs within a defined timeframe, providing visibility into user actions, system changes, and security-related events that occurred after a particular timestamp. The endpoint is essential for compliance monitoring, security auditing, and tracking changes made to Confluence spaces, pages, and configuration settings over time. operationId: getAuditRecordsForTimePeriod parameters: - name: number in: query description: The number of units for the time period. schema: type: integer format: int64 default: 3 - name: units in: query description: The unit of time that the time period is measured in. schema: type: string default: MONTHS enum: - NANOS - MICROS - MILLIS - SECONDS - MINUTES - HOURS - HALF_DAYS - DAYS - WEEKS - MONTHS - YEARS - DECADES - CENTURIES - name: searchString in: query description: 'Filters the results to records that have string property values matching the `searchString`.' schema: type: string - name: start in: query description: The starting index of the returned records. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of records to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 1000 responses: '200': description: Returned if the requested records are returned. content: application/json: schema: $ref: '#/components/schemas/AuditRecordArray' examples: undefined_2: $ref: '#/components/examples/undefined_2' '403': description: 'Returned if the calling user does not have permission to view the audit log.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:audit-log:confluence x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:audit-log:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-connect-scope: INACCESSIBLE x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: AuditRecordArray: required: - _links - limit - results - size - start type: object properties: results: example: example_value start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' examples: undefined_2: _links: self: https://api.example.com/resource next: https://api.example.com/resource?start=10 base: https://api.example.com limit: 10 results: [] size: 0 start: 0 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: Use an Atlassian API key as a Bearer token. Create API keys at https://admin.atlassian.com. oauth2: type: oauth2 description: OAuth 2.0 authorization for Atlassian Cloud APIs. flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize tokenUrl: https://auth.atlassian.com/oauth/token scopes: read:org:admin: Read organization information. write:org:admin: Modify organization settings. read:user:admin: Read user information. write:user:admin: Modify user accounts. read:policy:admin: Read organization policies. write:policy:admin: Modify organization policies. read:event:admin: Read organization events. externalDocs: description: Atlassian Admin REST API Documentation url: https://developer.atlassian.com/cloud/admin/organization/rest/intro/