Thor.API.Operations

Interface tcUserOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcUserOperationsIntf
extends tcUtilityOperationsIntf

Method Summary

Modifier and Type	Method and Description
boolean	canResourceBeProvisioned(long userKey, long objectKey) Deprecated.
void	changeCredForSelf(java.lang.String psOldPwd, java.lang.String psNewPwd, java.lang.String psConfirmPwd) Deprecated. use AuthenticatedSelfService#changePassword(char[] oldPwd, char[] newPwd, char[] confirmPwd) instead
void	changeFromServiceAccount(long plObjectInstanceForUserKey) Changes a service account to a regular account.
void	changePasswordforSelf(java.lang.String psOldPwd, java.lang.String psNewPwd, java.lang.String psConfirmPwd) Deprecated. use AuthenticatedSelfService#changePassword(char[] oldPwd, char[] newPwd, char[] confirmPwd) instead
void	changeToServiceAccount(long plObjectInstanceForUserKey) Changes a regular account to a service account.
boolean	compareChallengeValuesForSelf(java.util.Map phQuestionAnswer) Compares the questions/answers entered by the user against the ones stored in the database
long	createUser(java.util.Map phMapping) Deprecated. use UserManager#create(User user) instead
void	deleteProxies(long userKey) Deprecated. use UserManager#removeAllProxiesForUser(String userID,boolean isUserLogin) instead
void	deleteProxy(long userKey, long proxyKey) Deprecated. use UserManager#removeProxy(String userID,String proxyID,boolean isUserLogin) instead
void	deleteUser(long plUserKey) Deprecated. use UserManager#delete(String userID, boolean isUserLogin) instead
void	deleteUsers(long[] paUserKeys) Deprecated. use UserManager#delete(ArrayList userIDs, boolean isUserLogin) instead
void	disableAppForUser(long plUserKey, long plObjectInstanceForUserKey) Deprecated.
void	disableAppsForUser(long plUserKey, long[] paObjectInstancesForUserKey) Deprecated.
void	disableUser(long plUserKey) Deprecated. use UserManager#disable(String userID, boolean isUserLogin) instead
void	disableUsers(long[] paUserKeys) Deprecated. use UserManager#disable(ArrayList userIDs, boolean isUserLogin) instead
void	enableAppForUser(long plUserKey, long plObjectInstanceForUserKey) Deprecated.
void	enableAppsForUser(long plUserKey, long[] paObjectInstancesForUserKey) Deprecated.
void	enableUser(long plUserKey) Deprecated. use UserManager#enable(String userID, boolean isUserLogin) instead
void	enableUsers(long[] paUserKeys) Deprecated. use UserManager#enable(ArrayList userIDs, boolean isUserLogin) instead
Thor.API.tcResultSet	findAllUsers(java.util.Map phAttributeList) Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead
Thor.API.tcResultSet	findAllUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead
Thor.API.tcResultSet	findUsers(java.util.Map phAttributeList) Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead
Thor.API.tcResultSet	findUsers(java.util.Map phAttributeList, java.lang.String permission) Returns a list of users that match the provided attribute list.
Thor.API.tcResultSet	findUsers(java.util.Map phAttributeList, java.lang.String permission, java.lang.String[] status) Returns a list of users that match the provided attribute list and status.
Thor.API.tcResultSet	findUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead
Thor.API.tcResultSet	findUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead
int	findUsersFilteredCount(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Returns a count of users that match the provided attribute list.
Thor.API.tcResultSet	getActiveUsers(java.util.Map attributes) Returns a list of active users in the system.
Thor.API.tcResultSet	getAvailableObjects(long[] palUserKeys) Returns a list of resource objects that can be provisioned to a specified list of users
Thor.API.tcResultSet	getAvailableObjects(long[] palUserKeys, java.util.Map attributes) Returns a list of resource objects that can be provisioned to a specified list of users
Thor.API.tcResultSet	getAvailableObjectsForSelf() This object returns a resultset of the objects available for the current login user.
Thor.API.tcResultSet	getAvailableObjectsForSelf(java.util.Map attributes) This object returns a resultset of the objects available for the current login user.
Thor.API.tcResultSet	getAvailableObjectsForUser(long[] palUserKeys) This object returns a resultset of the objects available for the given array of users.
Thor.API.tcResultSet	getChallengeValuesForSelf() Deprecated. use AuthenticatedSelfService#getChallengeValuesForSelf() instead
Thor.API.tcResultSet	getChallengeValuesForUser(long userKey) Deprecated. use oracle.iam.identity.usermgmt.api.UserManager#getUserChallengeValues() instead
Thor.API.tcResultSet	getEncodedValue(java.lang.String strDecodeVal, java.lang.String strFieldName) This object returns a resultset of the object available for the given encoded value.
Thor.API.tcResultSet	getGroups(long plUserKey) Gets a list of all the groups the user is a member of.
Thor.API.tcResultSet	getGroups(java.util.Map searchCriteria) Gets a list of all the groups the user is a member of.
Thor.API.tcResultSet	getMenuList(long plUserKey) Deprecated.
Thor.API.tcResultSet	getMenuListForSelf() Deprecated.
Thor.API.tcResultSet	getObjectAuthorizationPermissions(long plUserKey) Deprecated.
Thor.API.tcResultSet	getObjects(long plUserKey) Deprecated.
Thor.API.tcResultSet	getObjectsByType(long plUserKey, java.lang.String psObjectType) Gets a list of all the objects of the specified type that have been provisioned for a user.
Thor.API.tcResultSet	getObjectsByTypeStatus(long plUserKey, java.lang.String psObjectType, java.lang.String psStatus) Deprecated.
Thor.API.tcResultSet	getProxiedUser(long userKey) This method will return the detail information of only the current proxied user by the specified user.
Thor.API.tcResultSet	getProxyDetails(long userKey) This method will return the detail information of the proxy assigned to the specified user.
Thor.API.tcResultSet	getProxyList(java.util.Map attributeMap, java.lang.String[] fieldList) Method that returns a resultset of the proxy users for the user whose key is passed in.
Thor.API.tcResultSet	getSelfProfile() Deprecated. use AuthenticatedSelfService#getProfileDetails(Set retAttrs) instead
Thor.API.tcResultSet	getSelfProfileFiltered(java.lang.String[] pasFieldList) Deprecated. use AuthenticatedSelfService#getProfileDetails(Set retAttrs) instead
Thor.API.tcResultSet	getUnAssignedGroups(long plUserKey) Gets a list of all the groups the user is not a member of.
java.lang.String[]	getUserFromObjectInfo(java.lang.String psObjName, java.lang.String psColumnName, java.lang.String psColumnValue) Locates User Record(s) in OIM based on data for a provisioned object.
boolean	isChallengeQuestionsSetForSelf() Check if challenge questions are set for the current user.
void	lockSelf(java.lang.String username) Deprecated. use UserManager#lock(String userID,boolean isUserLogin) instead
void	moveServiceAccount(long plObjectInstanceForUserKey, long plTargetUserKey) Moves the service account from its current owner to a new owner.
long	provisionObject(long plUserKey, long plObjectKey) Deprecated.
long	provisionObject(long plUserKey, long plObjectKey, boolean pbServiceAccount) Deprecated.
ResourceData	provisionResource(long plUserKey, long plObjectKey) Deprecated.
ResourceData	provisionResource(long plUserKey, long plObjectKey, boolean pbServiceAccount) Deprecated.
void	relinkAccount(long plObjectInstanceForUserKey, long plTargetUserKey, boolean updateParentDataFlag)
void	revokeObject(long plUserKey, long plObjectInstanceForUserKey) Deprecated.
void	revokeObjects(long plUserKey, long[] paObjectInstancesForUserKey) Deprecated.
void	setChallengeValuesForSelf(java.util.Map phQuestionAnswer) Deprecated. use AuthenticatedSelfService#setChallengeValues(Map quesAnsMap instead
long	setProxyForUser(long userKey, long proxyUserKey, java.util.Date startDate, java.util.Date endDate) Deprecated. use UserManager#addProxyForUser(String userID,String proxyUserID,Date startDate, Date endDate,boolean isUserLogin) instead
void	unlockUsers(long[] paUserKeys) Deprecated. use UserManager#unlock(ArrayList userIDs, boolean isUserLogin) instead
void	updateProxyForUser(long pxdKey, java.util.Map attribute) Deprecated. use UserManager#updateProxyForUser(String proxyID,final Map attribute ) instead
void	updateUser(Thor.API.tcResultSet poUserResultSet, java.util.Map phAttributeList) Deprecated. use UserManager#modify(String attributeName, Object attributeValue,User user) instead
void	updateUser(Thor.API.tcResultSet poUserResultSet, java.util.Map phAttributeList, boolean changePassword) Update a user in Xellerate.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

createUser

@Deprecated
long createUser(java.util.Map phMapping)
                     throws tcAPIException,
                            tcDuplicateUserException,
                            tcAttributeMissingException,
                            tcInvalidAttributeException,
                            tcAPIException

Deprecated. use UserManager#create(User user) instead

Creates a user in OIM with the specified attributes.

Parameters:

phMapping - An array of mapping objects, each representing an attribute to set in the user. Please note that if the same attribute is specified twice in the array, the later instance found will be used.

Returns:

The User Key of the newly created user.

Throws:

tcAPIException

tcDuplicateUserException

tcAttributeMissingException

tcInvalidAttributeException

deleteUser

@Deprecated
void deleteUser(long plUserKey)
                     throws tcAPIException,
                            tcUserNotFoundException,
                            tcAPIException

Deprecated. use UserManager#delete(String userID, boolean isUserLogin) instead

Delete a user in OIM.

Parameters:

plUserKey - The key of the user to delete.

Throws:

tcAPIException

tcUserNotFoundException

deleteUsers

@Deprecated
void deleteUsers(long[] paUserKeys)
                      throws tcAPIException,
                             tcUserNotFoundException,
                             tcBulkException,
                             tcAPIException

Deprecated. use UserManager#delete(ArrayList userIDs, boolean isUserLogin) instead

Deletes users in OIM.

Parameters:

paUserKeys - The array key of the users to delete.

Throws:

tcAPIException

tcUserNotFoundException

tcBulkException

disableUser

@Deprecated
void disableUser(long plUserKey)
                      throws tcAPIException,
                             tcUserNotFoundException,
                             tcAPIException

Deprecated. use UserManager#disable(String userID, boolean isUserLogin) instead

Disable a user in OIM.

Parameters:

plUserKey - The key of the user to disable.

Throws:

tcAPIException

tcUserNotFoundException

disableUsers

@Deprecated
void disableUsers(long[] paUserKeys)
                       throws tcAPIException,
                              tcUserNotFoundException,
                              tcBulkException,
                              tcAPIException

Deprecated. use UserManager#disable(ArrayList userIDs, boolean isUserLogin) instead

Disable users in OIM.

Parameters:

paUserKeys - The key array of the users to disable.

Throws:

tcAPIException

tcUserNotFoundException

tcBulkException

enableUser

@Deprecated
void enableUser(long plUserKey)
                     throws tcAPIException,
                            tcUserNotFoundException,
                            tcAPIException

Deprecated. use UserManager#enable(String userID, boolean isUserLogin) instead

Enable a user in OIM.

Parameters:

plUserKey - The key of the user to enable.

Throws:

tcAPIException

tcUserNotFoundException

enableUsers

@Deprecated
void enableUsers(long[] paUserKeys)
                      throws tcAPIException,
                             tcUserNotFoundException,
                             tcBulkException,
                             tcAPIException

Deprecated. use UserManager#enable(ArrayList userIDs, boolean isUserLogin) instead

Enable users in OIM.

Parameters:

paUserKeys - The key array of users to enable.

Throws:

tcAPIException

tcUserNotFoundException

tcBulkException

changePasswordforSelf

@Deprecated
void changePasswordforSelf(java.lang.String psOldPwd,
                                       java.lang.String psNewPwd,
                                       java.lang.String psConfirmPwd)
                                throws tcAPIException,
                                       tcPasswordIncorrectException,
                                       tcPasswordMismatchException,
                                       tcPasswordPolicyException,
                                       tcAPIException

Deprecated. use AuthenticatedSelfService#changePassword(char[] oldPwd, char[] newPwd, char[] confirmPwd) instead

Changes the password of the current user. The following condition should be validated before changing the user's password:

• psNewPwd and psConfirmPwd should be the same
• psOldPwd should match the current password

Parameters:

psOldPwd - is current user's password

psNewPwd - is the new password to assign to the user

psConfirmPwd - is the confirmed new password. This should match the psNewPwd

Throws:

tcAPIException

tcPasswordIncorrectException - error raise in case password is incorrect

tcPasswordMismatchException - error raise in case password does not match

tcPasswordPolicyException - error if policy attached with passowrd fail.

changeCredForSelf

@Deprecated
void changeCredForSelf(java.lang.String psOldPwd,
                                   java.lang.String psNewPwd,
                                   java.lang.String psConfirmPwd)
                            throws tcAPIException,
                                   tcPasswordIncorrectException,
                                   tcPasswordMismatchException,
                                   tcPasswordPolicyException,
                                   tcAPIException

Deprecated. use AuthenticatedSelfService#changePassword(char[] oldPwd, char[] newPwd, char[] confirmPwd) instead

Changes the password of the current user. The following condition should be validated before changing the user's password:

• psNewPwd and psConfirmPwd should be the same
• psOldPwd should match the current password

Parameters:

psOldPwd - is current user's password

psNewPwd - is the new password to assign to the user

psConfirmPwd - is the confirmed new password. This should match the psNewPwd

Throws:

tcAPIException

tcPasswordIncorrectException

tcPasswordMismatchException

tcPasswordPolicyException

getAvailableObjectsForSelf

Thor.API.tcResultSet getAvailableObjectsForSelf()
                                         throws tcAPIException,
                                                tcAPIException

This object returns a resultset of the objects available for the current login user.

Returns:

tcResultSet of the available objects for the current user

Throws:

tcAPIException

com.thortech.xl.dataaccess.tcDataSetException

getAvailableObjectsForSelf

Thor.API.tcResultSet getAvailableObjectsForSelf(java.util.Map attributes)
                                         throws tcAPIException,
                                                tcAPIException

This object returns a resultset of the objects available for the current login user.

Parameters:

attributes - is the attribute map to filter the result set

Returns:

tcResultSet of the available objects for the current user

Throws:

tcAPIException

com.thortech.xl.dataaccess.tcDataSetException

getAvailableObjectsForUser

Thor.API.tcResultSet getAvailableObjectsForUser(long[] palUserKeys)
                                         throws tcUserNotFoundException,
                                                tcAPIException,
                                                tcAPIException

This object returns a resultset of the objects available for the given array of users.

Parameters:

palUserKeys - an array of user keys to get available objects. If a null or empty array is passed, this function will raise the tcAPIException

Returns:

tcResultSet of the available objects for the current user

Throws:

tcUserNotFoundException

tcAPIException

getAvailableObjects

Thor.API.tcResultSet getAvailableObjects(long[] palUserKeys)
                                  throws tcUserNotFoundException,
                                         tcAPIException,
                                         tcAPIException

Returns a list of resource objects that can be provisioned to a specified list of users

Parameters:

palUserKeys - an array of user keys

Returns:

a tcResultSet that contains the available objects for the given list of users

Throws:

tcUserNotFoundException

tcAPIException

getAvailableObjects

Thor.API.tcResultSet getAvailableObjects(long[] palUserKeys,
                                         java.util.Map attributes)
                                  throws tcUserNotFoundException,
                                         tcAPIException,
                                         tcAPIException

Returns a list of resource objects that can be provisioned to a specified list of users

Parameters:

palUserKeys - an array of user keys

attributes - is the attribute map to filter the result set

Returns:

a tcResultSet that contains the available objects for the given list of users

Throws:

tcUserNotFoundException

tcAPIException

getSelfProfile

@Deprecated
Thor.API.tcResultSet getSelfProfile()
                                         throws tcAPIException,
                                                tcAPIException

Deprecated. use AuthenticatedSelfService#getProfileDetails(Set retAttrs) instead

Returns the current logon user's profile.

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

• Organizations.Key
• Organizations.Organization Name
• Users.AD Reference
• Users.Creation Date
• Users.Deprovisioned Date
• Users.Deprovisioning Date
• Users.Disable User
• Users.End Date
• Users.First Name
• Users.Identity
• Users.Key
• Users.Last Name
• Users.Manager Key
• Users.Manager Login
• Users.Manager First Name
• Users.Manager Last Name
• Users.Middle Name
• Users.Note
• Users.Provisioned Date
• Users.Provisioning Date
• Users.Role
• Users.Row Version
• Users.Start Date
• Users.Status
• Users.Update Date
• Users.Updated By
• Users.User ID
• Users.Xellerate Type
• Users.Lock User
• Users.Email

Throws:

tcAPIException

getSelfProfileFiltered

@Deprecated
Thor.API.tcResultSet getSelfProfileFiltered(java.lang.String[] pasFieldList)
                                                 throws tcAPIException,
                                                        tcAPIException

Deprecated. use AuthenticatedSelfService#getProfileDetails(Set retAttrs) instead

Returns the current logon user's profile. The fields returned in the tcResultSet can be specified.

Parameters:

phAttributeList - attribute-value pairs with each entry containing criteria to find users

pasFieldList - The list of fields that is to be returned in the tcResultSet.

Returns:

A tcResultSet that contains the fields specified in pasFieldList. Returned tcResultSet always contains

• Users.Key
• Users.Row Version

Throws:

com.thortech.xl.dataaccess.tcDataSetException

tcAPIException

findUsers

@Deprecated
Thor.API.tcResultSet findUsers(java.util.Map phAttributeList)
                                    throws tcAPIException,
                                           tcAPIException

Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead

Returns a list of users that match the provided attribute list.

Parameters:

phAttributeList - A Map of attribute-value pairs with each entry containing criteria to find users. The Map key should contain a String representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map values can include wild cards(%).

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

• Organizations.Key
• Organizations.Organization Name
• Users.AD Reference
• Users.Creation Date
• Users.Deprovisioned Date
• Users.Deprovisioning Date
• Users.Disable User
• Users.End Date
• Users.First Name
• Users.Identity
• Users.Key
• Users.Last Name
• Users.Manager Key
• Users.Manager Login
• Users.Manager First Name
• Users.Manager Last Name
• Users.Middle Name
• Users.Note
• Users.Provisioned Date
• Users.Provisioning Date
• Users.Role
• Users.Row Version
• Users.Start Date
• Users.Status
• Users.Update Date
• Users.Updated By
• Users.User ID
• Users.Xellerate Type
• Users.Lock User
• Users.Email

Throws:

tcAPIException

findUsers

Thor.API.tcResultSet findUsers(java.util.Map phAttributeList,
                               java.lang.String permission)
                        throws tcAPIException,
                               tcAPIException

Returns a list of users that match the provided attribute list.

Parameters:

phAttributeList - A Map of attribute-value pairs with each entry containing criteria to find users. The Map key should contain a String representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map values can include wild cards(%).

permission - - the value of permission could be Write, Read, or Delete. It return groups based on the permission.

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

• Organizations.Key
• Organizations.Organization Name
• Users.AD Reference
• Users.Creation Date
• Users.Deprovisioned Date
• Users.Deprovisioning Date
• Users.Disable User
• Users.End Date
• Users.First Name
• Users.Identity
• Users.Key
• Users.Last Name
• Users.Manager Key
• Users.Manager Login
• Users.Manager First Name
• Users.Manager Last Name
• Users.Middle Name
• Users.Note
• Users.Provisioned Date
• Users.Provisioning Date
• Users.Role
• Users.Row Version
• Users.Start Date
• Users.Status
• Users.Update Date
• Users.Updated By
• Users.User ID
• Users.Xellerate Type
• Users.Lock User
• Users.Email

Throws:

tcAPIException

findUsers

Thor.API.tcResultSet findUsers(java.util.Map phAttributeList,
                               java.lang.String permission,
                               java.lang.String[] status)
                        throws tcAPIException,
                               tcAPIException

Returns a list of users that match the provided attribute list and status.

Parameters:

phAttributeList - attribute-value pairs with each entry containing criteria to find users

permission - - the value of permission could be Write, Read, or Delete. It return groups based on the permission.

status - an array of user statuses to filter

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

• Organizations.Key
• Organizations.Organization Name
• Users.AD Reference
• Users.Creation Date
• Users.Deprovisioned Date
• Users.Deprovisioning Date
• Users.Disable User
• Users.End Date
• Users.First Name
• Users.Identity
• Users.Key
• Users.Last Name
• Users.Manager Key
• Users.Manager Login
• Users.Manager First Name
• Users.Manager Last Name
• Users.Middle Name
• Users.Note
• Users.Provisioned Date
• Users.Provisioning Date
• Users.Role
• Users.Row Version
• Users.Start Date
• Users.Status
• Users.Update Date
• Users.Updated By
• Users.User ID
• Users.Xellerate Type
• Users.Lock User
• Users.Email

Throws:

tcAPIException

findUsersFiltered

@Deprecated
Thor.API.tcResultSet findUsersFiltered(java.util.Map phAttributeList,
                                                   java.lang.String[] pasFieldList,
                                                   int startRow,
                                                   int pageSize,
                                                   java.lang.String[] order,
                                                   boolean ascendingOrder)
                                            throws tcAPIException,
                                                   tcAPIException

Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead

Returns a list of users that match the provided attribute list. The fields returned in the tcResultSet can be specified.

Parameters:

phAttributeList - A Map of attribute-value pairs with each entry containing criteria to find users. The Map key should contain a String representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map values can include wild cards(%).

pasFieldList - The list of fields that is to be returned in the tcResultSet. This can include user-defined fields as well as any of the following metadata codes:

• Organizations.Key
• Organizations.Organization Name
• Users.AD Reference
• Users.Creation Date
• Users.Deprovisioned Date
• Users.Deprovisioning Date
• Users.Disable User
• Users.End Date
• Users.First Name
• Users.Identity
• Users.Key
• Users.Last Name
• Users.Manager Key
• Users.Manager Login
• Users.Middle Name
• Users.Note
• Users.Provisioned Date
• Users.Provisioning Date
• Users.Role
• Users.Row Version
• Users.Start Date
• Users.Status
• Users.Update Date
• Users.Updated By
• Users.User ID
• Users.Xellerate Type

startRow - The starting row of the result

pageSize - The page size (how many rows to return)

order - The order in which the result set is based since only a subset of the whole matching set is returned, the caller will not be able to sort accurately with only that subset.

ascendingOrder - - a boolean value if the sorting is to be ascending or descending

Returns:

A tcResultSet that contains the fields specified in pasFieldList.

Throws:

tcAPIException

findUsersFiltered

@Deprecated
Thor.API.tcResultSet findUsersFiltered(java.util.Map phAttributeList,
                                                   java.lang.String[] pasFieldList)
                                            throws tcAPIException,
                                                   tcAPIException

Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead

Returns a list of users that match the provided attribute list. The fields returned in the tcResultSet can be specified.

Parameters:

phAttributeList - A Map of attribute-value pairs with each entry containing criteria to find users. The Map key should contain a String representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map values can include wild cards(%).

pasFieldList - The list of fields that is to be returned in the tcResultSet. This can include user-defined fields as well as any of the following metadata codes:

• Organizations.Key
• Organizations.Organization Name
• Users.AD Reference
• Users.Creation Date
• Users.Deprovisioned Date
• Users.Deprovisioning Date
• Users.Disable User
• Users.End Date
• Users.First Name
• Users.Identity
• Users.Key
• Users.Last Name
• Users.Manager Key
• Users.Manager Login
• Users.Middle Name
• Users.Note
• Users.Provisioned Date
• Users.Provisioning Date
• Users.Role
• Users.Row Version
• Users.Start Date
• Users.Status
• Users.Update Date
• Users.Updated By
• Users.User ID
• Users.Xellerate Type

Returns:

A tcResultSet that contains the fields specified in pasFieldList.

Throws:

tcAPIException

findUsersFilteredCount

int findUsersFilteredCount(java.util.Map phAttributeList,
                           java.lang.String[] pasFieldList)
                    throws tcAPIException,
                           tcAPIException

Returns a count of users that match the provided attribute list. Returns an int holding the number of rows.

Parameters:

phAttributeList - A Map of attribute-value pairs with each entry containing criteria to find users. The Map key should contain a String representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map values can include wild cards(%).

pasFieldList - The list of fields that is to be returned in the tcResultSet. This can include user-defined fields as well as any of the following metadata codes:

• Organizations.Key
• Organizations.Organization Name
• Users.AD Reference
• Users.Creation Date
• Users.Deprovisioned Date
• Users.Deprovisioning Date
• Users.Disable User
• Users.End Date
• Users.First Name
• Users.Identity
• Users.Key
• Users.Last Name
• Users.Manager Key
• Users.Manager Login
• Users.Middle Name
• Users.Note
• Users.Provisioned Date
• Users.Provisioning Date
• Users.Role
• Users.Row Version
• Users.Start Date
• Users.Status
• Users.Update Date
• Users.Updated By
• Users.User ID
• Users.Xellerate Type

Returns:

An int holding the number of rows

Throws:

tcAPIException

getGroups

Thor.API.tcResultSet getGroups(long plUserKey)
                        throws tcAPIException,
                               tcUserNotFoundException,
                               tcAPIException

Gets a list of all the groups the user is a member of.

Parameters:

plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column)

