POST api/delegates/{delegateId}/ChangePassword
Changes a delegate user's password. Requires the user's current password.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| delegateId |
The delegate's ID. |
integer |
Required |
Body Parameters
Contains the delegate's old password, and the value that they're trying to set it to.
ChangePasswordRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| OldPassword |
The current password |
string |
None. |
| NewPassword |
The password to change to |
string |
None. |
| ConfirmPassword |
The confirmed password |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"oldPassword": "sample string 1",
"newPassword": "sample string 2",
"confirmPassword": "sample string 3"
}
application/xml, text/xml
Sample:
<ChangePasswordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources"> <ConfirmPassword>sample string 3</ConfirmPassword> <NewPassword>sample string 2</NewPassword> <OldPassword>sample string 1</OldPassword> </ChangePasswordRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns the result of the change operation.
ChangePasswordResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Result |
A code identifying the result of the password change request |
ChangePasswordResultCode |
None. |
| PasswordRuleValidationResults |
The list of rule violations |
Collection of PasswordRuleValidationResult |
None. |
| LogMessage |
An UNLOCALIZED error message. Use for logging, but not from the UI. |
string |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.