Send Password Recovery
WCF
Method
public AuthServerResponse SendPasswordRecovery(string authServerPartnerLoginName,
string authServerPartnerLoginPassword)
WCF parameter | data type | description |
|---|---|---|
authServerPartnerLoginName | string | SurePassID account login name |
authServerPartnerLoginPassword | string | SurePassID account login key |
authServerPartnerLoginPassword | string | Username to send recovery password |
Sample WCF C# Method
AuthServerResponseresp = SendPasswordRecovery("accountLogin",
"accountKey",
"Mandy"
);Sample WCF C# Repsonse
if (resp.ErrorCode != 0) {
message.Text = resp.ErrorMsg;
return false;
}REST
REST parameter | data type | description |
|---|---|---|
spAccountLoginName | string | SurePassID account login name |
spAccountLoginKey | string | SurePassID account login key |
string | Users email that needs password recovery | |
type | string | send_password_recovery |
fromEmailName | string | Name of sender of password recovery email |
fromEmailAddress | string | Address of sender of password recovery email |
emailSubject | string | Subject of password recovery email |
emailBody | string | Body of password recovery email |
html | boolean | Whether password recovery email is HTML formatted |
Sample REST/Json Request
{
"username": "{{username}}",
"spAccountLoginName": "{{spAccountLoginName}}",
"spAccountLoginKey": "{{spAccountLoginKey}}",
"type": "send_password_recovery",
"email": "Mandy@yourco.com",
"fromEmailName": "John Denver",
"fromEmailAddress": "john.denver@example.com",
"emailSubject": "Resetting your password",
"emailBody": "Let us help you reset your password.",
"html": 1
}Sample REST/Json Response
{
"errorCode": 0,
"errorMessage": "OK",
"type": "send_password_recovery"
}