Returns:

A tcResultSet each row holding information about a group the user is a member of.

Throws:

tcAPIException

tcUserNotFoundException

getObjectAuthorizationPermissions

@Deprecated
Thor.API.tcResultSet getObjectAuthorizationPermissions(long plUserKey)
                                                            throws tcAPIException,
                                                                   tcUserNotFoundException,
                                                                   tcAPIException

Deprecated.

Returns a list of Objects the user has authorization control over, based on the group membership of the user.

Parameters:

plUserKey - The key of the user.

Returns:

A tcResultSet containing a list of Objects that the User has authorization permissions for.

Throws:

tcAPIException

tcUserNotFoundException

getObjects

@Deprecated
Thor.API.tcResultSet getObjects(long plUserKey)
                                     throws tcAPIException,
                                            tcUserNotFoundException,
                                            tcAPIException

Deprecated.

Gets a list of all the objects that have been provisioned for a user.

Parameters:

plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column)

Returns:

A tcResultSet, each row holding information about an object that has been provisioned for a user. The following columns are returned

• Users-Object Instance For User.Key
• Users-Object Instance For User.Offlined Date
• Object Instance.Key
• Requests.Key
• Object Instance.Status
• Objects.Key
• Objects.Name
• Process Instance.Key
• Process Instance.Create
• Process Instance.Update Date
• Process Instance.Status
• Process Instance.Descriptive Data
• Objects.Object Status.Status
• Objects.Object Form Key
• Object Instance.Object Form Entries
• Objects.Object Form Name
• Process.Process Definition.Process Form Key
• Process Instance.Process Form Entries
• Process.Process Definition.Process Form Name
• Users-Object Instance For User.Service Account Flag

