POST api/UpdateLogin

Updates the users login and password. Result object indicates if notification email was sent.

Request Information

URI Parameters

None.

Body Parameters

UpdateLoginRequest
NameDescriptionTypeAdditional information
SessionKey

string

Required

UserName

string

Required

NewUserName

string

Required

CurrentPassword

string

Required

NewPassword

string

Required

SendEmail

Pass true to send a confirmation email

boolean

Required

Request Formats

application/json, text/json

Sample:
{
  "SessionKey": "sample string 1",
  "UserName": "sample string 2",
  "NewUserName": "sample string 3",
  "CurrentPassword": "sample string 4",
  "NewPassword": "sample string 5",
  "SendEmail": true
}

application/xml, text/xml

Sample:
<UpdateLoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account">
  <CurrentPassword>sample string 4</CurrentPassword>
  <NewPassword>sample string 5</NewPassword>
  <NewUserName>sample string 3</NewUserName>
  <SendEmail>true</SendEmail>
  <SessionKey>sample string 1</SessionKey>
  <UserName>sample string 2</UserName>
</UpdateLoginRequest>

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 'UpdateLoginRequest'.

Response Information

Resource Description

UpdateLoginResult object

ApiSuccessOfUpdateLoginResult
NameDescriptionTypeAdditional information
Success

boolean
Data

UpdateLoginResult

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "EmailSent": true
  }
}

application/xml, text/xml

Sample:
<ApiSuccessOfUpdateLoginResultgLC8bFpX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account">
    <d2p1:EmailSent>true</d2p1:EmailSent>
  </Data>
</ApiSuccessOfUpdateLoginResultgLC8bFpX>