API Reference
This section describes the web services used to get information from Oracle Identity
Analytics regarding users.
Find All Users by Filter String
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.
Method Signature
public UserVO[] findUsers(String filterString) throws RbacxServiceException
Request Parameters
|
|
|
filterString |
String |
The string to filter to find all of the users. |
|
Response
|
|
UserVO[] |
An array of UserVO objects is returned. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Find Roles For A User
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.
Method Signature
public RoleVO[] getRolesForUser(String userName) throws RbacxServiceException
Request Parameters
|
|
|
userName |
String |
The user name for which roles need to be checked. |
|
Response
|
|
RoleVO[] |
An array of RoleVO objects is returned. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Find Accounts for a User
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.
Method Signature
public AccountVO[] getAccountsForUser(String userName) throws RbacxServiceException
Request Parameters
|
|
|
userName |
String |
The user name for which an account list needs to be
generated. |
|
Response
|
|
AccountVO[] |
An array of AccountVO objects
is returned. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Create a New User
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.
Method Signature
public boolean createUser(UserVO user) throws RbacxServiceException
Request Parameter
|
|
|
user
|
UserVO |
The user object that needs to be created.
|
|
Response
|
|
Boolean |
True if the
user has been successfully created; false otherwise. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Create a New User if Rule-Based Role Assignment
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.
Method Signature
public boolean createUser(UserVO user, boolean isRuleBasedRoleAssignment{}) throws RbacxServiceException
Request Parameter
|
|
|
user
|
UserVO |
The user object that needs to be created.
|
isRuleBasedRoleAssignment |
Boolean |
True if it is a rule-based role
assignment; false otherwise . |
|
Response
|
|
Boolean |
True if the user has been successfully created;
false otherwise. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Update User
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.
Method Signature
public boolean updateUser(UserVO user) throws RbacxServiceException
Request Parameter
|
|
|
user |
UserVO |
The user object that needs to be updated. |
|
Response
|
|
Boolean |
True if the user has been successfully updated;
false otherwise. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Update User if Rule-Based Role Assignment
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.
Method Signature
public boolean updateUser(UserVO user, boolean isRuleBasedRoleAssignment) throws RbacxServiceException; {}
Request Parameter
|
|
|
user
|
UserVO |
The user object that needs to be created.
|
isRuleBasedRoleAssignment |
Boolean |
True if it is a rule-based role
assignment; false otherwise . |
|
Response
|
|
Boolean |
True if the user has been successfully updated;
false otherwise. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Disable Users
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.
Method Signature
public boolean disableUsers(String[] userNames) throws RbacxServiceException
Request Parameters
|
|
|
usernames |
String[] |
A list of usernames that have to be disabled. |
|
Response
|
|
Boolean |
True if all of the users have
been disabled; false otherwise. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Enable Users
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.
Method Signature
public boolean enableUsers(String[] userNames) throws RbacxServiceException
Request Parameter
|
|
|
usernames |
String[] |
A list of usernames that need to be enabled. |
|
Response
|
|
Boolean |
True if all of the users are
enabled; false otherwise. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Find Business Units for a User
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.
Method Signature
public BusinessUnitVO[] getBusinessUnitsForUser(String userName) throws RbacxServiceException
Request Parameters
|
|
|
userName |
String |
The user name for which business units need to be checked. |
|
Response
|
|
BusinessUnitVO[] |
An array of BusinessUnitVO objects is
returned. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.
Remove All Roles From User
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.
Method Signature
public boolean removeAllRolesfromUser(String userName) throws RbacxServiceException
Request Parameters
|
|
|
userName |
String |
The name of the user whose roles need to be removed. |
|
Response
|
|
Boolean |
True if all the roles
have been successfully removed from the user; false otherwise. |
|
Exception
This method throws an RbacxService Exception that has an error code and an
error message.