You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com. For cross-site search, click Search all in the search results.

List Audit Entries for a User

Resource Summary

Security

Content Type

application/octet-stream

Category

Audits,

ListAuditEntriesforaUser

GET

List Audit Entries for a User

This API is released for use in Edge for the Private Cloud only and requires System Admin credentials.  



Lists audit records for management operations for a user.

For every call made to the management API, Apigee Edge logs an audit record. This API enables you to obtain a record of all management calls made against a user. The audit logs provide access to the actions (create, read, update, delete) executed on the user.

If there are no audit records, or if the entity does not exist, this API returns an empty array.

If you omit the timeline, startTime, and endTime query parameters, the default is to use timeline=today.

Resource URL

https://api.enterprise.apigee.com/v1 /audits/users/{user_email}

Query Parameters

Name Values Description
timeline

Filters results by the specified time interval. Valid values are today, week, month. If you usetimeline, don't use startTime or endTime.

If you omit the timeline, startTime, and endTime query parameters, the default is timeline=today.

startTime

The beginning date/time from which audit entries should be returned, in Unix epoch format in milliseconds. (Here's an epoch time generator. Add "000" to the end of normal epoch time to get milliseconds.)

Use startTime by itself or with endTime to specify a range. Don't use with timeline.

If you omit the timeline, startTime, and endTime query parameters, the default is timeline=today.

endTime

The ending date/time up to which audit entries should be returned, in Unix epoch format in milliseconds. (Here's an epoch time generator. Add "000" to the end of normal epoch time to get milliseconds.)

Use endTime by itself or with startTime to specify a range. Don't use with timeline.

If you omit the timeline, startTime, and endTime query parameters, the default is timeline=today.

rows

A limit on the total number of audit entries to be returned when you specify either startTime or endTime.

Header Parameters

Name Values Description
Content-Type
(required)

Specify content type as octet-stream.

Request Body

user_email Mention the email address of the user true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)