JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Identity Analytics API Guide 11g Release 1
search filter icon
search icon

Document Information

Preface

1.  User Service

2.  Role Service

3.  Business Unit Service

4.  Identity Audit Service

Overview

WSDL Access

API Reference

Get All Open Exceptions

Method Signature

Request Parameters

Response

Exception

Get All Audit Exceptions Based on the State

Method Signature

Request Parameters

Response

Exception

Mitigate Exception

Method Signature

Request Parameters

Response

Exception

Check Audit Exceptions for Users

Method Signature

Request Parameters

Response

Exception

5.  Web Service Exception Handling

API Reference

This section describes the web services used to get information from Oracle Identity Analytics regarding audit violations.

Get All Open Exceptions

This web service returns all open audit exceptions. An AuditExceptionVO[] array object containing the information on audit exceptions is returned.

Method Signature

AuditExceptionVO[] getAllOpenAuditExceptions() throws RbacxServiceException

Request Parameters

None

Response
Data Type
Description
AuditExceptionVO[]
An array of AuditExceptionVO value objects is returned.
Exception

This method throws an RbacxService Exception that has an error code and an error message.

Get All Audit Exceptions Based on the State

This web service returns all audit exceptions based on the state of the exception. The request parameter is the integer value indicating the state of the exception. An array of AuditExceptionVO[] objects containing audit exception information is returned.

Method Signature

public AuditExceptionVO[] getAuditExceptions(int state) throws RbacxServiceException;

Request Parameters
Name
Data Type
Description
state
int
Integer value indicating the state of exception.
Response
Data Type
Description
AuditExceptionVO[]
An array of AuditExceptionVO value objects is returned.
Exception

This method throws an RbacxService Exception that has an error code and an error message.

Mitigate Exception

This web service marks the audit exception as "risk accepted." The request parameters are exceptionID, comments, and expireDate, and a Boolean flag is returned indicating the result of the action.

Method Signature

public boolean mitigateException(Long exceptionId, String comments, Date expireDate) throws RbacxServiceException

Request Parameters
Name
Data Type
Description
exceptionID
Long
The audit exception that needs to be temporarily marked as risk accepted.
comments
String
Comments explaining why the exception is to be marked as risk accepted.
expireDate
dateTime
The date that the mitigation action expires.
Response
Data Type
Description
Boolean
True if the audit exception is successfully mitigated; false otherwise.
Exception

This method throws an RbacxService Exception that has an error code and an error message.

Check Audit Exceptions for Users

This web service checks for audit exceptions when changes are made to the accounts and roles of a user. The request parameters are user, modifiedAccounts, and roleVOs, and an AuditExceptionVO[]

array is returned with the information on audit exceptions for that user.

Method Signature

public AuditExceptionVO[] checkForAuditExceptions(UserVO user, AccountVO[] modifiedAccounts, RoleVO[] roleVOs) throws RbacxServiceException

Request Parameters
Name
Data Type
Description
user
UserVO
User name for which the exception needs to be checked.
modifiedAccounts
AccountVO[]
An array of modified AccountVO objects.
roleVOs
RoleVO[]
An array of RoleVO objects.
Response
Data Type
Description
AuditExceptionVO[]
An array of AuditException value objects is returned.
Exception

This method throws an RbacxService Exception that has an error code and an error message.