Authentication: updatePassword

Updates the password for a specified user.

Request

HTTP request

PUT /v2/login_information/{loginPart}

Parameters

Parameter name Value Description
Path parameters
loginPart string

Currently, only the value password is supported.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Authentication::updatePassword

Definitions Expand All | Collapse All

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

forgottenPasswordInformation

A complex element that has up to four Question/Answer pairs for forgotten password information.

forgottenPasswordAnswer1 string

The answer to the first forgotten password challenge question.

forgottenPasswordAnswer2 string

The answer to the second forgotten password challenge question.

forgottenPasswordAnswer3 string

The answer to the third forgotten password challenge question.

forgottenPasswordAnswer4 string

The answer to the fourth forgotten password challenge question.

forgottenPasswordQuestion1 string

The first challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion2 string

The second challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion3 string

The third challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion4 string

The fourth challenge question presented to a user who has forgotten their password.

userPasswordInformation

currentPassword string

The user's current password to be changed.

email string

The user's email address for the associated account.

forgottenPasswordInfo forgottenPasswordInformation

A complex element that has up to four Question/Answer pairs for forgotten password information.

newPassword string

The user's new password.

Examples

Generic JSON Request

Request

{
"email": "sample string 1",
"currentPassword": "sample string 2",
"newPassword": "sample string 3",
"forgottenPasswordInfo": {
"forgottenPasswordQuestion1": "sample string 1",
"forgottenPasswordAnswer1": "sample string 2",
"forgottenPasswordQuestion2": "sample string 3",
"forgottenPasswordAnswer2": "sample string 4",
"forgottenPasswordQuestion3": "sample string 5",
"forgottenPasswordAnswer3": "sample string 6",
"forgottenPasswordQuestion4": "sample string 7",
"forgottenPasswordAnswer4": "sample string 8"
}
}

Generic XML Request

Request

<userPasswordInformation 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<currentPassword>sample string 2</currentPassword>
<email>sample string 1</email>
<forgottenPasswordInfo>
<forgottenPasswordAnswer1>sample string 2</forgottenPasswordAnswer1>
<forgottenPasswordAnswer2>sample string 4</forgottenPasswordAnswer2>
<forgottenPasswordAnswer3>sample string 6</forgottenPasswordAnswer3>
<forgottenPasswordAnswer4>sample string 8</forgottenPasswordAnswer4>
<forgottenPasswordQuestion1>sample string 1</forgottenPasswordQuestion1>
<forgottenPasswordQuestion2>sample string 3</forgottenPasswordQuestion2>
<forgottenPasswordQuestion3>sample string 5</forgottenPasswordQuestion3>
<forgottenPasswordQuestion4>sample string 7</forgottenPasswordQuestion4>
</forgottenPasswordInfo>
<newPassword>sample string 3</newPassword>
</userPasswordInformation>