Skip navigation links

oracle.iam.identity.usermgmt.api
Interface UserManager

public interface UserManager

The UserManager API exposes the methods to manage a user. To manage a user, it provides functionality to create, modify, enable, disable, delete, lock and unlock the user. It also provides the support for bulk modify, enable, disable, delete, lock and unlock user operations. Apart from basic user operations, there are proxy related operations to get user's proxy details and assign, remove and update the proxy of a user.

Method Summary

long	addProxyForUser(java.lang.String userID, long proxyUserKey, java.util.Date startDate, java.util.Date endDate, boolean isUserLogin) Adds/Sets proxy for user in OIM and BPEL.
void	changePassword(java.lang.String userID, char[] password, boolean isUserLogin) Changes the user's password.
void	changePassword(java.lang.String userID, char[] password, boolean isUserLogin, java.util.Locale locale, boolean setPasswordResetFlag) Changes the user's password.
void	changePassword(java.lang.String attributeName, java.lang.Object attributeValue, char[] password) Changes the user's password.
UserManagerResult	create(User user) This method creates a user in the backend data store
UserManagerResult	create(User user, java.util.Map controls) This method creates a user in the backend data store, it takes a Map of additional control parameters wihch could be used for performing additional opreration along with creating user.
UserManagerResult	delete(java.util.ArrayList userIDs, boolean isUserLogin) Bulk delete operation.
UserManagerResult	delete(java.lang.String userID, boolean isUserLogin) Marks the user as deleted.
UserManagerResult	delete(java.lang.String attributeName, java.lang.Object attributeValue) Marks the user matching the specified search criteria as deleted.
UserManagerResult	disable(java.util.ArrayList userIDs, boolean isUserLogin) Bulk disable operation.
UserManagerResult	disable(java.lang.String userID, boolean isUserLogin) Disables the user account.
UserManagerResult	disable(java.lang.String attributeName, java.lang.Object attributeValue) Disables the user account matching the search criteria.
UserManagerResult	enable(java.util.ArrayList userIDs, boolean isUserLogin) Bulk enable operation.
UserManagerResult	enable(java.lang.String userID, boolean isUserLogin) Enables the user account.
UserManagerResult	enable(java.lang.String attributeName, java.lang.Object attributeValue) Enables the user account matching the search criteria.
java.lang.String	generateUserName(java.util.Map attrMap) Suggest a username based on OIM's default username policy.
java.lang.String	generateUserName(java.lang.String policyID, java.util.Map attrMap) Suggest a username based on the given username policy.
java.util.List	getAllProxies(java.lang.String userID, boolean isUserLogin) Gets a list of the all the proxy for the given user
java.util.List	getAllUserNamePolicies(java.util.Locale locale) Gives the details of all the username policies configured in OIM.
java.util.List	getCurrentProxies(java.lang.String userID, boolean isUserLogin) Returns the current proxy details of the specified user
User	getDetails(java.lang.String attributeName, java.lang.Object attributeValue, java.util.Set retAttrs) Returns the profile details of the specified user.
User	getDetails(java.lang.String userID, java.util.Set retAttrs, boolean isUserLogin) Returns the profile details of the specified user.
java.util.List	getPastProxies(java.lang.String userID, boolean isUserLogin) Returns the past proxy details of the specified user
java.lang.String	getPolicyDescription(java.lang.String policyID, java.util.Locale locale) Gives the details of the username policy configured in OIM with the given ID
boolean	isUserNameValid(java.lang.String userName, java.util.Map attrMap) Check the validity of the given username based on default policy.
boolean	isUserNameValid(java.lang.String userName, java.lang.String policyID, java.util.Map attrMap) Check the validity of the given username based on given policy.
UserManagerResult	lock(java.util.ArrayList userIDs, boolean manualFlag, boolean isUserLogin) Bulk lock operation.
UserManagerResult	lock(java.lang.String userID, boolean manualFlag, boolean isUserLogin) Locks the OIM user account, provided the user has an OIM account provisioned.
UserManagerResult	lock(java.lang.String attributeName, java.lang.Object attributeValue, boolean manualFlag) Locks the OIM user account matching the search criteria, provided the user has an OIM account provisioned.
UserManagerResult	modify(java.util.ArrayList userIDs, java.util.HashMap args, boolean isUserLogin) Modifies users in bulk.
UserManagerResult	modify(java.lang.String attributeName, java.lang.Object attributeValue, User user) This method updates an existing user, matching the specified search criteria, with the values specified.
UserManagerResult	modify(User user) This method updates the 'user' with the values in the passed VO.
void	removeAllProxiesForUser(java.lang.String userID, boolean isUserLogin) Removes all proxies for user.
void	removeProxy(java.lang.String userID, long proxyKey, boolean isUserLogin) Removes a single proxy (identified by key proxyKey) for the given user (identified by userID).
void	removeProxy(java.lang.String userID, long proxyKey, java.util.Map attrMap, boolean isUserLogin) Deprecated. Please use removeProxy(String userID, long proxyKey, boolean isUserLogin) instead
java.util.List	search(SearchCriteria criteria, java.util.Set retAttrs, java.util.HashMap configParams) Searches for users matching the specified SearchCriteria.
UserManagerResult	unlock(java.util.ArrayList userIDs, boolean isUserLogin) Bulk unlock operation.
UserManagerResult	unlock(java.lang.String userID, boolean isUserLogin) Unlocks the OIM user account, provided the user has an OIM account, and it is locked.
UserManagerResult	unlock(java.lang.String attributeName, java.lang.Object attributeValue) Unlocks the OIM user account matching the search criteria, provided the user has an OIM account, and it is locked.
void	updateProxyForUser(long pxdKey, java.util.Map attribute) Updates the proxy with key pxdKey Only proxy user, start date and/or end date can be modified for the given proxy.

