Was this helpful?

 

API Platform Base Path: https://api.enterprise.apigee.com/v1

API Resource Path:

/audits/o/{org_name}/users/{user_email}

Description: List audit entries for an Apigee user. The audit records include when the user's role was updated, but not when the user was created. However, the role is initially set when the user is created, so the first occurrence of a role change corresponds to the creation of the user.

Verb: GET
Auth: Basic Auth
Media types:
application/octet-stream
Sample Request:
$ curl -X GET -H "Accept:application/octet-stream" \ 
https://api.enterprise.apigee.com/v1/audits/o/{org_name}/users/{user_email} \
-u myname:mypass
Query Parameters:
Name Description Default Required?
timeline Filters results by the specified time interval. Valid values are today, week, month. Specify either timeline, startTime, or endTime. Last 24 hours No
startTime The beginning time, in milliseconds since 1 January 1970 UTC, for which audit entries should be returned. Specify either timeline, startTime, or endTime. N/A No
endTime The end time, in milliseconds since 1 January 1970 UTC, for which audit entries should be returned. Specify either timeline, startTime, or endTime. N/A No
rows A limit on the total number of audit entries to be returned when using startTime or endTime. N/A No
expand true is the only valid value for this query parameter. When set to true, the audit records for all sub-resources are returned in the list of records. N/A Yes
operation Supported values are create, update, read, delete, deploy, undeploy N/A No

Sample Response:

{
  "auditRecord" : [ {
    "operation" : "UPDATE",
    "request" : "'{'role' : [ { 'name' : 'orgadmin', 'organization' : 'myorg'} ]}'",
    "requestUri" :"/v1/organizations/myorg/users/user%40company%2Ecom/userroles",
    "responseCode" : "200",
    "timeStamp" : 1402054549258,
    "user" : "admin@company.com"
  }]
}

Response Payload Elements:

Name Description
auditRecord The audit record for an operation on the target resource
operation The operation (CREATE, UPDATE, or DELETE) logged for this target
request The target organization
requestURI The URI path of the request to the audit target
responseCode The HTTP response code returned for the operation from Apigee Edge to the requesting app
timeStamp Unix time when the action was logged by the auditing system
user The ID of the user who issued the API call in the audit record

Errors

Failure 4xx with proper error message
<Error>
<Code>audit.invalid_search_parameter</Code>
<Message>Search parameter is not valid </Message>
<Contexts/>
</Error>

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)