PUT api/account/reset

V1 - Confirms the reset of a users password by validating the pregenerated confirmationcode.

Request Information

URI Parameters

None.

Body Parameters

UserResetConfirmation
NameDescriptionTypeAdditional information
UserID

The UserID is for the account that needs to be confirmed.

globally unique identifier

Required
ConfirmationCode

The confirmationcode which was supplied at the reset request.

string

Required
Password

The users new password. This needs to meet complexity criteria.

  • At least one lowercase letter
  • At least one uppercase letter
  • At least one digit
  • At least one non-alphanumeric character
  • A minimum of six characters

 string

Required

Data type: Password

String length: inclusive between 6 and 100

Request Formats

application/json, text/json

Sample: 
{
  "UserID": "c5fb390b-6cbc-4cca-bb83-bbf443b9e441",
  "ConfirmationCode": "sample string 2",
  "Password": "sample string 3"
}

text/javascript

Sample: 
{"UserID":"c5fb390b-6cbc-4cca-bb83-bbf443b9e441","ConfirmationCode":"sample string 2","Password":"sample string 3"}

application/xml, text/xml

Sample: 
<UserResetConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VersionedVendorApi.Models">
  <ConfirmationCode>sample string 2</ConfirmationCode>
  <Password>sample string 3</Password>
  <UserID>c5fb390b-6cbc-4cca-bb83-bbf443b9e441</UserID>
</UserResetConfirmation>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserResetConfirmation'.

Response Information

Resource Description

RegistrationResult
NameDescriptionTypeAdditional information
UserID

The UserID is created when the registration is completed.

string

None.
Email

The registered email address.

string

Data type: EmailAddress
Username

The registered username.

string

Data type: Text
ConfirmationCode

A generated code that needs to be provided to confirm the newly created user account.

string

Data type: Text
Status

YindoApiStatus defines statuscodes.

YindoApiStatus

None.

Response Formats

application/json, text/json

Sample: 
{
  "UserID": "sample string 1",
  "Email": "sample string 2",
  "Username": "sample string 3",
  "ConfirmationCode": "sample string 4",
  "Status": {
    "Code": 0,
    "Text": "sample string 1"
  }
}

text/javascript

Sample: 
{"UserID":"sample string 1","Email":"sample string 2","Username":"sample string 3","ConfirmationCode":"sample string 4","Status":{"Code":0,"Text":"sample string 1"}}

application/xml, text/xml

Sample: 
<RegistrationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VersionedVendorApi.Models">
  <Status xmlns="http://schemas.datacontract.org/2004/07/Yindo.BLL.API">
    <Code>Success</Code>
    <Text>sample string 1</Text>
  </Status>
  <ConfirmationCode>sample string 4</ConfirmationCode>
  <Email>sample string 2</Email>
  <UserID>sample string 1</UserID>
  <Username>sample string 3</Username>
</RegistrationResult>