Method Detail

create

UserManagerResult create(User user)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserAlreadyExistsException,
                                UserCreateException

This method creates a user in the backend data store

Parameters:

user - This VO contains the attributes for the user to be created

Returns:

UserManagerResult containing the entity id of the user created in DB.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserAlreadyExistsException - if the login id of the user is not available.

UserCreateException - if the orchestration fails for create operation.

create

UserManagerResult create(User user,
                         java.util.Map controls)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserAlreadyExistsException,
                                UserCreateException

This method creates a user in the backend data store, it takes a Map of additional control parameters wihch could be used for performing additional opreration along with creating user.

Parameters:

user - This VO contains the attributes for the user to be created

controls - This Map contains control parameters used for performing additional opreration along with creating user.
Supported Control Parameters:

• SentNotification - Boolean flag whether to send notification or not.
• SendNotificationTo - Comma separated email address.

Returns:

UserManagerResult containing the entity id of the user created in DB.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserAlreadyExistsException - if the login id of the user is not available.

UserCreateException - if the orchestration fails for create operation.

modify

UserManagerResult modify(java.lang.String attributeName,
                         java.lang.Object attributeValue,
                         User user)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserModifyException,
                                NoSuchUserException,
                                SearchKeyNotUniqueException

This method updates an existing user, matching the specified search criteria, with the values specified.

Parameters:

attributeName - - The attribute name for the search criteria.

attributeValue - - The attribute value for the search criteria.

user - The attributes and values to update the user with.

Returns:

UserManagerResult containing the entity id of the modified user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserModifyException - if the orchestration fails for modify operation.

NoSuchUserException - if the user is not found.

SearchKeyNotUniqueException - if there is more than one user matching the search criteria.

modify

UserManagerResult modify(User user)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserModifyException,
                                NoSuchUserException

This method updates the 'user' with the values in the passed VO.

Parameters:

user - The User VO containing the details of the user to be updated

Returns:

UserManagerResult containing the entity id of the modified user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserModifyException - if the orchestration fails for modify operation.

NoSuchUserException - if the user with given key is not found.

modify

UserManagerResult modify(java.util.ArrayList userIDs,
                         java.util.HashMap args,
                         boolean isUserLogin)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserModifyException,
                                NoSuchUserException

Modifies users in bulk. The profile of all users whose key is in userIDs list are updated with value of all bulk modifiable attribute specified in the map.

Parameters:

userIDs - The ids of the users whose profiles are to be updated. The isUserLogin flag will decide what does userID contains.

args - The common set of attributes and values to update the users with.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the list of success and failure results. Each failure result has a reason for failure associated with it.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserModifyException - if the orchestration fails for modify operation.

