user.set_password

Set the password of the specified username to the new_password specified in payload.

ValidationErrors will be raised in the following situations: * username does not exist * account is not local to the NAS (Active Directory, LDAP, etc) * account has password authentication disabled * account is locked

NOTE: when authenticated session has less than FULL_ADMIN role, password changes will be rejected if the payload does not match the currently-authenticated user.

NOTE: users authenticated with a one-time password will be able to change the password without submitting a second time.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: set_password_data

set_password_data

Type: object
No Additional Properties

username Required

Username

Type: string

old_password

Old Password

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

new_password Required

New Password

Type: string

Must be at least 1 characters long

Return value

Result

Type: null

Required roles: