Audit Log object
The Audit Log object represents an entry in the audit log. Retention of audit log entries is indefinite — no purge schedule exists.
Note: For a list of account management actions that create audit log entries, refer to the topic Audit log entries.
Structure
<AuditLog
containerId=""
documentId=""
accountId=""
userId=""
message=""
date=""
type=""
action=""
modifier=""
level=""
source="">
<AuditLogProperty value="" name=""/>
...
<AuditLogProperty value="" name=""/>
</AuditLog>
| Field | Type | Description |
|---|---|---|
| Filter | FIlter | Filter |
| containerId | string | The ID of the runtime, Runtime cluster, or Runtime cloud on which the action occurred. |
| documentId | string | The ID assigned to the Audit Log record. |
| accountId | string | The account in which the action occurred. |
| userId | string | The ID (email address) of the user who performed the action. |
| message | string | A descriptive message. Not all types of management actions have a message in their audit log entries. |
| date | dateTime yyyy-MM-dd'T'HH:mm:ss'Z' (e.g., 2014-02-05T15:32:00Z) | The date and time the action occurred. |
| type | string | The type of object on which the action occurred. |
| action | string | The action type. |
| modifier | string | The action type qualifier. |
| level | string | The severity level of the action: DEBUG, ERROR, INFO, or WARNING. |
| source | string | Where the action occurred: API, INTERNAL, MOBILE, UI, or UNKNOWN |
| name | string | A property name in an audit log entry. For example, in an entry for updating a Runtime or connector to a new version, the name is VERSION_STRING. Note: Audit log entries created prior to June 2016 have a property name of version and an integer value. |
| value | string | A property value in an audit log entry. For example, in an entry about updating a Runtime or connector to a new version, the value is the new version number. |
note
The name and value fields are a repeatable collection, enabling audit log entries to accommodate multiple properties. The number of properties varies depending on the type, action, and modifier values.
Supported operations
| GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|
| Supported | Supported | Not supported | Not supported | Not supported | Not supported |
Using the GET operation
Use the GET operation to retrieve audit information for a single audit log entry, like the audit log's 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.
Using the QUERY operation
The following fields can be used as QUERY filters for the Audit Log object:
| Field | Allowed values |
|---|---|
| Filter | Filter |
| containerId | Any string value. |
| userId | Any string value. |
| date | Date with the format yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2014-02-05T15:32:00Z. One way to specify a date range is to use the BETWEEN operator with two arguments, one representing the start date and the other representing the end date. |
| type | For a complete list of types, refer to the topic Audit log query construction. |
| action | For a complete list of actions, refer to the topic Audit log query construction. |
| modifier | For a complete list of modifiers, refer to the topic Audit log query construction. |
| level | DEBUG, ERROR, INFO, or WARNING. |
| source | API, INTERNAL, MOBILE, UI, or UNKNOWN. The operators allowed for the Audit Log object filters are: - BETWEEN - EQUALS - GREATER_THAN - GREATER_THAN_OR_EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL |
For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.
Note: For information about constructing audit log queries for specific types of actions, refer to the topicAudit log query construction. For information about constructing queries for actions performed in, refer to the REST APIs topic.
SOAP implementation
GET operation
SOAP request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header/>
<soapenv:Body>
<api:get>
<api:objectType>Auditlog</api:objectType>
<api:objectId>XdDAzmwB7C-eRHGS1Oal</api:objectId>
</api:get>
</soapenv:Body>
</soapenv:Envelope>
SOAP response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<bns:getResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
<bns:result xsi:type="bns:AuditLog" documentId="XdDAzmwB7C-eRHGS1Oal" accountId=" account-123456 " 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">
<bns:AuditLogProperty name="NEW_VALUE" value="<?xml version="1.0" encoding="UTF-8" standalone="yes"?><processOverrides xmlns:ns2="http://www.boomi.com/connector/annotation" xmlns:ns3="http://exacttarget.com/wsdl/partnerAPI" xmlns:ns4="urn:fault.partner.exacttarget.com" xmlns:ns5="http://schemas.boomi.com/sap/edi_dc40" xmlns:ns6="http://schemas.microsoft.com/2003/10/Serialization/" internalVersion="2" saveVersion="2"><connections><connection id="829ca9e7-c4a5-48ac-a501-499c59f42001" name="connection_to_modify_inextensions" type="boomipartnerapi"><field id="authenticationType" label="Authentication Type" value="APITOKEN" encryptedValueSet="false" usesEncryption="false" useDefault="false" atomLevelValueSet="true" componentOverride="false"/></connection></connections><operations/><partnerOverrides/><sharedCommOverrides/><properties/><schedules/><mappings/><crossReferences/><pgpCertificates/><definedProcessProperties><definedProcessProperty componentId="a90181c0-f513-40ac-b110-646a30d1e4d7" componentName="processproptotest"><definedProcessPropertyValueExtension key="d8e8703b-85cd-4d46-b956-0d5c5f7a615e"/><componentVersion>1</componentVersion></definedProcessProperty></definedProcessProperties><maps/></processOverrides>"/>
<bns:AuditLogProperty name="ENVIRONMENT_ID" value="3fe3d126-8d20-48ba-94d2-4b69752eedd9"/>
</bns:result>
</bns:getResponse>
</S:Body>
</S:Envelope>
QUERY operation
The following example query returns the audit log entries for management actions performed on an account’s Runtimes during the date range starting February 5, 2016 and ending March 4, 2016.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header>
<wsse:Security
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"> ATOMSPHERE_PASSWORD</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<api:query>
<api:objectType>AuditLog</api:objectType>
<api:queryConfig>
<api:QueryFilter>
<api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression">
<api:nestedExpression operator="EQUALS" property="type" xsi:type="api:SimpleExpression">
<api:argument>as.atom</api:argument>
</api:nestedExpression>
<api:nestedExpression operator="BETWEEN" property="date" xsi:type="api:SimpleExpression">
<api:argument>2016-02-05T00:00:00Z</api:argument>
<api:argument>2016-03-04T23:59:59Z</api:argument>
</api:nestedExpression>
</api:expression>
</api:QueryFilter>
</api:queryConfig>
</api:query>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<bns:results numberOfResults="100">
<bns:queryToken>EXAMPLE_QUERY_TOKEN</bns:queryToken>
<bns:result xsi:type="bns:AuditLog" source="UNKNOWN" level="INFO" modifier="MANUAL" action="UPDATE"
type="as.atom" date="2016-02-05T09:12:13Z" userId="user123@company.biz"
accountId="account-123456" containerId="3456789a-bcde-f0123-4567-89abcdef012">
<bns:AuditLogProperty value="16.06.0.0-20160512.173026-27" name="VERSION_STRING"/>
</bns:result>
...
<bns:result xsi:type="bns:AuditLog" source="UNKNOWN" level="INFO" modifier="MANUAL" action="UPDATE"
type="as.atom" date="2016-03-04T16:55:20Z" userId="user123@company.biz"
accountId="account-123456" containerId="210fedcb-a987-6543-210f-edcba9876543">
<bns:AuditLogProperty value="16.06.0.0-20160513.182152-27" name="VERSION_STRING"/>
</bns:result>
</bns:results>
</bns:queryResponse>
</S:Body>
</S:Envelope>
The maximum number of results returned per QUERY response is 100. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.
Was this topic helpful?