Throws:

tcAPIException

tcUserNotFoundException

getObjectsByType

Thor.API.tcResultSet getObjectsByType(long plUserKey,
                                      java.lang.String psObjectType)
                               throws tcAPIException,
                                      tcUserNotFoundException,
                                      tcAPIException

Gets a list of all the objects of the specified type that have been provisioned for a user.

Parameters:

plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column)

psObjectType - The type of the Object to look for

Returns:

A tcResultSet, each row holding information about an object that has been provisioned for a user.

Throws:

tcAPIException

tcUserNotFoundException

getObjectsByTypeStatus

@Deprecated
Thor.API.tcResultSet getObjectsByTypeStatus(long plUserKey,
                                                        java.lang.String psObjectType,
                                                        java.lang.String psStatus)
                                                 throws tcAPIException,
                                                        tcUserNotFoundException,
                                                        tcAPIException

Deprecated.

Gets a list of all the objects of the specified type that have been provisioned for a user and are in the specified status.

Parameters:

plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column)

psObjectType - The type of the Object to look for

psStatus - String holding the status the objects retrieved should be in

Returns:

A tcResultSet, each row holding information about an object that has been provisioned for a user.

Throws:

tcAPIException

tcUserNotFoundException

getUserFromObjectInfo

java.lang.String[] getUserFromObjectInfo(java.lang.String psObjName,
                                         java.lang.String psColumnName,
                                         java.lang.String psColumnValue)
                                  throws tcAPIException,
                                         tcAPIException

