API Reference

This section describes the web services used to get business unit information from the Oracle Identity Analytics Identity Warehouse.

Add Roles to a Business Unit

This web service adds roles to a business unit. The request parameters are the businessUnitName and the roleNames that should be added to the business unit. A Boolean flag is returned indicating if the roles were successfully added.

Method Signature

public boolean addRolesToBusinessUnit(String businessUnitName, String[] roleNames) throws RbacxServiceException

Request Parameter

Name Data Type Description businessUnitName String The name of the business unit to which one or more roles should be added. roleNames String[] The list of roles that need to be added to the business unit.

Response

Data Type Description Boolean True if the roles are successfully added to the business unit; false otherwise.

Exception

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

Remove Roles From a Business Unit

This web service removes roles from a business unit. The request parameters are businessUnitName and roleNames. A Boolean flag is returned indicating if the roles were successfully removed.

Method Signature

public boolean removeRolesFromBusinessUnit(String businessUnitName, String[] roleNames) throws RbacxServiceException

Request Parameters

Name Data Type Description businessUnitName String The name of the business unit from which one or more roles should be removed. roleNames String[] The list of roles that need to be removed from a business unit.

Response

Data Type Description Boolean True if the roles are successfully removed from the business unit; false otherwise.

Exception

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

Add Users to a Business Unit

This web service adds users to a business unit. The request parameters are the businessUnitName and String[] userNames that need to be associated. A Boolean flag is returned indicating the result of the businessunit-users association.

Method Signature

public boolean addUsersToBusinessUnit(String businessUnitName, String[] userNames) throws RbacxServiceException

Request Parameters

Name Data Type Description businessUnitName String The name of the business unit to be queried for users. userNames String[] The user names that need to be associated with the business unit.

Response

Data Type Description Boolean True if a businessunit-role membership is successfully established; false otherwise.

Exception

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

Remove Users From a Business Unit

This web service removes users from a business unit. The request parameters are the businessUnitName and userNames. A Boolean flag is returned indicating the results of the businessunit-users disassociation.

Method Signature

public boolean removeUsersFromBusinessUnit(String businessUnitName, String[] userNames) throws RbacxServiceException

Request Parameter

Name Data Type Description businessUnitName String The name of the business unit to be queried for users. userNames String[] The user names that need to be removed from the business unit.

Response

Data Type Description Boolean True if the users are removed from the business unit; false otherwise.

Exception

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

Get Parent Business Structure for a Business Unit

This web service gets the parent for a particular business unit. The request parameter is the string businessUnitName, and an array of BusinessUnitVO[] is returned.

Method Signature

public BusinessUnitVO[] getParentBusinessUnits(String businessUnitName) throws RbacxServiceException

Request Parameter

Name Data Type Description businessUnitName String Name of the business unit for which the parent business unit name needs to be queried.

Response

Data Type Description BusinessUnitVO[] An array of BusinessUnit value objects is returned.

Exception

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

Get Children of a Business Unit

This web service gets the children of a particular business unit. The request parameter is the string businessUnitName, and BusinessUnitVO[] is returned.

Method Signature

public BusinessUnitVO[] getChildrenBusinessUnits(String businessUnitName) throws RbacxServiceException

Request Parameter

Name Data Type Description businessUnitName String The name of the business unit for which the child business units need to be queried.

Response

Data Type Description BusinessUnitVO[] The names of the child business units are returned in a value object.

Exception

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

Update Business Unit

This web service provides the capability to update an existing business unit. The request parameter is businessUnitVO, and a Boolean is returned indicating whether the business unit was successfully updated.

Method Signature

public boolean updateBusinessUnit(BusinessUnitVO businessUnitVO) throws RbacxServiceException

Request Parameter

Name Data Type Description businessUnitVO BusinessUnitVO The name of the business unit that needs to be updated.

Response

Data Type Description Boolean True if the update was successful; false otherwise.

Exception

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