Versions Compared

Key

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

...

Code Block
languagec#
title Method
        AuthServerU2FResponseAuthServerU2FResponseSendPush SendPushMessage(string authServerPartnerLoginName, 
                     string authServerPartnerLoginPassword, 
                     string authServerPartnerUserLoginName, 
                     string printedSerialNumber, 
                     short deliveryMethod
                     string appName,
                     string accountName,
                     string reason,
                     string relyingParty);

...

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 Id is the PartnerId.

Normally you do not need to specify this parameter.  


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


Code Block
languagec#
titleSample WCF C# Repsonse
if (resp.ErrorCode != 0)  {             
    message.Text = resp.ErrorMsg;       
    return false; 
}
// save resp.AuthnUserReqId. This will be used to authenticate a user after // they have been authenticated via push 


REST


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 PartnerId.


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"
}


Code Block
languagejs
titleSample REST/Json Response
 {
  "errorCode": 0,
  "errorMessage": "OK",
  "type": "send_push_message", 
  "authnUserReqId" : "3e^n(R1jk345sdfhgn"
}


// save authnUserReqId. This will be used to authenticate a user after // they have been authenticated via push