Locates User Record(s) in OIM based on data for a provisioned object.

Parameters:

psObjName - The name of object whose data the user is to be located based on. This corresponds to the name of an object defined in OIM.

psColumnName - The descriptive name of the column as specified in the Structure Utility

psColumnValue - The value to search for

Returns:

A List containing the User Keys of the Users found. If no users are found the list will be empty.

Throws:

tcAPIException

provisionObject

@Deprecated
long provisionObject(long plUserKey,
                                 long plObjectKey)
                          throws tcAPIException,
                                 tcObjectNotFoundException,
                                 tcProvisioningNotAllowedException,
                                 tcUserNotFoundException,
                                 tcAPIException

Deprecated.

Provision an object for a user directly without going through a request. The resource is assumed to not be a service account.

Parameters:

plUserKey - The key of the user.

plObjectKey - The key of the object to provision.

Returns:

The Object Instance Key for the provisioning record created

Throws:

tcAPIException

tcObjectNotFoundException

tcProvisioningNotAllowedException

tcUserNotFoundException

provisionObject

@Deprecated
long provisionObject(long plUserKey,
                                 long plObjectKey,
                                 boolean pbServiceAccount)
                          throws tcAPIException,
                                 tcObjectNotFoundException,
                                 tcProvisioningNotAllowedException,
                                 tcUserNotFoundException,
                                 tcAPIException

