com.manageengine.pam360.sdk.user

Class User

java.lang.Object

com.manageengine.pam360.sdk.user.User

public final class User
extends java.lang.Object

Contains methods to perform operations over PAM user

Constructor Summary

Constructors

Constructor and Description
User(PAMService service, APIRequestHandler rest)

Method Summary

Modifier and Type	Method and Description
boolean	addToUserGroup(java.lang.String userName, java.lang.String userGroupName) Add the user to the user group
boolean	addUserToGroup(java.lang.String userName, java.lang.String userGroupName) Add the user to the user group of a particular organization
UserDetails	createUser(UserModel userModel) Create an user with specified properties
boolean	deleteUser(long userId) Delete an user using user ID
boolean	deleteUser(java.lang.String userName) Delete an user using UserName
org.json.JSONObject	deleteuserGroup(java.util.ArrayList<java.lang.String> userGroupNames) remove the user from the user group of a particular organization
org.json.JSONObject	deleteUserGroup(org.json.JSONArray userGroupIds) remove the user from the user group of a particular organization
UserDetails	editUser(java.lang.String userName, UserModel userModel) Edit a user with specified properties
long	getusergroupID(java.lang.String groupName) Get the ID of the particular group
long	getUserID(java.lang.String userName) Get the ID of the particular user
static boolean	isValidEmail(java.lang.String email)
boolean	lockUser(java.lang.String username) Lock a particular user using username
UserDetails	mapJsontoUserDetails(org.json.JSONObject data, java.lang.String message)
org.json.JSONObject	regenerateRestToken() To regenerate authToken for a user
org.json.JSONObject	removeFromUserGroup(java.util.ArrayList<java.lang.String> userNames, java.lang.String usergroupName) remove the user from the user group of a particular organization
boolean	resetMFA(java.lang.String userName) To reset two-factor authentication for a username.
boolean	unlockUser(java.lang.String username) Unlock a locked user using username
static java.lang.String	validateExpiryDate(java.lang.String expiryDate)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

public User(PAMService service,
            APIRequestHandler rest)
     throws SDKRegistrationException

Throws:

SDKRegistrationException

Method Detail

createUser

public UserDetails createUser(UserModel userModel)
                       throws SDKConnectionException,
                              SDKOperationFailedException,
                              SDKInvalidArgumentException

Create an user with specified properties

Parameters:

userModelmandatory, - instance of UserModel with necessary fields set

Returns:

true if user has been created successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

mapJsontoUserDetails

public UserDetails mapJsontoUserDetails(org.json.JSONObject data,
                                        java.lang.String message)

editUser

public UserDetails editUser(java.lang.String userName,
                            UserModel userModel)
                     throws SDKInvalidArgumentException,
                            SDKOperationFailedException,
                            SDKConnectionException

Edit a user with specified properties

Parameters:

userName - mandatory,name of the user to be edited

userModel - mandatory,instance of UserModel with necessary fields set

Returns:

true if user has been edited successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

getUserID

public long getUserID(java.lang.String userName)
               throws SDKConnectionException,
                      SDKOperationFailedException,
                      SDKInvalidArgumentException

Get the ID of the particular user

Parameters:

userName - mandatory,not null, non empty name of the user

Returns:

user id as long

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

deleteUser

public boolean deleteUser(long userId)
                   throws SDKConnectionException,
                          SDKOperationFailedException,
                          SDKInvalidArgumentException

Delete an user using user ID

Parameters:

userId - mandatory, non negative unique ID of user to be deleted

Returns:

true if the user has been deleted successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

deleteUser

public boolean deleteUser(java.lang.String userName)
                   throws SDKConnectionException,
                          SDKOperationFailedException,
                          SDKInvalidArgumentException

Delete an user using UserName

Parameters:

userName - mandatory, not null, non empty login name of the user to be deleted

Returns:

true if user has been deleted successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

lockUser

public boolean lockUser(java.lang.String username)
                 throws SDKConnectionException,
                        SDKOperationFailedException,
                        SDKInvalidArgumentException

Lock a particular user using username

Parameters:

username - mandatory,not null, non empty login name of the user to be locked

Returns:

true if the user has been locked successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

unlockUser

public boolean unlockUser(java.lang.String username)
                   throws SDKConnectionException,
                          SDKOperationFailedException,
                          SDKInvalidArgumentException

Unlock a locked user using username

Parameters:

username - mandatory, not null, non empty login name of the user to be unlocked

Returns:

true if the user has been unlocked successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

addToUserGroup

public boolean addToUserGroup(java.lang.String userName,
                              java.lang.String userGroupName)
                       throws SDKConnectionException,
                              SDKOperationFailedException,
                              SDKInvalidArgumentException

Add the user to the user group

Parameters:

userName - mandatory, not null, non empty login name of the user

userGroupName - mandatory, not null, non empty group to which user has to be added

Returns:

true if the user has been added to the group successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

addUserToGroup

public boolean addUserToGroup(java.lang.String userName,
                              java.lang.String userGroupName)
                       throws SDKConnectionException,
                              SDKOperationFailedException,
                              SDKInvalidArgumentException

Add the user to the user group of a particular organization

Parameters:

userName - mandatory, not null, non empty login name of the user

userGroupName - mandatory, not null, non empty group to which user has to be added

Returns:

true if the user has been added to the group successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

getusergroupID

public long getusergroupID(java.lang.String groupName)
                    throws SDKConnectionException,
                           SDKOperationFailedException,
                           SDKInvalidArgumentException

Get the ID of the particular group

Parameters:

groupName - mandatory,not null, non empty name of the usergroup

Returns:

group id as long

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

removeFromUserGroup

public org.json.JSONObject removeFromUserGroup(java.util.ArrayList<java.lang.String> userNames,
                                               java.lang.String usergroupName)
                                        throws SDKInvalidArgumentException,
                                               SDKConnectionException,
                                               SDKOperationFailedException

remove the user from the user group of a particular organization

Parameters:

userNames - mandatory,names of user to be removed from particular group

usergroupName - mandatory,name of usergroup

Returns:

true if the user has been removed from the group successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

deleteuserGroup

public org.json.JSONObject deleteuserGroup(java.util.ArrayList<java.lang.String> userGroupNames)
                                    throws SDKInvalidArgumentException,
                                           SDKConnectionException,
                                           SDKOperationFailedException

remove the user from the user group of a particular organization

Parameters:

userGroupNames - mandatory,not null,names of usergroup to be deleted

Returns:

JsonObject details of the usergroup deleted status

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

deleteUserGroup

public org.json.JSONObject deleteUserGroup(org.json.JSONArray userGroupIds)
                                    throws SDKInvalidArgumentException,
                                           SDKOperationFailedException,
                                           SDKConnectionException

remove the user from the user group of a particular organization

Parameters:

userGroupIds - mandatory,not negative,ids of usergroup to be deleted

Returns:

JsonObject details of the usergroup deleted status

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

resetMFA

public boolean resetMFA(java.lang.String userName)
                 throws SDKInvalidArgumentException,
                        SDKConnectionException,
                        SDKOperationFailedException

To reset two-factor authentication for a username.

Parameters:

userName - mandatory,not null,name of the user

Returns:

true,if TFA resetted successfully.

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

regenerateRestToken

public org.json.JSONObject regenerateRestToken()
                                        throws SDKConnectionException,
                                               SDKOperationFailedException

To regenerate authToken for a user

Returns:

authToken,if regenerated successfully.

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

validateExpiryDate

public static java.lang.String validateExpiryDate(java.lang.String expiryDate)

isValidEmail

public static boolean isValidEmail(java.lang.String email)