Understand how the Audit API works, its behaviors, and what you should consider when building integrations.

  • Delivery mechanism: The Audit API is designed as an event delivery stream rather than a permanent historical repository. Audit events are retained for a rolling window of up to 30 days.
  • Frequent polling: Clients should schedule frequent automated polling (for example, hourly or daily) to extract events and store them in corporate cold/warm data stores.
  • Forensic audit detail: Each event captures who carried out the action (userId), when it occurred (eventDate in millisecond UTC and createdDate), where it was initiated (ipAddress, hostName, userAgent), what occurred (eventTypeId, message, objectId), and a cryptographic checksum verifying data integrity.

To call the Anaplan Audit API, two required prerequisites must be met:

  1. Tenant Auditor role: The calling user account must be explicitly assigned the Tenant Auditor role. Tenant administrators can assign this role in the Anaplan Administration application.
  2. Feature activation: The Audit feature must be activated on your Anaplan tenant.

The Audit Service categorizes and tracks events across two primary domains:

  • Bring Your Own Key (BYOK) events: Add guardpoint (workspace encryption), add user to domain (Encryption Admin assignment), create symmetric key, delete pending guardpoint (workspace decryption initiation), marked guardpoint pending delete (workspace decrypted), switch domain, and update key expiration.
  • User activity events: User login success/failure, user logout success/failure, user created/updated, user enabled/disabled, user access model success/failure, and user assigned/removed from tenant. 

The Audit API supports two output representations:

  1. Structured JSON (application/json): Standard REST response containing meta paging objects and an array of strongly-typed audit event dictionaries.
  2. Common Event Format (CEF) (text/plain): Standardized syslog/ArcSight formatted text stream allowing SIEM forwarders to ingest events directly without custom transformation pipelines.

All requests require a valid Anaplan authentication token (JSON Web Token) passed in the standard Authorization header: Authorization: AnaplanAuthToken {anaplan_auth_token}.

  • Limit cap: The limit parameter specifies the maximum number of events returned per page. It can't exceed 10,000. Requests with limit > 10,000 return an HTTP 204 error.
  • Paging controls: The meta.paging object provides currentPageSize, totalSize, offSet, nextOffset, and nextUrl to automate multi-page extraction loops.