Deprecated.

Provision an object for a user directly without going through a request.

Parameters:

plUserKey - The key of the user.

plObjectKey - The key of the object to provision.

pbServiceAccount - Whether the account is a service account or not. True if it is

Returns:

The Object Instance Key for the provisioning record created

Throws:

tcAPIException

tcObjectNotFoundException

tcProvisioningNotAllowedException

tcUserNotFoundException

provisionResource

@Deprecated
ResourceData provisionResource(long plUserKey,
                                           long plObjectKey)
                                    throws tcAPIException,
                                           tcObjectNotFoundException,
                                           tcProvisioningNotAllowedException,
                                           tcUserNotFoundException,
                                           tcAPIException

Deprecated.

Provision an object for a user directly without going through a request. The resource is assumed to not be a service account.

Parameters:

plUserKey - The key of the user.

plObjectKey - The key of the object to provision.

Returns:

The ResourceData which contain obi and oiu key for the provisioning record created

Throws:

tcAPIException

tcObjectNotFoundException

tcProvisioningNotAllowedException

tcUserNotFoundException

provisionResource

@Deprecated
ResourceData provisionResource(long plUserKey,
                                           long plObjectKey,
                                           boolean pbServiceAccount)
                                    throws tcAPIException,
                                           tcObjectNotFoundException,
                                           tcProvisioningNotAllowedException,
                                           tcUserNotFoundException,
                                           tcAPIException

Deprecated.

Provision an object for a user directly without going through a request.

Parameters:

plUserKey - The key of the user.

plObjectKey - The key of the object to provision.

pbServiceAccount - Whether the account is a service account or not. True if it is

Returns:

The ResourceData which contain obi and oiu key for the provisioning record created

Throws:

tcAPIException

tcObjectNotFoundException

tcProvisioningNotAllowedException

tcUserNotFoundException

revokeObject

@Deprecated
void revokeObject(long plUserKey,
                              long plObjectInstanceForUserKey)
                       throws tcAPIException,
                              tcObjectNotFoundException,
                              tcRevocationNotAllowedException,
                              tcUserNotFoundException,
                              tcAPIException

Deprecated.

Revokes the provisioning of an object for a user directly without going through a request.

Parameters:

plUserKey - The key of the user.

plObjectInstanceForUserKey - The key of the object instance for a user in the system.

Throws:

tcAPIException

tcObjectNotFoundException

tcRevocationNotAllowedException

tcUserNotFoundException

revokeObjects

