Accessing Audit and User Reports Using Identity Cloud Service REST APIs
Using the Audit Events REST endpoints, Identity Domain Administrator can utilize Oracle Identity Cloud Services audit event data to complete these tasks:
- Generate reports of users’ activities
- Capture historical user activities
- Analyze application usage
See the following information sources in REST API for Oracle Identity Cloud Service:
- Using the Audit Event APIs for detailed information on audit events REST endpoints.
- Search Audit Events for information on Search by GET action.
To access audit and user reports using Identity Cloud Service REST APIs, you need to complete these steps:
- Set up authentication with OAuth 2 for your REST client to get refresh token and Client ID
- Use the refresh token and Client ID to get the access token to issue the REST API to IDCS
For information on completing these tasks, see Authentication with OAuth 2 - Only for OCI (Gen 2) Environments in REST API for Oracle Enterprise Performance Management Cloud.
Accessing IDCS audit endpoints requires urn:opc:idm:__myscopes__scope.
Table 7-1 IDCS Audit Event Endpoints
| Action | Method | Endpoint |
|---|---|---|
| Search by GET | GET | /admin/v1/AuditEvents |
| Search by POST | POST | /admin/v1/AuditEvents/.search |
| Get by Event ID | GET | /admin/v1/AuditEvents/{id} |
Elaborate search queries can be constructed using the following:
- Filter parameters to select events based on attributes (see SCIM specifications)
- Attributes to filter and to return
- Sort to sort results and set sort order
- Count to limit the number of events per page
- Start index to support pagination (see SCIM specifications)