POST api/v8/Security/ResetPassword

Change the current user password based on provided user-name and password within an organization context. The tenant name is optional which can be set in the "nep-organization" header.

Request Information

URI Parameters

None.

Body Parameters

A reset password request containing the orgName, username, old password and the new password.

Reset Password Request
NameDescriptionTypeRequired?Additional information
newPassword *

New Password

 string

Yes

None.
orgName *

Organization Name

 string

Yes

None.
userName *

User Name

 string

Yes

None.
password *

Password

 string

Yes

None.
appKey

AppKey. The application that is requesting for the authentication (i.e. POS, EOM, ETS). This field is optional and only works on V8 and up.

 string

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "newPassword": "sample string 1",
  "orgName": "sample string 2",
  "userName": "sample string 3",
  "password": "sample string 4",
  "appKey": "sample string 5"
}

application/xml, text/xml

Sample: 
<ResetPasswordRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <orgName>sample string 2</orgName>
  <userName>sample string 3</userName>
  <password>sample string 4</password>
  <appKey>sample string 5</appKey>
  <newPassword>sample string 1</newPassword>
</ResetPasswordRequest>

Response Information

Resource Description

HTTP Response. Status Code '200' means that the user password is successfully changed.

HttpResponseMessage
NameDescriptionType
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of Object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean