Class: Password

Password

new Password()

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

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

getPasswordPolicy(options, callbackopt) → {Promise.<any>}

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.Default: falsewhether or not the user will be required to enter their current password. Use {@code false} (the default) if this is a new user or if an administrator is forcibly changing another user's password.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
hasOldPassword string

hasOldPassword Default: falsewhether or not the user will be required to enter their current password. Use {@code false} (the default) if this is a new user or if an administrator is forcibly changing another user's password.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

policyCheckCreateUser(options, callbackopt) → {Promise.<any>}

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:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
username string

username

displayName string

displayName

emailAddress string

emailAddress

password string

password

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

policyCheckUpdateUser(options, callbackopt) → {Promise.<any>}

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:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
username string

username

oldPassword string

oldPassword

newPassword string

newPassword

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>