@Deprecated
void revokeObjects(long plUserKey,
                               long[] paObjectInstancesForUserKey)
                        throws tcAPIException,
                               tcObjectNotFoundException,
                               tcRevocationNotAllowedException,
                               tcUserNotFoundException,
                               tcBulkException,
                               tcAPIException

Deprecated.

Revokes the provisioning of an object for a user directly without going through a request.

Parameters:

plUserKey - The key of the user.

paObjectInstancesForUserKey - The key of the object instance for a user in the system.

Throws:

tcAPIException

tcObjectNotFoundException

tcRevocationNotAllowedException

tcUserNotFoundException

tcBulkException

updateUser

void updateUser(Thor.API.tcResultSet poUserResultSet,
                java.util.Map phAttributeList,
                boolean changePassword)
         throws tcAPIException,
                tcUserNotFoundException,
                tcStaleDataUpdateException,
                tcAPIException

Update a user in Xellerate. Requires a result set to maintain our pessimistic locking mechanism.

Parameters:

poUserResultSet - A result set containing at the minimum the user key and the rowver of the user record to update.

phAttributeList - A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this user. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes of the columns to set.

changePassword - Whether this update has been trigerred for a password change

Throws:

tcAPIException

tcUserNotFoundException

tcStaleDataUpdateException

Since:

9.1.0.0

updateUser

@Deprecated
void updateUser(Thor.API.tcResultSet poUserResultSet,
                            java.util.Map phAttributeList)
                     throws tcAPIException,
                            tcUserNotFoundException,
                            tcStaleDataUpdateException,
                            tcAPIException

Deprecated. use UserManager#modify(String attributeName, Object attributeValue,User user) instead

Update a user in OIM. Requires a result set to maintain our pessimistic locking mechanism.

Parameters:

poUserResultSet - A result set containing at the minimum the user key and the rowver of the user record to update.

phAttributeList - A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this user. The Attribute names are the String column codes (from the OIM metadata). The Attribute Values are the String attributes of the columns to set.

Throws:

tcAPIException

tcUserNotFoundException

tcStaleDataUpdateException

enableAppForUser

@Deprecated
void enableAppForUser(long plUserKey,
                                  long plObjectInstanceForUserKey)
                           throws tcObjectNotFoundException,
                                  tcUserNotFoundException,
                                  tcAPIException,
                                  tcAPIException

Deprecated.

Enables the object instance for the specified user.

Parameters:

plUserKey - The key of the user.

plObjectInstanceForUserKey - The key of the object instance for a user in the system.

Throws:

tcObjectNotFoundException

tcUserNotFoundException

tcAPIException

enableAppsForUser

@Deprecated
void enableAppsForUser(long plUserKey,
                                   long[] paObjectInstancesForUserKey)
                            throws tcObjectNotFoundException,
                                   tcUserNotFoundException,
                                   tcAPIException,
                                   tcBulkException,
                                   tcAPIException

Deprecated.

Enables the object instances for the specified user.

Parameters:

plUserKey - The key of the user.

paObjectInstancesForUserKey - The keys of the object instances for a user in the system.

Throws:

tcObjectNotFoundException

tcUserNotFoundException

tcAPIException

tcBulkException

disableAppForUser

@Deprecated
void disableAppForUser(long plUserKey,
                                   long plObjectInstanceForUserKey)
                            throws tcObjectNotFoundException,
                                   tcUserNotFoundException,
                                   tcAPIException,
                                   tcAPIException,
                                   ObjectAlreadyDisabledException

Deprecated.

Disables the object instance for the specified user.

Parameters:

plUserKey - The key of the user.

plObjectInstanceForUserKey - The key of the object instance for a user in the system.

Throws:

tcObjectNotFoundException

tcUserNotFoundException

tcAPIException

ObjectAlreadyDisabledException

disableAppsForUser

@Deprecated
void disableAppsForUser(long plUserKey,
                                    long[] paObjectInstancesForUserKey)
                             throws tcObjectNotFoundException,
                                    tcUserNotFoundException,
                                    tcAPIException,
                                    tcBulkException,
                                    tcAPIException

Deprecated.

Disables the object instances for the specified user.

Parameters:

plUserKey - The key of the user.

paObjectInstancesForUserKey - The key of the object instances for a user in the system.

Throws:

tcObjectNotFoundException

tcUserNotFoundException

tcAPIException

tcBulkException

getMenuListForSelf

@Deprecated
Thor.API.tcResultSet getMenuListForSelf()
                                             throws tcAPIException,
                                                    tcAPIException

Deprecated.

Retrieves a list of web application menu items for the logged in user. The menu items retrieved will be based on the user's group membership.

Returns:

a tcResultSet containing a flat list of the user's menu items. Each menu item will have the following naming convention:
<Parent Menu>.<Child Menu>.<Sub Menu(if necessary)>

Throws:

tcAPIException - if any database errors occurred while retrieving list of menu items

getMenuList

@Deprecated
Thor.API.tcResultSet getMenuList(long plUserKey)
                                      throws tcUserNotFoundException,
                                             tcAPIException,
                                             tcAPIException

Deprecated.

Retrieves a list of web application menu items that users have access to based on their group membership.

Parameters:

plUserKey - key of the user to retrieve a list of menu items for.

Returns:

a tcResultSet containing a flat list of the user's menu items. Each menu item will have the following naming convention:
<Parent Menu>.<Child Menu>.<Sub Menu(if necessary)>

Throws:

tcUserNotFoundException - if specified user does not exist

tcAPIException - if any database errors occurred while retrieving list of menu items

findAllUsers

@Deprecated
Thor.API.tcResultSet findAllUsers(java.util.Map phAttributeList)
                                       throws tcAPIException,
                                              tcAPIException

Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead

Returns a list of users that match the provided attribute list.

Parameters:

phAttributeList - A Map of attribute-value pairs with each entry containing criteria to find users. The Map key should contain a String representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map values can include wild cards(%). This API will search through all users defined in the repository to return a result set.

Returns:

A tcResultSet that contains user-defined columns as well as the following user-related information:

• Organizations.Key
• Organizations.Organization Name
• Users.AD Reference
• Users.Creation Date
• Users.Deprovisioned Date
• Users.Deprovisioning Date
• Users.Disable User
• Users.End Date
• Users.First Name
• Users.Identity
• Users.Key
• Users.Last Name
• Users.Manager Key
• Users.Manager Login
• Users.Manager First Name
• Users.Manager Last Name
• Users.Middle Name
• Users.Note
• Users.Provisioned Date
• Users.Provisioning Date
• Users.Role
• Users.Row Version
• Users.Start Date
• Users.Status
• Users.Update Date
• Users.Updated By
• Users.User ID
• Users.Xellerate Type
• Users.Lock User
• Users.Email

