com.atlassian.jira.rest.v2.password

Class PasswordResource

java.lang.Object

com.atlassian.jira.rest.v2.password.PasswordResource

public class PasswordResource
extends Object

REST resource for operations related to passwords and the password policy.

Since:

v6.1

Constructor Summary

Constructors

Constructor and Description
PasswordResource(PasswordPolicyManager passwordPolicyManager, UserManager userManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getPasswordPolicy(boolean hasOldPassword) Returns the list of requirements for the current password policy.
javax.ws.rs.core.Response	policyCheckCreateUser(PasswordPolicyCreateUserBean bean) Returns a list of statements explaining why the password policy would disallow a proposed password for a new user.
javax.ws.rs.core.Response	policyCheckUpdateUser(PasswordPolicyUpdateUserBean bean) Returns a list of statements explaining why the password policy would disallow a proposed new password for a user with an existing password.

Methods inherited from class java.lang.Object

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

Constructor Detail

PasswordResource

public PasswordResource(PasswordPolicyManager passwordPolicyManager,
                        UserManager userManager)

Method Detail

getPasswordPolicy

public javax.ws.rs.core.Response getPasswordPolicy(boolean hasOldPassword)

Returns the list of requirements for the current password policy. For example, "The password must have at least 10 characters.", "The password must not be similar to the user's name or email address.", etc.

Parameters:

hasOldPassword - whether or not the user will be required to enter their current password. Use false (the default) if this is a new user or if an administrator is forcibly changing another user's password.

Returns:

a response containing a JSON array of the user-facing messages. If no policy is set, then this will be an empty list.

policyCheckCreateUser

public javax.ws.rs.core.Response policyCheckCreateUser(PasswordPolicyCreateUserBean bean)

Returns a list of statements explaining why the password policy would disallow a proposed password for a new user.

You can use this method to test the password policy validation. This could be done prior to an action where a new user and related password are created, using methods like the ones in UserService. For example, you could use this to validate a password in a create user form in the user interface, as the user enters it.
The username and new password must be not empty to perform the validation.
Note, this method will help you validate against the policy only. It won't check any other validations that might be performed when creating a new user, e.g. checking whether a user with the same name already exists.

Parameters:

bean - a representation of the intended parameters for the user that would be created.

Returns:

a response containing a JSON array of the user-facing messages. If no policy is set, then this will be an empty list.

policyCheckUpdateUser

public javax.ws.rs.core.Response policyCheckUpdateUser(PasswordPolicyUpdateUserBean bean)

Returns a list of statements explaining why the password policy would disallow a proposed new password for a user with an existing password.

You can use this method to test the password policy validation. This could be done prior to an action where the password is actually updated, using methods like ChangePassword or ResetPassword. For example, you could use this to validate a password in a change password form in the user interface, as the user enters it.
The user must exist and the username and new password must be not empty, to perform the validation.
Note, this method will help you validate against the policy only. It won't check any other validations that might be performed when submitting a password change/reset request, e.g. verifying whether the old password is valid.

Parameters:

bean - a representation of the intended parameters for the update that would be performed

Returns:

a response containing a JSON array of the user-facing messages. If no policy is set, then this will be an empty list.