NoSuchUserException - if the user with given key is not found.

delete

UserManagerResult delete(java.lang.String userID,
                         boolean isUserLogin)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserDeleteException,
                                NoSuchUserException

Marks the user as deleted. This is a soft delete operation and will not remove the user from the data store.

Parameters:

userID - The id of the user to be marked for deletion. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the entity id of the deleted user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserDeleteException - if the orchestration fails for delete operation.

NoSuchUserException - if the user with given key is not found.

delete

UserManagerResult delete(java.lang.String attributeName,
                         java.lang.Object attributeValue)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserDeleteException,
                                NoSuchUserException,
                                SearchKeyNotUniqueException

Marks the user matching the specified search criteria as deleted. This is a soft delete operation and will not remove the user from the data store.

Parameters:

attributeName - - The attribute name for the search criteria.

attributeValue - - The attribute value for the search criteria.

Returns:

UserManagerResult containing the entity id of the deleted user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserDeleteException - if the orchestration fails for delete operation.

NoSuchUserException - if the user with given key is not found.

SearchKeyNotUniqueException - if there is more than one user of the search criteria.

delete

UserManagerResult delete(java.util.ArrayList userIDs,
                         boolean isUserLogin)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserDeleteException,
                                NoSuchUserException

Bulk delete operation. It will mark all specified users as deleted.

Parameters:

userIDs - The ids of the user to be marked for deletion. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the list of success and failure results. Each failure result has a reason for failure associated with it.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserDeleteException - if the orchestration fails for delete operation.

NoSuchUserException - if the user with given key is not found.

getDetails

User getDetails(java.lang.String userID,
                java.util.Set retAttrs,
                boolean isUserLogin)
                throws AccessDeniedException,
                       NoSuchUserException,
                       UserLookupException

Returns the profile details of the specified user.

Parameters:

userID - The id of the user who's details are required. The isUserLogin flag will decide what does userID contains.

retAttrs - The list of attributes which are to be returned for each user.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

If the user exists then an 'User' object containing all the retAttrs of the user is returned otherwise NoSuchUserException exception is thrown.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

NoSuchUserException - if the user does not exist.

UserLookupException - if the user lookup operation fails.

getDetails

User getDetails(java.lang.String attributeName,
                java.lang.Object attributeValue,
                java.util.Set retAttrs)
                throws AccessDeniedException,
                       NoSuchUserException,
                       UserLookupException,
                       SearchKeyNotUniqueException

Returns the profile details of the specified user.

Parameters:

attributeName - - The attribute name for the search criteria.

attributeValue - - The attribute value for the search criteria.

retAttrs - The list of attributes which are to be returned for each user.

Returns:

If the user exists then an 'User' object containing all the retAttrs of the user is returned otherwise NoSuchUserException exception is thrown.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

NoSuchUserException - if the user does not exist.

UserLookupException - if the user lookup operation fails.

SearchKeyNotUniqueException - if there is more than one user of the search criteria.

search

java.util.List search(SearchCriteria criteria,
                      java.util.Set retAttrs,
                      java.util.HashMap configParams)
                      throws AccessDeniedException,
                             UserSearchException

Searches for users matching the specified SearchCriteria.

Parameters:

criteria - The search criteria based on which entries will be retrieved from the backend. The SearchCriteria Operators supported are AND, OR, NOT, GREATER_THAN, GREATER_EQUAL, LESS_THAN, LESS_EQUAL, EQUAL and NOT_EQUAL. For additional comparisons like contains the SearchCriteria Operator will be EQUAL with value to be searched will be '*<value>*'

retAttrs - The list of attributes which are to be returned for each user.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched. These parameters are mandatory.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to 'User Login' by default.

The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING. This parameter is optional and is set to SortOrder.ASCENDING by default.

Returns:

the list of users which matched the search criteria. This list is filtered based on the attribute and entity permissions of the logged-in User.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

UserSearchException - if the user search operation fails.

enable

UserManagerResult enable(java.lang.String userID,
                         boolean isUserLogin)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserEnableException,
                                NoSuchUserException

Enables the user account.

Parameters:

userID - The id of the user to be enabled. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the entity id of the enabled user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserEnableException - if the orchestration fails for enable operation.

