Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - AuditLog

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AuditLog

The Audit Log object represents an entry in the audit log. Retention of audit log entries is indefinite — no purge schedule exists. For information about constructing queries for specific types of actions performed in Master Data Hub, refer to the topic REST APIs.

Action type type action modifier
Enable account features (admin level) account EDIT
Enable, change, or disable Account Usage Agreement account EDIT NONE
Enable, change, or disable single sign-on (SSO) account EDIT NONE
Enable or disable Session Lock and Terminate account EDIT NONE
Enable or disable Session Concurrency account EDIT NONE
Enable or disable two-factor authentication (account level) account EDIT NONE
Force sign out account account LOGOUT NONE
Modify an account password policy account EDIT NONE
Modify CORS settings account EDIT NONE
Log in/Switch accounts — success
Note: Logging into the platform is technically considered an account switch, and encompasses both initial sign-in and post-login account switching. Additionally, failed login attempts are not captured.		 account ON_ENTRY SUCCESS
Update Assure setting account EDIT NONE
Modify an account name account EDIT NONE
Modify an account Support Access Role as.account.access EDIT NONE
Add Trusted IP Address on an account account-ip_address ADD TRUSTEDIP
Note: As of the January 2021 release, the audit log record shows a 'TRUSTEDIP' modifier. Historical records prior to this date show the 'WHITELISTING' term.
Delete Trusted IP Address from an account account-ip_address DELETE TRUSTEDIP
Note: As of the January 2021 release, the audit log record shows a 'TRUSTEDIP' modifier. Historical records prior to this date show the 'WHITELISTING' term.
Edit Trusted IP Address in an account account-ip_address EDIT TRUSTEDIP
Note: As of the January 2021 release, the audit log record shows a 'TRUSTEDIP' modifier. Historical records prior to this date show the 'WHITELISTING' term.
Add an API application api.application ADD NONE
Update an API application api.application UPDATE NONE
Add an authentication source api.authentication_source ADD NONE
Remove an authentication source api.authentication_source DELETE NONE
Update an authentication source api.authentication_source UPDATE NONE
Add an API contract api.contract ADD NONE
Update an API contract api.contract UPDATE NONE
Add an API deployment api.deployment ADD NONE
Deploy or Redeploy an API api.deployment DEPLOY NONE
Remove an API deployment api.deployment DELETE NONE
Update an API deployment api.deployment UPDATE NONE
Add, update, or delete API policy rules api.deployment_policies ADD, UPDATE, DELETE NONE
Add an API Key api.key ADD NONE
Remove an API Key api.key DELETE NONE
Update an API Key api.key UPDATE NONE
Edit and save account properties as.account.properties SAVE NONE
Add an account group as.accountgroup ADD NONE
Delete an account group as.accountgroup DELETE NONE
Add a cloud to an account group as.accountgroup.resource ADD NONE
Delete a cloud from an account group as.accountgroup.resource DELETE NONE
Add a connector to an account group as.accountgroup.resource ADD NONE
Delete a connector from an account group as.accountgroup.resource DELETE NONE
Add an integration pack to an account group as.accountgroup.resource ADD NONE
Delete an integration pack from an account group as.accountgroup.resource DELETE NONE
Add a published component to an account group as.accountgroup.resource ADD NONE
Delete a published component from an account group as.accountgroup.resource DELETE NONE
Add a role to an account group as.accountgroup.resource ADD NONE
Delete a role from an account group as.accountgroup.resource DELETE NONE
Add user to account group as.accountgroup.user ADD NONE
Update user roles in account group as.accountgroup.user UPDATE ROLE
Remove user from account group as.accountgroup.user DELETE NONE
Add Basic Authentication user api-basic_auth_user ADD NONE
Update Basic Authentication user api-basic_auth_user UPDATE NONE
Delete Basic Authentication user api-basic_auth_user DELETE NONE
Add Basic Authentication group api-basic_auth_group ADD NONE
Update Basic Authentication group api-basic_auth_group UPDATE NONE
Delete Basic Authentication group api-basic_auth_group DELETE NONE
Add Basic Authentication role api-basic_auth_role ADD NONE
Update Basic Authentication role api-basic_auth_role UPDATE NONE
Delete Basic Authentication role api-basic_auth_role DELETE NONE
Add a Runtime as.atom INSTALL TOKEN or NONE
Add a Gateway as.atom INSTALL TOKEN or NONE
Runtime properties update as.atom UPDATE MANUAL
Runtime response to properties update request as.atom UPDATE RESPONSE
Apply a pending Runtime update as.atom UPDATE NONE
Delete Runtime as.atom DELETE NONE
Delete node from the Runtime cluster or Runtime cloud cluster as.atom NODE_OFFBOARD NONE
Edit Runtime Counters as.atom UPDATE MANUAL
forced Runtime to appear online as.atom FORCE ONLINE
Restart Runtime as.atom RESTART NONE
Pause listeners as.atom PAUSE MANUAL
Resume listeners as.atom RESUME MANUAL
Restart listeners as.atom START MANUAL
Revert a Runtime update as.atom ROLLBACK NONE
Uninstall the Runtime, Runtime cluster, or Runtime cloud as.atom UNINSTALL NONE
Retrieve disk space usage for a Runtime cloud attachment as.atom.disk.space NONE NONE
Download Runtime log, Worker log, or process run artifact as.atom.log DOWNLOAD NONE
Download the Shared Web Server log as.atom.log DOWNLOAD SHAREDWESERVERLOG
Changes to RuntimeObservabilitySettings as.atom.observability UPDATE MANUAL
Attach packaged component to an environment Note: Attachment happens automatically during the first deployment of a packaged component to an environment. Subsequent deployments to the same environment are not logged. as.atom.process ATTACH NONE
Undeploy packaged component from an environment as.atom.process DETACH NONE
Stop Runtime Worker as.atom.process ADD RESPONSE
Edit and save Runtime properties as.atom.properties SAVE NONE
Start purge process using the Atom Purge object as.atom.purge NONE NONE
Runtime schedule update as.atom.rc_schedule SAVE NONE
Delete Runtime cloud as.cloud DELETE NONE
Create a private runtime cloud as.cloud CREATE NONE
Update a private runtime cloud as.cloud UPDATE NONE
Delete a private runtime cloud as.cloud DELETE NONE
Update default cloud attachment properties for the runtime cloud cluster as.cloud.log UPDATE MANUAL
Copy component as.component COPY NONE
Delete component as.component DELETE NONE
Apply a pending Connector update as.connector UPDATE NONE
Rollback of connector update as.connector ROLLBACK NONE
Download document — failure as.document DOWNLOAD FAILURE
Download document — success as.document DOWNLOAD SUCCESS
View document — failure as.document VIEW FAILURE
View document — success as.document VIEW SUCCESS
Attach Runtime to environment as.environment ATTACH NONE
Delete environment as.environment DELETE NONE
Detach Runtime from environment as.environment DETACH NONE
Update environment name as.environment UPDATE NAME
Update environment role as.environment UPDATE ROLE
Edit and save Runtime or environment extension values as.extensions EDIT NONE
Edit and save integration pack extension values as.extensions.process EDIT NONE
Edit and save forked execution properties as.forkedexecution.properties SAVE NONE
Generate installer token as.installer ADD NONE
Manual integration pack update as.ipack UPDATE MANUAL
Roll back of Java version as.java_upgrade ROLLBACK EQUALS
Upgrade Runtimes, Runtime clusters, or Runtime clouds, Authentication Brokers, and API Gateways to Boomi's latest supported version of Java as.java_upgrade UPDATE NONE
Delete a packaged component version as.packaged.component DELETE NONE
Restore a deleted version of a packaged component as.packaged.component RESTORE NONE
Manually run the process as.process.manual_execution EXECUTE MANUAL
Edit and save process properties as.process.properties SAVE NONE
Manually run test process as.process.test_execution EXECUTE MANUAL
Update schedule as.schedules UPDATE NONE
Resume schedule as.schedules RESUME ALL or SINGLE
Stop schedule as.schedules STOP ALL or SINGLE
Add a tracked field as.tracking ADD NONE
Modify a tracked field as.tracking UPDATE NONE
Delete a tracked field as.tracking DELETE NONE
Add a role role ADD NONE
Remove a role role DELETE NONE
Update a role role UPDATE NONE
Add new user to account user ADD NONE
Enable or disable two-factor authentication (user level) user UPDATE AUTHENTICATION
Modify a user sign-in password user UPDATE AUTHENTICATION
Modify an SSO User Federation ID user UPDATE NONE
Remove user from account user DELETE NONE
Accept Terms and Conditions user TC_ACCEPT SUCCESS
Lock or unlock user user UPDATE AUTHENTICATION
Update existing user role user UPDATE ROLE
Update user email user UPDATE EMAIL
Enable or disable API Token (user level) user.token UPDATE AUTHENTICATION
Enable or disable user API Token (admin level) user.token UPDATE AUTHENTICATION
Generate API Token user.token ADD AUTHENTICATION
Rename API Token user.token UPDATE AUTHENTICATION
Revoke API Token user.token DELETE AUTHENTICATION
Revoke API Tokens after removing a user from an account or an account group, removing an account from an account group, or deleting an account group user.token DELETE AUTHENTICATION
Create a Runtime Release schedule for a Runtime, Runtime cluster, or Runtime cloud as.atom.rc_schedule SAVE NONE
Update a set Runtime Release schedule for a Runtime, Runtime cluster, or Runtime cloud as.atom.rc_schedule SAVE NONE
Delete a set Runtime Release schedule for a Runtime, Runtime cluster, or Runtime cloud as.atom.rc_schedule SAVE NONE
Refresh Secrets on Runtime, RuntimeCluster, or Runtime Cloud as.atom EDIT MANUAL

