API Reference

This section describes the web services used to get information from Oracle Identity Analytics regarding roles and policies.

Find Roles in Business Units

This web service provides the capability to search for roles in a particular business unit. The request parameters are the business unit name (businessUnitName), traverse, and stopWhenFound, and the response is a RoleVO[] array associated with the business unit.

Method Signature

public RoleVO[] findRolesInBusinessUnit(String businessUnitName, boolean traverse, boolean stopWhenFound) throws RbacxServiceException

Request Parameters

Name	Data Type	Description
`businessUnitName`	`String`	The name of the business unit to be queried for roles.
`traverse`	`Boolean`	If `true`, traverse the business unit tree to find roles.
`stopWhenFound`	`Boolean`	If `true`, stop traversing the business unit tree as soon as roles are found. If `false`, continue traversing the entire tree.

Response

Data Type	Description
`RoleVO[]`	An array of `RoleVO` objects containing role information is returned from the requested business unit. An empty array is returned if no roles are found.

Exception

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

Find Users in Role

This web service searches for all users who have access to a particular role. The request parameter is the String roleName, and the response is a UserVO[] array that contains all users with the role specified.

Method Signature

public UserVO[] findUsersInRole(String roleName) throws RbacxServiceException

Request Parameters

Name	Data Type	Description
`roleName`	`String`	The name of the role to be queried for users.

Response

Data Type	Description
`UserVO[]`	An array of `UserVO` containing user information. An empty array is returned if no users are found.

Exception

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

Assign User to Role

This web service assigns a role to a user. The request parameters are roleName, username, startDateVO, and endDateVO, and a Boolean flag is returned to indicate the result of the assignment.

Method Signature

public boolean assignUserToRole(String roleName, String userName, DateVO startDateVO, DateVO endDateVO) throws RbacxServiceException

Request Parameters

Name	Data Type	Description
`roleName`	`String`	The name of the role that is being assigned.
`username`	`String`	The name of the user to whom the role needs to be assigned.
`startDateVO`	`DateVO`	The date that the role association should start.
`endDateVO`	`DateVO`	The date that the role association should end.

Response

Data Type	Description
`Boolean`	`True` if the role is successfully assigned to the user; `false` otherwise.

Exception

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

Remove User From Role

This web service removes a user from a role. The request parameters are roleName and username, and a Boolean flag is returned to indicate the result of the removal.

Method Signature

public boolean removeUserFromRole(String roleName, String userName) throws RbacxServiceException

Request Parameters

Name	Data Type	Description
`roleName`	`String`	The name of the role that needs to be removed from the user.
`username`	`String`	The name of the user from whom the role should be removed.

Response

Data Type	Description
`Boolean`	`True` if the user is successfully removed from the role; `false` otherwise.

Exception

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

Preview User to Role Assignment

This web service previews the results of a rule-based role assignment. The request parameters are userVO[] and modifiedAccounts, and the response is RoleVO[].

Method Signature

public RoleVO[] userRoleAssignmentPreview(UserVO user, AccountVO[] modifiedAccounts) throws RbacxServiceException

Request Parameters

Name	Data Type	Description
`user`	`UserVO`	An `UserVO` for whom the role assignment needs to be previewed.
`modifiedAccounts`	`AccountVO[]`	An array of `AccountVO` that is allocated to the user.

Response

Data Type	Description
`RoleVO[]`	An array of `RoleVO` containing role value objects is returned from the requested list of users. An empty array is returned if no roles are found.

Exception

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

Skip Navigation Links
Exit Print View
	Oracle Identity Analytics API Guide 11g Release 1