POST api/delegates/{delegateId}/AnonymousChangePassword

Changes a delegate user's password without requiring their old password, or requiring them to be logged in.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
delegateId

The delegate's ID.

integer

Required

Body Parameters

The details required to change the client's password.

AnonymousChangePasswordRequest
NameDescriptionTypeAdditional information
Password

Gets or sets the value to reset the client's password to.

string

None.

ConfirmPassword

Gets or sets the re-typed password used to confirm their password choice.

string

None.

IsPasswordResetRequest

Gets or sets if the user's password change represents a request to reset their password.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "password": "sample string 1",
  "confirmPassword": "sample string 2",
  "isPasswordResetRequest": true
}

application/xml, text/xml

Sample:
<AnonymousChangePasswordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <ConfirmPassword>sample string 2</ConfirmPassword>
  <IsPasswordResetRequest>true</IsPasswordResetRequest>
  <Password>sample string 1</Password>
</AnonymousChangePasswordRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the result of the reset operation.

ChangePasswordResult
NameDescriptionTypeAdditional 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.