Required Privileges

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.
  • VIEW_AUDIT_LOGS — View and download audit logs.

Retrieves an instance of an AuditLog object

Retrieve audit information for a single audit log entry, like the audit logs action message, the audit log type, action, and modifier. For example, you can use the GET operation to retrieve the environment extensions for a certain date using the document ID.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response Schema:
Array of objects (AuditLogProperty)
accountId
string

The account in which the action occurred.

action
string

The action type.

containerId
string

The ID of the Runtime, Runtime cluster, or Runtime cloud on which the action occurred.

date
string <date-time>

The date and time the action occurred.

documentId
string

The ID assigned to the Audit Log record.

level
string

The severity level of the action: DEBUG, ERROR, INFO, or WARNING.

message
string

A descriptive message. Not all types of management actions have a message in their audit log entries.

modifier
string

The action type qualifier.

source
string

Where the action occurred: API, INTERNAL, MOBILE, UI, or UNKNOWN

type
string

The type of object on which the action occurred.

userId
string

The ID (email address) of the user who performed the action.

Response samples

Content type
{
  • "@type": "AuditLog",
  • "AuditLogProperty": [
    • {
      },
    • {
      }
    ],
  • "containerId": "3456789a-bcde-f0123-4567-89abcdef012",
  • "documentId": "XdDAzmwB7C-eRHGS1Oal",
  • "accountId": " account-12345 ",
  • "userId": " user123@company.biz ",
  • "date": "2019-08-26T16:27:19Z",
  • "message": "Environment Extensions saved",
  • "type": "as.extensions",
  • "action": "EDIT",
  • "modifier": "NONE",
  • "level": "INFO",
  • "source": "UNKNOWN"
}

Retrieves multiple AuditLog objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (AuditLog)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for an AuditLog object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: containerId, userId, date, type, action, modifier, level, source

required
object
required
AuditLogSimpleExpression (object) or AuditLogGroupingExpression (object) (AuditLogExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"
property
required
string
Enum: "containerId" "userId" "date" "type" "action" "modifier" "level" "source"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (AuditLog)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "numberOfResults": 100,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}

Retrieves additional results for an AuditLog query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (AuditLog)

Response samples

Content type
{
  • "numberOfResults": 100,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}