Jump to

• Request
• Response

Returns the recorded events

get

https://<servername>/oam/services/rest/access/api/v1/audit/events

Returns the recorded events for the specified time period

Request

Query Parameters

• fromDate(required): string
  The UTC time from when the events are to be retrieved
• pageNumber(required): integer
  The UTC time from when the events are to be retrieved
• pageSize(required): integer
  The maximum number of events to retrieve
• toDate(required): string
  The UTC time up to when the events are to be retrieved

There's no request body for this operation.

Security

• audit_auth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Returns the recorded events

Body ()

Root Schema : Events

Type: object

Collection of data associated with a specific audit event

Show Source

• eventData: array eventData

{ "type":"object", "properties":{ "eventData":{ "type":"array", "items":{ "$ref":"#/components/schemas/EventData" } } }, "description":"Collection of data associated with a specific audit event" }

Nested Schema : eventData

Type: array

Show Source

• Array of: object EventData

{ "type":"array", "items":{ "$ref":"#/components/schemas/EventData" } }

Nested Schema : EventData

Type: object

Show Source

• accessTime: string
  Specifies the UTC timestamp of the sign-on
• attributeMap: array AttributeMap
  List of Attribute Values
• eventID: integer (int64)
• ipAddress: string
  IP Address of the User Agent
• mfaUsed: boolean
  Indicates whether multi factor authentication was used to sign-on
• oracleECID: string
  Execution Context Identifier
• status: string
  Indicates whether sign-on was successful or denied
• type: string
  Specifies the type of Event (e.g. AuthN, Logout)
• userID: object User

{ "type":"object", "properties":{ "eventID":{ "type":"integer", "description":"", "format":"int64" }, "userID":{ "$ref":"#/components/schemas/User" }, "type":{ "type":"string", "description":"Specifies the type of Event (e.g. AuthN, Logout)" }, "ipAddress":{ "type":"string", "description":"IP Address of the User Agent" }, "status":{ "type":"string", "description":"Indicates whether sign-on was successful or denied" }, "accessTime":{ "type":"string", "description":"Specifies the UTC timestamp of the sign-on" }, "mfaUsed":{ "type":"boolean", "description":"Indicates whether multi factor authentication was used to sign-on" }, "oracleECID":{ "type":"string", "description":"Execution Context Identifier" }, "attributeMap":{ "$ref":"#/components/schemas/AttributeMap" } } }

Nested Schema : AttributeMap

Type: array

List of Attribute Values

Show Source

• Array of: object Attribute

{ "type":"array", "description":"List of Attribute Values", "items":{ "$ref":"#/components/schemas/Attribute" } }

Nested Schema : User

Type: object

Show Source

• loginID: string
  Login ID of the User
• loginType: string
  Type of Login
• userDN: string
  Distinguished Name of the User
• userGUID: string
  GUID of the User

{ "type":"object", "properties":{ "loginID":{ "type":"string", "description":"Login ID of the User" }, "loginType":{ "type":"string", "description":"Type of Login" }, "userDN":{ "type":"string", "description":"Distinguished Name of the User" }, "userGUID":{ "type":"string", "description":"GUID of the User" } } }

Nested Schema : Attribute

Type: object

Show Source

• key: string
  Name of the Attribute
• value: array value
  Value of the Attribute (format is defined by named attribute)

{ "type":"object", "properties":{ "key":{ "type":"string", "description":"Name of the Attribute" }, "value":{ "type":"array", "description":"Value of the Attribute (format is defined by named attribute)", "items":{ "type":"string" } } } }

Nested Schema : value

Type: array

Value of the Attribute (format is defined by named attribute)

Show Source

• Array of: string

{ "type":"array", "description":"Value of the Attribute (format is defined by named attribute)", "items":{ "type":"string" } }

400 Response

Invalid Request

401 Response

Invalid Credentials supplied

403 Response

Access Denied

503 Response

Service Temporarily Unavailable. Please retry request after some time

Back to Top