Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

WCF


Code Block
languagec#
title Method
public AuthServerResponse SendPasswordRecovery(string authServerPartnerLoginName,
		string authServerPartnerLoginPassword,
		string pw,
		string rid,
		string mid,
		string fromEmailName,
		string fromEmailAddress,
		string emailSubject,
		string emailBody,
		boolean html)

...

WCF parameterdata typedescription
authServerPartnerLoginNamestringSurePassId account login name
authServerPartnerLoginPasswordstringSurePassId account login key
pwstringUser account password
ridstringridSystem generated value, contained in reset password url
midstringmidSystem generated value, contained in reset password url
fromEmailNamestringName for sender of password recovery email
fromEmailAddressstringEmail address for sender of password recovery email
emailSubjectstringSubject of password recovery email
emailBodystringBody of password recovery email
htmlbooleanBoolean indicating if email is HTML formatted

...

Code Block
languagec#
titleSample WCF C# Method
AuthServerResponseresp = SendPasswordRecovery("accountLogin",
            "accountKey",
			"tinyD4nc3r",
	        "{rid}",
			"{mid}",
            "Mandy",
            "mandy@example.com",
            "Recover Password", 
			"Let us help you recover your password.",
            false);

...

REST parameterdata typedescription
spAccountLoginNamestringSurePassId account login name
spAccountLoginKeystringSurePassId account login key
usernamestringuser account login name
typestringsend_password_recovery
pwstringUser account password
ridstringridSystem generated value, contained in reset password url
midstringmidSystem generated value, contained in reset password url
fromEmailNamestringName of sender of password recovery email
fromEmailAddressstringAddress of sender of password recovery email
emailSubjectstringSubject of password recovery email
emailBodystring

Body of password recovery email

htmlbooleanWhether password recovery email is HTML formatted

...

Code Block
languagejs
titleSample REST/Json Request
{
 "username": "{{username}}",
 "spAccountLoginName": "{{spAccountLoginName}}",
 "spAccountLoginKey": "{{spAccountLoginKey}}",
 "type": "send_password_recovery",
 "pw": "tinyD4nc3r",
 "rid": "{rid}",
 "mid": "{mid}",
 "fromEmailName": "John Denver",
 "fromEmailAddress": "john.denver@example.com",
 "emailSubject": "Resetting your password",
 "emailBody": "Let us help you reset your password.",
 "html": 1
}

...

Code Block
languagejs
titleSample REST/Json Response
 {  
  "errorCode": 0,
  "errorMessage": "OK",
  "type": "send_password_recovery_change_password"
  }