Throws:

tcAPIException

setChallengeValuesForSelf

@Deprecated
void setChallengeValuesForSelf(java.util.Map phQuestionAnswer)
                                    throws tcNumberOfChallengesMismatchException,
                                           tcAPIException,
                                           tcInvalidQuestionException,
                                           tcAPIException

Deprecated. use AuthenticatedSelfService#setChallengeValues(Map quesAnsMap instead

Set the challenge questions and answers for the logged in user.

Parameters:

phQuestionAnswer - A map of questions and answers for the current logged in user.

Throws:

tcNumberOfChallengesMismatchException

tcAPIException

tcInvalidQuestionException

getChallengeValuesForSelf

@Deprecated
Thor.API.tcResultSet getChallengeValuesForSelf()
                                                    throws tcAPIException,
                                                           tcQuestionsNotDefinedException,
                                                           tcAPIException

Deprecated. use AuthenticatedSelfService#getChallengeValuesForSelf() instead

Returns a resultset of the questions and answers

Returns:

tcResultSet of the questions and answers for a user

Throws:

tcAPIException

tcQuestionsNotDefinedException

getChallengeValuesForUser

@Deprecated
Thor.API.tcResultSet getChallengeValuesForUser(long userKey)
                                                    throws tcAPIException,
                                                           tcQuestionsNotDefinedException,
                                                           tcUserNotFoundException,
                                                           tcAPIException

Deprecated. use oracle.iam.identity.usermgmt.api.UserManager#getUserChallengeValues() instead

Returns a resultset of the questions and answers

Parameters:

userKey - The key of the user.

Returns:

tcResultSet of the questions and answers for a user

Throws:

tcAPIException

tcQuestionsNotDefinedException

tcUserNotFoundException

compareChallengeValuesForSelf

boolean compareChallengeValuesForSelf(java.util.Map phQuestionAnswer)
                               throws tcNumberOfChallengesMismatchException,
                                      tcAPIException,
                                      tcAPIException

Compares the questions/answers entered by the user against the ones stored in the database

Parameters:

phQuestionAnswer - A map of questions and answers for the current logged in user.

Returns:

true if all answers are correct to the appropriate questions

Throws:

tcNumberOfChallengesMismatchException

tcAPIException

isChallengeQuestionsSetForSelf

boolean isChallengeQuestionsSetForSelf()
                                throws tcAPIException,
                                       tcAPIException

Check if challenge questions are set for the current user.

Returns:

true if challenge questions are set, false otherwise

Throws:

tcAPIException

unlockUsers

@Deprecated
void unlockUsers(long[] paUserKeys)
                      throws tcAPIException,
                             tcUserNotFoundException,
                             tcBulkException,
                             tcAPIException

Deprecated. use UserManager#unlock(ArrayList userIDs, boolean isUserLogin) instead

Enable users in OIM by unlocking their accounts if they are locked.

Parameters:

paUserKeys - The array user keys to enable.

Throws:

tcAPIException

tcUserNotFoundException

tcBulkException

getProxyDetails

Thor.API.tcResultSet getProxyDetails(long userKey)
                              throws tcAPIException,
                                     tcUserNotFoundException,
                                     tcAPIException

This method will return the detail information of the proxy assigned to the specified user. The proxy information is the current assigned proxy to the user been passed.

Parameters:

userKey - user that is been proxied

Returns:

a result set with information about the proxy user

Throws:

tcAPIException - raised if a error occurred

tcUserNotFoundException - raised if the user key passed is not of a valid user.

Since:

8.0

deleteProxies

@Deprecated
void deleteProxies(long userKey)
                        throws tcAPIException,
                               tcUserNotFoundException,
                               tcAPIException

Deprecated. use UserManager#removeAllProxiesForUser(String userID,boolean isUserLogin) instead

This method deletes all the proxies setup for the given user.

Parameters:

userKey - the user key that is been proxied

Throws:

tcAPIException - raised if an error occurred by deleting the proxies

tcUserNotFoundException - raised if the user key is not of a valid user.

Since:

8.0

deleteProxy

@Deprecated
void deleteProxy(long userKey,
                             long proxyKey)
                      throws tcAPIException,
                             tcUserNotFoundException

Deprecated. use UserManager#removeProxy(String userID,String proxyID,boolean isUserLogin) instead

This method delete a proxy with a proxyKey for given user.

Parameters:

userKey - the user key that is been proxied

proxyKey - the proxy that is to be deleted

Throws:

tcAPIException

tcUserNotFoundException

setProxyForUser

@Deprecated
long setProxyForUser(long userKey,
                                 long proxyUserKey,
                                 java.util.Date startDate,
                                 java.util.Date endDate)
                          throws tcAPIException,
                                 tcUserNotFoundException,
                                 tcRecursiveProxyException,
                                 tcAPIException

Deprecated. use UserManager#addProxyForUser(String userID,String proxyUserID,Date startDate, Date endDate,boolean isUserLogin) instead

This new method will set the specified user as a proxy for the specified user.

Parameters:

userKey - the user been proxied

proxyUserKey - the user to proxy

startDate - start date to proxy (can be null)

endDate - end date of the proxy

Returns:

the proxy id in the table

Throws:

tcAPIException - raised if there is an error setting the proxy

tcUserNotFoundException - if any of the user do not exist in the system.

tcRecursiveProxyException - if there is a recursive proxy

Since:

8.0

updateProxyForUser

@Deprecated
void updateProxyForUser(long pxdKey,
                                    java.util.Map attribute)
                             throws tcAPIException,
                                    tcUserNotFoundException,
                                    tcRecursiveProxyException,
                                    tcAPIException

Deprecated. use UserManager#updateProxyForUser(String proxyID,final Map attribute ) instead

This new method will update the specified user as a proxy for the specified user.

Parameters:

pxdKey - the proxy key that references the proxy update

attribute - an attribute map of the fields to update:

• pxd_orig_usr_key - for the original user
• pxd_proxy_key - the current proxy user
• pxd_start_date - start date when the proxy takes effect
• pxd_end_date - end date when the proxy ends

Throws:

tcAPIException - raised if there is an error setting the proxy

tcUserNotFoundException - if any of the user do not exist in the system.

tcRecursiveProxyException - if there is a recursive proxy

Since:

8.0

getProxiedUser

Thor.API.tcResultSet getProxiedUser(long userKey)
                             throws tcAPIException,
                                    tcUserNotFoundException,
                                    tcAPIException

This method will return the detail information of only the current proxied user by the specified user.

