Versions Compared

Key

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

...

WCF parameterdata typedescription
authServerPartnerLoginNamestringSurePassId SurePassID account login name
authServerPartnerLoginPasswordstringSurePassId SurePassID account login key
authServerPartnerUserLoginNamestringUser account login name
printedSerialNumberstring

A specific device assigned to this user. If this is left empty then the first device assigned

deliveryMethodshortHow to deliver the push message to the user. 0=sms, 1=SurePass App, 2=SurePass mobile U2F
appNamestringApplication that is requesting access. This will be displayed to the user in the push message. For example Windows Login, Payment Verification, etc.
accountNamestringAccount requesting access. This will be displayed to the user in the push message. For example. Mark, John553, jack123@aol.com, etc.
reasonstringReason for access. This will be displayed to the user in the push message. eg. Login, Payment Verification, etc.
relyingPartystring

Override the default relying party.  The URI of the requesting party.
The query string Id= is required. the The Id is the PartnerUserId.PartnerId.

Normally you do not need to specify this parameter.  


Code Block
languagec#
titleSample WCF C# Method
 AuthServerU2FResponseSendPush resp = SendPushMessage("accountLogin",
                     "accountKey", 
                     "Mandy, 
                     "", 
                     0,
                     "Windows",                     
                     "Mandy2",
                     "Login",
                     "https://verification,yourco.com?Id=0");

...

REST parameterdata typedescription
spAccountLoginNamestringSurePassId SurePassID account login name
spAccountLoginKeystringSurePassId SurePassID account login key
usernamestringuser account login name
typestringsend_push_message
printedSerialNumberstring

A specific device assigned to this user. If this is left empty then the first device assigned

device is used 

deliveryMethodstringHow to deliver the push message to the user. pushsmsquestion, pushapp, pushappu2f
appNamestringApplication that is requesting access. This will be displayed to the user in the push message. For example Windows Login, Payment Verification, etc.
accountNamestringAccount requesting access. This will be displayed to the user in the push message. For example. Mark,  jackfake123@phoney.com, etc.
reasonstringReason for access. This will be displayed to the user in the push message. For example. Login, Payment Verification, etc.
relyingPartystringThe URI of the requesting party.

The query string Id= is required. the Id is the PartnerUserIdPartnerId.


Code Block
languagejs
titleSample REST/Json Method
{
  "username": "Mandy",
  "spAccountLoginName": "accountLogin",
  "spAccountLoginKey": "accountKey",
  "type": "send_push_message",
  "deliveryMethod": "sms",
  "appName" : "Windows",                                          
  "authnAccount" : "Mandy2",
  "authnReason" : "Login",
  "relyingPartyUrl" : "https://verification,yourco.com?Id=0"
}

...