| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="audit_v1.html">Enterprise Audit API</a> . <a href="audit_v1.activities.html">activities</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, parameters=None, actorEmail=None, endTime=None)</a></code></p> |
| 79 | <p class="firstline">Retrieves a list of activities for a specific customer and application.</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| 82 | <code class="details" id="list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, parameters=None, actorEmail=None, endTime=None)</code> |
| 83 | <pre>Retrieves a list of activities for a specific customer and application. |
| 84 | |
| 85 | Args: |
| 86 | customerId: string, Represents the customer who is the owner of target object on which action was performed. (required) |
| 87 | applicationId: string, Application ID of the application on which the event was performed. (required) |
| 88 | caller: string, Type of the caller. |
| 89 | Allowed values |
| 90 | application_owner - Caller is an application owner. |
| 91 | customer - Caller is a customer. |
| 92 | startTime: string, Return events which occured at or after this time. |
| 93 | actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. |
| 94 | eventName: string, Name of the event being queried. |
| 95 | actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event. |
| 96 | continuationToken: string, Next page URL. |
| 97 | maxResults: integer, Number of activity records to be shown in each page. |
| 98 | parameters: string, Event parameters in the form [parameter1 name]:[parameter1 value],[parameter2 name]:[parameter2 value],... |
| 99 | actorEmail: string, Email address of the user who performed the action. |
| 100 | endTime: string, Return events which occured at or before this time. |
| 101 | |
| 102 | Returns: |
| 103 | An object of the form: |
| 104 | |
| 105 | { |
| 106 | "items": [ # Each record in read response. |
| 107 | { |
| 108 | "kind": "audit#activity", # Kind of resource this is. |
| 109 | "ownerDomain": "A String", # Domain of source customer. |
| 110 | "actor": { # User doing the action. |
| 111 | "applicationId": "A String", # ID of application which interacted on behalf of the user. |
| 112 | "email": "A String", # Email address of the user. |
| 113 | "key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor. |
| 114 | "callerType": "A String", # User or OAuth 2LO request. |
| 115 | }, |
| 116 | "id": { # Unique identifier for each activity record. |
| 117 | "uniqQualifier": "A String", # Unique qualifier if multiple events have the same time. |
| 118 | "applicationId": "A String", # Application ID of the source application. |
| 119 | "customerId": "A String", # Obfuscated customer ID of the source customer. |
| 120 | "time": "A String", # Time of occurrence of the activity. |
| 121 | }, |
| 122 | "ipAddress": "A String", # IP Address of the user doing the action. |
| 123 | "events": [ # Activity events. |
| 124 | { |
| 125 | "eventType": "A String", # Type of event. |
| 126 | "name": "A String", # Name of event. |
| 127 | "parameters": [ # Event parameters. |
| 128 | { |
| 129 | "name": "A String", # Name of the parameter. |
| 130 | "value": "A String", # Value of the parameter. |
| 131 | }, |
| 132 | ], |
| 133 | }, |
| 134 | ], |
| 135 | }, |
| 136 | ], |
| 137 | "kind": "audit#activities", # Kind of list response this is. |
| 138 | "next": "A String", # Next page URL. |
| 139 | }</pre> |
| 140 | </div> |
| 141 | |
| 142 | </body></html> |