Parameters:

userKey - user is the proxy user

Returns:

a result set with information about the proxied user

Throws:

tcAPIException - raised if a error occurred

tcUserNotFoundException - raised if the user key passed is not of a valid user.

Since:

8.0

relinkAccount

void relinkAccount(long plObjectInstanceForUserKey,
                   long plTargetUserKey,
                   boolean updateParentDataFlag)
            throws tcAPIException,
                   tcAPIException

Throws:

tcAPIException

moveServiceAccount

void moveServiceAccount(long plObjectInstanceForUserKey,
                        long plTargetUserKey)
                 throws tcAPIException,
                        tcAPIException

Moves the service account from its current owner to a new owner.

Parameters:

plObjectInstanceForUserKey - The key of the object instance for a user in the system.

plTargetUserKey - The key of the user who shall be the new owner.

Throws:

tcAPIException

changeToServiceAccount

void changeToServiceAccount(long plObjectInstanceForUserKey)
                     throws tcAPIException,
                            tcAPIException

Changes a regular account to a service account.

Parameters:

plObjectInstanceForUserKey - The key of the object instance for a user in the system.

Throws:

tcAPIException

changeFromServiceAccount

void changeFromServiceAccount(long plObjectInstanceForUserKey)
                       throws tcAPIException,
                              tcAPIException

Changes a service account to a regular account.

Parameters:

plObjectInstanceForUserKey - The key of the object instance for a user in the system.

Throws:

tcAPIException

getUnAssignedGroups

Thor.API.tcResultSet getUnAssignedGroups(long plUserKey)
                                  throws tcAPIException,
                                         tcUserNotFoundException,
                                         tcAPIException

Gets a list of all the groups the user is not a member of.

Parameters:

plUserKey - Value holding the User Key (corresponds to value in the USR_KEY column)

Returns:

A tcResultSet each row holding information about a group the user is not a member of.

Throws:

tcAPIException

tcUserNotFoundException

canResourceBeProvisioned

@Deprecated
boolean canResourceBeProvisioned(long userKey,
                                             long objectKey)
                                      throws tcAPIException,
                                             tcUserNotFoundException,
                                             tcObjectNotFoundException,
                                             tcAPIException

Deprecated.

Determines if a resource can be provisioned to a user or not.

Parameters:

userKey - Value holding the User Key (corresponds to value in the USR_KEY column)

objectKey - This is the resource object key

Returns:

A tcResultSet each row holding information about a group the user is not a member of.

Throws:

tcAPIException

tcUserNotFoundException

tcObjectNotFoundException

getEncodedValue

Thor.API.tcResultSet getEncodedValue(java.lang.String strDecodeVal,
                                     java.lang.String strFieldName)
                              throws tcAPIException,
                                     tcAPIException

This object returns a resultset of the object available for the given encoded value.

Parameters:

valDecodes. - If a null or empty array is passed, this function will raise the tcAPIException

Returns:

tcResultSet of the available objects for the Encoded Value

Throws:

tcUserNotFoundException

tcAPIException

getActiveUsers

Thor.API.tcResultSet getActiveUsers(java.util.Map attributes)
                             throws tcAPIException,
                                    tcAPIException

Returns a list of active users in the system. Active user is defined as users that are not disabled or deleted, or do not have an active proxy setup. This API takes permissions into consideration and returns only the users over which the logged in user has read permissions.

Parameters:

attributes - A Map of attribute-value pairs with each entry containing criteria to find active users. The Map key should contain a String representation of the metadata codes. The Map value can contain a String representation of the criteria to find the desired requests. Note that the Map values can include wild cards(*).

Only attributes allowed in the map for filerting are

• Users.First Name, User First Name
• Users.Last Name, User Last Name
• Users.User ID, User Login
• Users.Key, User Key

Returns:

A tcResultSet that contains the following information:

• Users.Key , User Key
• Users.User ID, User Login
• Users.First Name, User First Name
• Users.Last Name, User Last Name

Throws:

tcAPIException - If an error occurs while querying the user data

getProxyList

Thor.API.tcResultSet getProxyList(java.util.Map attributeMap,
                                  java.lang.String[] fieldList)
                           throws tcUserNotFoundException,
                                  tcAPIException,
                                  tcAPIException

Method that returns a resultset of the proxy users for the user whose key is passed in. This API checks for the presence of a system property called "XL.CustomProxyClassName". If this system property is set, then the value of this system property is the class name, which the API introspects and instantiates to get the custom proxies. If this system property is not set, then the API returns the list of proxies in the default OIM way.

Returns:

A tcResultSet that contains list of the proxies for the given user. The columns contained in the resultset are:

• Users.User ID, User Login
• Users.First Name, User First Name
• Users.Last Name, User Last Name

Throws:

tcUserNotFoundException - If the user key passed in does not correspond to an actual user.

tcAPIException - If an error occurs while querying the user data

Since:

9.0.1.2

findAllUsersFiltered

@Deprecated
Thor.API.tcResultSet findAllUsersFiltered(java.util.Map phAttributeList,
                                                      java.lang.String[] pasFieldList)
                                               throws tcAPIException,
                                                      tcAPIException

Deprecated. use UserManager#search(SearchCriteria criteria,Set retAttrs,HashMap configParams) instead

Returns a list of users that match the provided attribute list. This API searches through all users defined in the system. The fields returned in the tcResultSet can be specified.

Parameters:

phAttributeList - attribute-value pairs with each entry containing criteria to find users

pasFieldList - The list of fields that is to be returned in the tcResultSet.

Returns:

A tcResultSet that contains the fields specified in pasFieldList. Returned tcResultSet always contains

• Users.Key
• Users.Row Version

Throws:

tcAPIException

lockSelf

@Deprecated
void lockSelf(java.lang.String username)
                   throws tcAPIException,
                          tcUserNotFoundException,
                          tcAPIException

Deprecated. use UserManager#lock(String userID,boolean isUserLogin) instead

Locks the self user with a signature login. This method is not supported to the clients.

Throws:

tcAPIException

tcUserNotFoundException

getGroups

Thor.API.tcResultSet getGroups(java.util.Map searchCriteria)
                        throws tcAPIException,
                               tcUserNotFoundException,
                               tcAPIException

Gets a list of all the groups the user is a member of.

Parameters:

searchCriteria - Map holding the search criteria with key in Metadata form for filtering Groups. Map must contain Users.Key. Metadata Keys that can be passed are as follows: Groups.Group Name, Users.Key

Returns:

A tcResultSet each row holding information about a group the user is a member of.

Throws:

tcAPIException

tcUserNotFoundException