This chapter contains the following sections:
This chapter describes the web services used to get business unit information from the Oracle Identity Analytics Identity Warehouse.
Each web service has two parts: request parameters and the response. Request parameters such as businessUnitname are used to request a business unit.
Note:
The BusinessUnit Management Service has been deprecated and is superseded by the Business Unit Service. Implementations using methods from the BusinessUnit Management Service, however, can continue to use the older methods.WSDL stands for Web Services Description Language. It is an XML format that describes web services as a set of endpoints operating on messages, and that contains information on how to access them. It specifies the location of each service and the operations (or methods) the service exposes.
Use the following to access the Business Unit Service WSDL through a browser:
http://server-name:port-number/rbacx/ws/businessUnitService?wsdl
where server-name is the IP address or alias of the server on which Oracle Identity Analytics is running, and port-number is the port number of the application server that is listening to Oracle Identity Analytics calls.
Example:
http://localhost:8081/rbacx/ws/businessUnitService?wsdl
In the previous example, localhost is the server name, and 8081 is the port number of the application server.
This section describes the web services used to get business unit information from the Oracle Identity Analytics Identity Warehouse.
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.
public boolean addRolesToBusinessUnit(String businessUnitName, String[] roleNames) throws RbacxServiceException
| 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. |
| Data Type | Description |
|---|---|
Boolean |
True if the roles are successfully added to the business unit; false otherwise. |
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.
public boolean removeRolesFromBusinessUnit(String businessUnitName, String[] roleNames) throws RbacxServiceException
| 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. |
| Data Type | Description |
|---|---|
Boolean |
True if the roles are successfully removed from the business unit; false otherwise. |
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.
public boolean addUsersToBusinessUnit(String businessUnitName, String[] userNames) throws RbacxServiceException
| 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. |
| Data Type | Description |
|---|---|
Boolean |
True if a businessunit-role membership is successfully established; false otherwise. |
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.
public boolean removeUsersFromBusinessUnit(String businessUnitName, String[] userNames) throws RbacxServiceException
| 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. |
| Data Type | Description |
|---|---|
| Boolean | True if the users are removed from the business unit; false otherwise. |
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.
public BusinessUnitVO[] getParentBusinessUnits(String businessUnitName) throws RbacxServiceException
| Name | Data Type | Description |
|---|---|---|
businessUnitName |
String |
Name of the business unit for which the parent business unit name needs to be queried. |
| Data Type | Description |
|---|---|
BusinessUnitVO[] |
An array of BusinessUnit value objects is returned. |
This web service gets the children of a particular business unit. The request parameter is the string businessUnitName, and BusinessUnitVO[] is returned.
public BusinessUnitVO[] getChildrenBusinessUnits(String businessUnitName) throws RbacxServiceException
| Name | Data Type | Description |
|---|---|---|
businessUnitName |
String | The name of the business unit for which the child business units need to be queried. |
| Data Type | Description |
|---|---|
BusinessUnitVO[] |
The names of the child business units are returned in a value object. |
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.
public boolean updateBusinessUnit(BusinessUnitVO businessUnitVO) throws RbacxServiceException
| Name | Data Type | Description |
|---|---|---|
businessUnitVO |
BusinessUnitVO |
The name of the business unit that needs to be updated. |