NoSuchUserException - if the user with given userID is not found.

enable

UserManagerResult enable(java.lang.String attributeName,
                         java.lang.Object attributeValue)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserEnableException,
                                NoSuchUserException,
                                SearchKeyNotUniqueException

Enables the user account matching the search criteria.

Parameters:

attributeName - - The attribute name for the search criteria.

attributeValue - - The attribute value for the search criteria.

Returns:

UserManagerResult containing the entity id of the enabled user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserEnableException - if the orchestration fails for enable operation.

NoSuchUserException - if the user matching the search criteria is not found.

SearchKeyNotUniqueException - if there is more than one user of the search criteria.

enable

UserManagerResult enable(java.util.ArrayList userIDs,
                         boolean isUserLogin)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserEnableException,
                                NoSuchUserException

Bulk enable operation. Enables accounts of all specified users.

Parameters:

userIDs - The ids of the user to be enabled. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the list of success and failure results. Each failure result has a reason for failure associated with it.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserEnableException - if the orchestration fails for enable operation.

NoSuchUserException - if the user with given userID is not found.

disable

UserManagerResult disable(java.lang.String userID,
                          boolean isUserLogin)
                          throws ValidationFailedException,
                                 AccessDeniedException,
                                 UserDisableException,
                                 NoSuchUserException

Disables the user account.

Parameters:

userID - The id of the user to be disabled. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the entity id of the disabled user.

Throws:

ValidationFailedException - is thrown if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserDisableException - if the orchestration fails for disable operation.

NoSuchUserException - if the user with given userID is not found.

disable

UserManagerResult disable(java.lang.String attributeName,
                          java.lang.Object attributeValue)
                          throws ValidationFailedException,
                                 AccessDeniedException,
                                 UserDisableException,
                                 NoSuchUserException,
                                 SearchKeyNotUniqueException

Disables the user account matching the search criteria.

Parameters:

attributeName - - The attribute name for the search criteria.

attributeValue - - The attribute value for the search criteria.

Returns:

UserManagerResult containing the entity id of the disabled user.

Throws:

ValidationFailedException - is thrown if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserDisableException - if the orchestration fails for disable operation.

NoSuchUserException - if the user matching the search criteria is not found.

SearchKeyNotUniqueException - if there is more than one user of the search criteria.

disable

UserManagerResult disable(java.util.ArrayList userIDs,
                          boolean isUserLogin)
                          throws ValidationFailedException,
                                 AccessDeniedException,
                                 UserDisableException,
                                 NoSuchUserException

Bulk disable operation. Disables accounts of all specified users.

Parameters:

userIDs - The ids of the user to be disabled. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the list of success and failure results. Each failure result has a reason for failure associated with it.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserDisableException - if the orchestration fails for disable operation.

NoSuchUserException - if the user with given userID is not found.

lock

UserManagerResult lock(java.lang.String userID,
                       boolean manualFlag,
                       boolean isUserLogin)
                       throws ValidationFailedException,
                              AccessDeniedException,
                              UserLockException,
                              NoSuchUserException

Locks the OIM user account, provided the user has an OIM account provisioned. Else, an exception will be thrown.

Parameters:

userID - The id of the user to be locked. The isUserLogin flag will decide what does userID contains.

manualFlag - The flag is true then lock is manual otherwise system lock.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the entity id of the locked user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserLockException - if the orchestration fails for lock operation.

NoSuchUserException - if the user with given userID is not found.

lock

UserManagerResult lock(java.lang.String attributeName,
                       java.lang.Object attributeValue,
                       boolean manualFlag)
                       throws ValidationFailedException,
                              AccessDeniedException,
                              UserLockException,
                              NoSuchUserException,
                              SearchKeyNotUniqueException

Locks the OIM user account matching the search criteria, provided the user has an OIM account provisioned. Else, an exception will be thrown.

Parameters:

attributeName - - The attribute name for the search criteria.

attributeValue - - The attribute value for the search criteria.

manualFlag - The flag is true then lock is manual otherwise system lock.

Returns:

UserManagerResult containing the entity id of the locked user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserLockException - if the orchestration fails for lock operation.

NoSuchUserException - if the user with given userID is not found.

SearchKeyNotUniqueException - if there is more than one user of the search criteria.

