POST api/v1/Authentication/RequestPasswordReset?suppressResponseCodes={suppressResponseCodes}&APIKey={APIKey}&APIToken={APIToken}

Sends a password reset request to the provided user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
suppressResponseCodes

Some applications do wonky things if error codes are used. Use this to force 200s to always return.

 boolean

None.
APIKey

This is your unique key that identifies you as the developer of this app. Required for all calls.

 string

None.
APIToken

This is the user's session token generated when you authenticate the user

 string

None.

Body Parameters

The username of the user to reset

PasswordResetRequest
NameDescriptionTypeAdditional information
LoginName

The login name of the user who needs the password reset.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "LoginName": "sample string 1"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Sends an email to the specified user

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.