com.emc.vipr.client.system

Class Password

java.lang.Object

com.emc.vipr.client.system.Password

public class Password
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Password(RestClient client)

Method Summary

Modifier and Type	Method and Description
void	reset(java.lang.String username, java.lang.String password, boolean encrypted) Change a given local user's password.
void	reset(java.lang.String username, java.lang.String password, boolean encrypted, boolean logoutUser) Change a given local user's password.
void	update(java.lang.String oldPassword, java.lang.String password, boolean encrypted) Change an authenticated local user's own password.
void	update(java.lang.String oldPassword, java.lang.String password, boolean encrypted, boolean logoutUser) Change an authenticated local user's own password.
void	updateAuthorizedKey2(java.lang.String sshKey) Change an authenticated local user's SSH authorizedkey2.
void	validate(java.lang.String password) Validate a password.
void	validateUpdate(java.lang.String oldPassword, java.lang.String password) an authenticated local user validates its proposed password change.

Methods inherited from class java.lang.Object

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

Constructor Detail

Password

public Password(RestClient client)

Method Detail

update

public void update(java.lang.String oldPassword,
                   java.lang.String password,
                   boolean encrypted)

Change an authenticated local user's own password. Accepts a clear test password or a password already hashed by the caller. If both form fields are specified, bad request will be returned. User is automatically logged out after password reset.

API Call: PUT /password

Parameters:

password - The clear text or encrypted password

encrypted - If true, the supplied password is already hashed

oldPassword - the previous password in clear text

update

public void update(java.lang.String oldPassword,
                   java.lang.String password,
                   boolean encrypted,
                   boolean logoutUser)

Change an authenticated local user's own password. Accepts a clear test password or a password already hashed by the caller. If both form fields are specified, bad request will be returned.

API Call: PUT /password

Parameters:

password - The clear text or encrypted password

encrypted - If true, the supplied password is already hashed

logoutUser - If true, logout the user after updating the password

reset

public void reset(java.lang.String username,
                  java.lang.String password,
                  boolean encrypted)

Change a given local user's password. The authenticated caller must have SEC_ADMIN role. User is automatically logged out after password reset.

API Call: PUT /password/reset

Parameters:

username - The local user name

password - Clear text or encrypted password

encrypted - If true, the provided password is encrypted

reset

public void reset(java.lang.String username,
                  java.lang.String password,
                  boolean encrypted,
                  boolean logoutUser)

Change a given local user's password. The authenticated caller must have SEC_ADMIN role.

API Call: PUT /password/reset

Parameters:

username - The local user name

password - Clear text or encrypted password

encrypted - If true, the provided password is encrypted

logoutUser - If true, logout the user after updating the password

updateAuthorizedKey2

public void updateAuthorizedKey2(java.lang.String sshKey)
                          throws java.lang.Exception

Change an authenticated local user's SSH authorizedkey2. This interface accepts the user's SSH authorizedkey2

API Call: PUT /password/authorizedkey2

Parameters:

sshKey - the SSH key

Throws:

java.lang.Exception

validate

public void validate(java.lang.String password)
              throws java.lang.Exception

Validate a password. If validation passes, it will return an http 204 status code (no content). If validation fails, it will throw a ServiceErrorException with an http 400 status code (bad parameters).

API Call: POST /password/validate

Parameters:

password - plaintext password to validate

Throws:

java.lang.Exception

validateUpdate

public void validateUpdate(java.lang.String oldPassword,
                           java.lang.String password)
                    throws java.lang.Exception

an authenticated local user validates its proposed password change. If validation passes, it will return an http 204 status code (no content). If validation fails, it will throw a ServiceErrorException with an http 400 status code (bad parameters).

API Call: POST /password/validate-update

Throws:

java.lang.Exception