lock

UserManagerResult lock(java.util.ArrayList userIDs,
                       boolean manualFlag,
                       boolean isUserLogin)
                       throws ValidationFailedException,
                              AccessDeniedException,
                              UserLockException,
                              NoSuchUserException

Bulk lock operation. If any of the users do not have an OIM account provisioned, then no user account will be locked and an appropriate exception will be thrown.

Parameters:

userIDs - The ids of the user to be locked. The isUserLogin flag will decide what does userID contains.

manualFlag - The flag is true then lock is manual otherwise system lock.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the list of success and failure results. Each failure result has a reason for failure associated with it.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserLockException - if the orchestration fails for lock operation.

NoSuchUserException - if the user with given userID is not found.

unlock

UserManagerResult unlock(java.lang.String userID,
                         boolean isUserLogin)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserUnlockException,
                                NoSuchUserException

Unlocks the OIM user account, provided the user has an OIM account, and it is locked. An exception is thrown if the user doesn't have an OIM account.

Parameters:

userID - The id of the user to be unlocked. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the entity id of the unlocked user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserUnlockException - if the orchestration fails for unlock operation.

NoSuchUserException - if the user with given userID is not found.

unlock

UserManagerResult unlock(java.lang.String attributeName,
                         java.lang.Object attributeValue)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserUnlockException,
                                NoSuchUserException,
                                SearchKeyNotUniqueException

Unlocks the OIM user account matching the search criteria, provided the user has an OIM account, and it is locked. An exception is thrown if the user doesn't have an OIM account.

Parameters:

attributeName - - The attribute name for the search criteria.

attributeValue - - The attribute value for the search criteria.

Returns:

UserManagerResult containing the entity id of the unlocked user.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserUnlockException - if the orchestration fails for unlock operation.

NoSuchUserException - if the user matching the search criteria is not found.

SearchKeyNotUniqueException - if there is more than one user of the search criteria.

unlock

UserManagerResult unlock(java.util.ArrayList userIDs,
                         boolean isUserLogin)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                UserUnlockException,
                                NoSuchUserException

Bulk unlock operation. If any of the users do not have an OIM account provisioned, then no users' accounts will be unlocked and an appropriate exception will be thrown.

Parameters:

userIDs - The ids of the user to be unlocked. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

UserManagerResult containing the list of success and failure results. Each failure result has a reason for failure associated with it.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

UserUnlockException - if the orchestration fails for unlock operation.

NoSuchUserException - if the user with given userID is not found.

getCurrentProxies

java.util.List getCurrentProxies(java.lang.String userID,
                                 boolean isUserLogin)
                                 throws AccessDeniedException,
                                        NoSuchUserException

Returns the current proxy details of the specified user

Parameters:

userID - The ID of the user whose current proxies are required. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

List of proxy details for all current proxies associated with the specified user

Throws:

AccessDeniedException - If the logged-in user does not have the required authorization to perform this operation.

NoSuchUserException - If the user with given userID is not found.

getPastProxies

java.util.List getPastProxies(java.lang.String userID,
                              boolean isUserLogin)
                              throws AccessDeniedException

Returns the past proxy details of the specified user

Parameters:

userID - The id of the user whose past proxies are required. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

List of proxy details for all past proxies associated with the specified user

Throws:

AccessDeniedException - If the loggedUser does not have the required authorization to perform this operation.

changePassword

void changePassword(java.lang.String userID,
                    char[] password,
                    boolean isUserLogin,
                    java.util.Locale locale,
                    boolean setPasswordResetFlag)
                    throws NoSuchUserException,
                           AccessDeniedException,
                           UserManagerException

Changes the user's password. This signature API is called in OAAM integrated env.

Parameters:

userID - The ID of the user whose password is to be changed. The isUserLogin flag will decide what does userID contains.

password - New password

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

locale - If not null, this locale is used to throw translated exceptions (if any)

setPasswordResetFlag - To identify whether the password reset flag should be reset or not. In case of OAAM scenario, this flag value should be false which should indicate not be reset the 'change password at next logon' flag in the database.

Throws:

NoSuchUserException - If user with given userID does not exist.

AccessDeniedException - If logged-in user does not have permission to change the password of this user.

