Authentication: updatePassword

Updates the password for a specified user.

Request

HTTP request

PUT /v2/login_information/{loginPart}

Parameters

Parameter NameValueDescription
Path Parameters
loginPartstring

Currently, only the value password is supported.

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Authentication::updatePassword

Definitions

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

forgottenPasswordInformation

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

forgottenPasswordAnswer1string

The answer to the first forgotten password challenge question.

forgottenPasswordAnswer2string

The answer to the second forgotten password challenge question.

forgottenPasswordAnswer3string

The answer to the third forgotten password challenge question.

forgottenPasswordAnswer4string

The answer to the fourth forgotten password challenge question.

forgottenPasswordQuestion1string

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

forgottenPasswordQuestion2string

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

forgottenPasswordQuestion3string

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

forgottenPasswordQuestion4string

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

userPasswordInformation

currentPasswordstring

The user's current password to be changed.

emailstring

The user's email address for the associated account.

forgottenPasswordInfoforgottenPasswordInformation

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

newPasswordstring

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> 
}} />