com.manageengine.pam360.sdk.resources

Class Password

java.lang.Object

com.manageengine.pam360.sdk.resources.Password

public final class Password
extends java.lang.Object

Contains methods related to password operations

Constructor Summary

Constructors

Constructor and Description
Password(PAMService service, APIRequestHandler rest)

Method Summary

Modifier and Type	Method and Description
boolean	changePasswordOfAccount(java.lang.String resourceName, java.lang.String accountName, java.lang.String newPassword, sdkEnumConstants.ResetType resetType) Change the password of the account under a resource using resource and account name
boolean	changePasswordOfAccount(java.lang.String resourceName, java.lang.String accountName, java.lang.String newPassword, sdkEnumConstants.ResetType resetType, java.lang.String reason, java.lang.Long ticketID) Change the password of the account under a resource using resource and account name
java.lang.String	generate(java.lang.String policy) Generate password based on the password policy
java.lang.String	getPasswordOfAccount(java.lang.String resourceName, java.lang.String accountName) Get the password of the account under a resource using resource and account name
java.lang.String	getPasswordOfAccount(java.lang.String resourceName, java.lang.String accountName, java.lang.String reason) Get the password of the account under a resource using resource and account name
java.lang.String	getPasswordOfAccount(java.lang.String resourceName, java.lang.String accountName, java.lang.String reason, long ticketID) Get the password of the account under a resource using resource and account name
org.json.JSONObject	getPasswordPolicies() To list all the password policies in the organization.
boolean	validatePassword(java.lang.String password, long policyId) To validate the given password based on password policy
boolean	validatePassword(java.lang.String password, sdkEnumConstants.PasswordPolicy passwordPolicy) To validate the given password based on password policy

Methods inherited from class java.lang.Object

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

Constructor Detail

Password

public Password(PAMService service,
                APIRequestHandler rest)
         throws SDKRegistrationException

Throws:

SDKRegistrationException

Method Detail

generate

public java.lang.String generate(java.lang.String policy)
                          throws SDKConnectionException,
                                 SDKOperationFailedException,
                                 SDKInvalidArgumentException

Generate password based on the password policy

Parameters:

policy - mandatory, not null, non empty name of password policy

Returns:

generated password as a string

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

getPasswordOfAccount

public java.lang.String getPasswordOfAccount(java.lang.String resourceName,
                                             java.lang.String accountName,
                                             java.lang.String reason)
                                      throws SDKConnectionException,
                                             SDKOperationFailedException,
                                             SDKInvalidArgumentException

Get the password of the account under a resource using resource and account name

Parameters:

resourceName - mandatory, not null, non empty name of resource

accountName - mandatory,not null, non empty unique name of the account whose password is to be fetched

reason - reason for password retrieval

Returns:

password of the account as a string

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

getPasswordOfAccount

public java.lang.String getPasswordOfAccount(java.lang.String resourceName,
                                             java.lang.String accountName,
                                             java.lang.String reason,
                                             long ticketID)
                                      throws SDKConnectionException,
                                             SDKOperationFailedException,
                                             SDKInvalidArgumentException

Get the password of the account under a resource using resource and account name

Parameters:

resourceName - mandatory, not null, non empty name of resource

accountName - mandatory,not null, non empty unique name of the account whose password is to be fetched

reason - reason for password retrieval

ticketID - If the ticketing system is enabled, you need to pass ticket ID for validation

Returns:

password of the account as a string

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

getPasswordOfAccount

public java.lang.String getPasswordOfAccount(java.lang.String resourceName,
                                             java.lang.String accountName)
                                      throws SDKConnectionException,
                                             SDKOperationFailedException,
                                             SDKInvalidArgumentException

Get the password of the account under a resource using resource and account name

Parameters:

resourceName - mandatory, not null, non empty name of resource

accountName - mandatory,not null, non empty unique name of the account whose password is to be fetched

Returns:

password of the account as a string

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

changePasswordOfAccount

public boolean changePasswordOfAccount(java.lang.String resourceName,
                                       java.lang.String accountName,
                                       java.lang.String newPassword,
                                       sdkEnumConstants.ResetType resetType,
                                       java.lang.String reason,
                                       java.lang.Long ticketID)
                                throws SDKConnectionException,
                                       SDKOperationFailedException,
                                       SDKInvalidArgumentException

Change the password of the account under a resource using resource and account name

Parameters:

resourceName - mandatory,not null, non empty name of resource

accountName - mandatory,not null, non empty unique name of the account whose password is to be changed

newPassword - mandatory,not null, non empty new password

resetType - mandatory,not null, type of password reset

reason - reason for password change or null

ticketID - non negative unique ticket ID or null

Returns:

true if the password of the account has been changed 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

changePasswordOfAccount

public boolean changePasswordOfAccount(java.lang.String resourceName,
                                       java.lang.String accountName,
                                       java.lang.String newPassword,
                                       sdkEnumConstants.ResetType resetType)
                                throws SDKConnectionException,
                                       SDKOperationFailedException,
                                       SDKInvalidArgumentException

Change the password of the account under a resource using resource and account name

Parameters:

resourceName - mandatory,not null, non empty name of resource

accountName - mandatory,not null, non empty unique name of the account whose password is to be changed

newPassword - mandatory,not null, non empty new password

resetType - mandatory,not null, type of password reset sdkEnumConstants.ResetType

Returns:

true if the password of the account has been changed 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

getPasswordPolicies

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

To list all the password policies in the organization.

Returns:

JsonObject containing details about policies.

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

validatePassword

public boolean validatePassword(java.lang.String password,
                                sdkEnumConstants.PasswordPolicy passwordPolicy)
                         throws SDKInvalidArgumentException,
                                SDKConnectionException,
                                SDKOperationFailedException

To validate the given password based on password policy

Parameters:

password - mandatory,not null password to be validated

passwordPolicy - mandatory,type of password policy,based on which password will be validated.

Returns:

true,if password validated 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

validatePassword

public boolean validatePassword(java.lang.String password,
                                long policyId)
                         throws SDKInvalidArgumentException

To validate the given password based on password policy

Parameters:

password - mandatory,not null password to be validated

policyId - mandatory,not negative policy id,based on which password will be validated.

Returns:

true,if password validated 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