This chapter contains the following sections:
Oracle Identity Analytics Web Services (web services) have been designed to support interaction of third-party systems with the user information inside Oracle Identity Analytics 11gR1 software. A set of methods are provided to perform various operations inside Oracle Identity Analytics such as adding, deleting, or modifying users.
This chapter describes the web services used to get information from Oracle Identity Analytics regarding users in the Identity Warehouse.
Each web service has two parts: the request parameters and the response. For example, to obtain a list of roles allocated to a user, use the username
request parameter. The RoleVO
object is then returned with the information on the user's roles.
Note - The User Management Service has been deprecated and is superseded by the User Service. Implementations using methods from the User Management Service, however, can continue to use the older methods.
WSDL stands for Web Services Description Language. It is an XML format for describing web services as a set of endpoints operating on messages, and 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 User Service WSDL through a browser:
http://
server-name:
port-number/rbacx/ws/userService?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/userService?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 information from Oracle Identity Analytics regarding users.
This web service finds all of the users filtered by a specific criteria. The request parameter is the String filterString
, and an array of UserVO[]
objects is returned with all of the users that satisfy the filter string.
public UserVO[] findUsers(String filterString) throws RbacxServiceException
Name | Data Type | Description |
---|---|---|
filterString |
String |
The string to filter to find all of the users. |
This web service finds the roles allocated to a user. The request parameter is the string username
whose roles need to be found, and an array of RoleVO[]
objects is returned with the information on the user's roles.
public RoleVO[] getRolesForUser(String userName) throws RbacxServiceException
Name | Data Type | Description |
---|---|---|
userName |
String |
The user name for which roles need to be checked. |
This web service finds the accounts associated with a user. The request parameter is the String username
, and an array of AccountVO[]
objects is returned with a list of all the accounts that the user has.
public AccountVO[] getAccountsForUser(String userName) throws RbacxServiceException
Name | Data Type | Description |
---|---|---|
userName |
String |
The user name for which an account list needs to be generated. |
This web service creates a new user. The request parameter is UserVO
user, and a Boolean is returned indicating whether or not the user was created.
Name | Data Type | Description |
---|---|---|
user |
UserVO |
The user object that needs to be created. |
Data Type | Description |
---|---|
Boolean |
True if the user has been successfully created; false otherwise. |
This web service creates a new user if there is a rule-based role assignment. The request parameters are UserVO
user and a Boolean, isRuleBasedRoleAssignment
. A Boolean is returned indicating whether or not the user was created.
public boolean createUser(UserVO user, boolean isRuleBasedRoleAssignment) throws RbacxServiceException
Name | Data Type | Description |
---|---|---|
user |
UserVO |
The user object that needs to be created. |
isRuleBasedRoleAssignment |
Boolean | True if it is a rule-based role assignment; false otherwise. |
Data Type | Description |
---|---|
Boolean |
True if the user has been successfully created; false otherwise. |
This web service provides the capability to update an existing user. The request parameter is UserVO
user, and a Boolean is returned indicating whether or not the user was successfully updated.
Name | Data Type | Description |
---|---|---|
user |
UserVO |
The user object that needs to be updated. |
Data Type | Description |
---|---|
Boolean |
True if the user has been successfully updated; false otherwise. |
This web service updates a user if there is a rule-based role assignment. The request parameter is UserVO
user
and a Boolean, isRuleBasedRoleAssignment
. A Boolean is returned indicating whether or not the user was updated.
public boolean updateUser(UserVO user, boolean isRuleBasedRoleAssignment) throws RbacxServiceException
Name | Data Type | Description |
---|---|---|
user |
UserVO |
The user object that needs to be created. |
isRuleBasedRoleAssignment |
Boolean |
True if it is a rule-based role assignment; false otherwise. |
Data Type | Description |
---|---|
Boolean | True if the user has been successfully updated; false otherwise. |
This web service disables existing users. The request parameter is a list of usernames, and a Boolean is returned indicating whether or not all of the users were disabled.
public boolean disableUsers(String[] userNames) throws RbacxServiceException
Name | Data Type | Description |
---|---|---|
usernames |
String[] |
A list of usernames that have to be disabled. |
Data Type | Description |
---|---|
Boolean |
True if all of the users have been disabled; false otherwise. |
This web service provides the capability to enable existing users. The request parameter is a list of usernames
, and a Boolean is returned indicating whether or not all of the users were enabled.
public boolean enableUsers(String[] userNames) throws RbacxServiceException
Name | Data Type | Description |
---|---|---|
usernames |
String[] |
A list of usernames that need to be enabled. |
Data Type | Description |
---|---|
Boolean |
True if all of the users are enabled; false otherwise. |
This web service finds the business units assigned to a user. The request parameter is the string username
whose business units need to be found. An array of BusinessUnitVO[]
objects is returned with the information on the user's business units.
public BusinessUnitVO[] getBusinessUnitsForUser(String userName) throws RbacxServiceException
Name | Data Type | Description |
---|---|---|
userName |
String |
The user name for which business units need to be checked. |
Data Type | Description |
---|---|
BusinessUnitVO[] |
An array of BusinessUnitVO objects is returned. |
This web service removes all the roles from a user. The request parameter is the String username
, and a Boolean flag is returned to indicate the result.
public boolean removeAllRolesfromUser(String userName) throws RbacxServiceException
Name | Data Type | Description |
---|---|---|
userName |
String |
The name of the user whose roles need to be removed. |
Data Type | Description |
---|---|
Boolean |
True if all the roles have been successfully removed from the user; false otherwise. |