UserManagerException - If there is an error while changing the user's password

changePassword

void changePassword(java.lang.String userID,
                    char[] password,
                    boolean isUserLogin)
                    throws NoSuchUserException,
                           AccessDeniedException,
                           UserManagerException

Changes the user's password.

Parameters:

userID - The id of the user whose password is to be changed. The isUserLogin flag will decide what does userID contains.

password - New password

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Throws:

NoSuchUserException - If user with given userID does not exist.

AccessDeniedException - If logged-in user does not have permission to change the password of this user.

UserManagerException - If there is an error while changing the user's password

changePassword

void changePassword(java.lang.String attributeName,
                    java.lang.Object attributeValue,
                    char[] password)
                    throws NoSuchUserException,
                           AccessDeniedException,
                           UserManagerException,
                           SearchKeyNotUniqueException

Changes the user's password.

Parameters:

attributeName - The attribute name for the search criteria to identify the user.

attributeValue - The attribute value for the search criteria to identify the user.

password - New password

Throws:

NoSuchUserException - If user with the given criteria does not exist.

AccessDeniedException - If logged-in user does not have permission to change the password of this user.

UserManagerException - If there is an error while changing password

SearchKeyNotUniqueException - If there are more than one users found with the given search criteria.

getAllProxies

java.util.List getAllProxies(java.lang.String userID,
                             boolean isUserLogin)
                             throws AccessDeniedException

Gets a list of the all the proxy for the given user

Parameters:

userID - The ID of the user whose proxies are required. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

List of proxy details for all proxies associated with the specified user

Throws:

AccessDeniedException - If the logged-in user does not have the required authorization to perform this operation.

addProxyForUser

long addProxyForUser(java.lang.String userID,
                     long proxyUserKey,
                     java.util.Date startDate,
                     java.util.Date endDate,
                     boolean isUserLogin)
                     throws NoSuchUserException,
                            RecursiveProxyException,
                            UserManagerException,
                            AccessDeniedException

Adds/Sets proxy for user in OIM and BPEL.

Parameters:

userID - The id of the user for which proxy is to be added. The isUserLogin flag will decide if userID contains the user login or the user key

proxyUserKey - key of the user to be proxied.

startDate - start date for the proxy.

endDate - end date of the proxy.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Returns:

the proxy id in the table.

Throws:

NoSuchUserException - If user with given userID does not exist.

RecursiveProxyException - if there is a recursive proxy.

UserManagerException - If add proxy operation fails due some other reason.

AccessDeniedException - If the logged-in user does not have the required authorization to perform this operation

updateProxyForUser

void updateProxyForUser(long pxdKey,
                        java.util.Map attribute)
                        throws NoSuchUserException,
                               RecursiveProxyException,
                               UserManagerException,
                               AccessDeniedException

Updates the proxy with key pxdKey Only proxy user, start date and/or end date can be modified for the given proxy. Original user cannot be modifed for a proxy. The values to be changed needs to be passed in the map as name value pairs.

Parameters:

pxdKey - key of the proxy whose details is to be updated.

attribute - an attribute map of the fields to update:

• pxyoriginaluserkey - to identify the original user. This field cannot be updated.
• proxyuserkey - the new proxy user
• proxystartdate - start date when the proxy takes effect
• proxyenddate - end date when the proxy ends

Throws:

NoSuchUserException - If user with given userID does not exist.

RecursiveProxyException - If there is a recursive proxy.

AccessDeniedException - If the logged-in user does not have the required authorization to perform this operation

UserManagerException - If update proxy operation fails due some other reason.

removeAllProxiesForUser

void removeAllProxiesForUser(java.lang.String userID,
                             boolean isUserLogin)
                             throws NoSuchUserException,
                                    UserManagerException,
                                    AccessDeniedException

Removes all proxies for user.

Parameters:

userID - The ID of the user whose proxies are to be removed. The isUserLogin flag will decide what does userID contains.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Throws:

NoSuchUserException - If user with given userID does not exist.

AccessDeniedException - If the logged-in user does not have the required authorization to perform this operation

UserManagerException - If update proxy operation fails due some other reason.

removeProxy

void removeProxy(java.lang.String userID,
                 long proxyKey,
                 java.util.Map attrMap,
                 boolean isUserLogin)
                 throws NoSuchUserException,
                        UserManagerException,
                        AccessDeniedException

Deprecated. Please use removeProxy(String userID, long proxyKey, boolean isUserLogin) instead

Parameters:

userID - The ID of the user whose proxy is to be removed. The isUserLogin flag will decide what does userID contains.

proxyKey - The key of the proxy to be removed.

attrMap - [Optional] The Map of attributes containing proxy details

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Throws:

NoSuchUserException - If user with given userID does not exist.

AccessDeniedException - If the logged-in user does not have the required authorization to perform this operation

UserManagerException - If remove proxy operation fails due some other reason.

See Also:

Removes a single proxy (identified by key proxyKey) for the given user (identified by userID).

removeProxy

void removeProxy(java.lang.String userID,
                 long proxyKey,
                 boolean isUserLogin)
                 throws NoSuchUserException,
                        UserManagerException,
                        AccessDeniedException

Removes a single proxy (identified by key proxyKey) for the given user (identified by userID).

Parameters:

userID - The ID of the user whose proxy is to be removed. The isUserLogin flag will decide what does userID contains.

proxyKey - The key of the proxy to be removed.

isUserLogin - Set to true if the userID contains user login and false if the userID contains user key.

Throws:

NoSuchUserException - If user with given userID does not exist.

AccessDeniedException - If the logged-in user does not have the required authorization to perform this operation

UserManagerException - If remove proxy operation fails due some other reason.

generateUserName

java.lang.String generateUserName(java.util.Map attrMap)
                                  throws UserNameGenerationException,
                                         UserManagerException

Suggest a username based on OIM's default username policy.

Parameters:

attrMap - Map contains user attributes required to generate username.

Returns:

The generated username based on the default policy and user attributes

Throws:

UserNameGenerationException - If username generation operation fails due some reason.

UserManagerException - If the operation fails due some other reason.

generateUserName

java.lang.String generateUserName(java.lang.String policyID,
                                  java.util.Map attrMap)
                                  throws UserNameGenerationException,
                                         UserManagerException

Suggest a username based on the given username policy.

Parameters:

policyID - The ID (class name of policy) of the policy that will be used to generate username.

attrMap - Map contains user attributes required to generate username.

Returns:

The generated username based on the given policy and user attributes

Throws:

UserNameGenerationException - If username generation operation fails due some reason.

UserManagerException - If the operation fails due some other reason.

isUserNameValid

boolean isUserNameValid(java.lang.String userName,
                        java.util.Map attrMap)
                        throws UserManagerException

Check the validity of the given username based on default policy.

Parameters:

userName - The username that need to be validated.

attrMap - Map contains user attributes required to generate username.

Returns:

True or false based on the validity of the user name as per the default policy

Throws:

UserManagerException - If the operation fails due some other reason.

isUserNameValid

boolean isUserNameValid(java.lang.String userName,
                        java.lang.String policyID,
                        java.util.Map attrMap)
                        throws UserManagerException

Check the validity of the given username based on given policy.

Parameters:

userName - The username that needs to be validated.

policyID - The ID (class name of policy) of the policy that will be used to validate the username.

attrMap - Map contains user attributes required to generate username.

Returns:

True or false based on the validity of the user name as per the given policy

Throws:

UserManagerException - If the operation fails due some other reason.

getAllUserNamePolicies

java.util.List getAllUserNamePolicies(java.util.Locale locale)
                                      throws UserManagerException

Gives the details of all the username policies configured in OIM.

Parameters:

locale - The locale in which policy discription is needed.

Returns:

List containing all the policy details mentioned in a Map as:

• policy_id - the ID of the policy
• policy_name- the name of the policy
• policy_description - the description of the policy

Throws:

UserManagerException - If the operation fails due some other reason.

getPolicyDescription

java.lang.String getPolicyDescription(java.lang.String policyID,
                                      java.util.Locale locale)
                                      throws UserManagerException

Gives the details of the username policy configured in OIM with the given ID

Parameters:

policyID - The ID (class name of policy) of the policy for which description is required.

locale - The locale in which policy discription needed.

Returns:

The description of the policy with the given Id in the specified locale.

Throws:

UserManagerException - If the operation fails due some other reason.

Skip navigation links