Send Push Message

WCF

Method

        AuthServerU2FResponseSendPush SendPushMessage(string authServerPartnerLoginName, 
                     string authServerPartnerLoginPassword, 
                     string authServerPartnerUserLoginName, 
                     string printedSerialNumber, 
                     short deliveryMethod
                     string appName,
                     string accountName,
                     string reason,
                     string relyingParty);

WCF parameter	data type	description
authServerPartnerLoginName	string	SurePassID account login name
authServerPartnerLoginPassword	string	SurePassID account login key
authServerPartnerUserLoginName	string	User account login name
printedSerialNumber	string	A specific device assigned to this user. If this is left empty then the first device assigned
deliveryMethod	short	How to deliver the push message to the user. 0=sms, 1=SurePass App, 2=SurePass mobile U2F
appName	string	Application that is requesting access. This will be displayed to the user in the push message. For example Windows Login, Payment Verification, etc.
accountName	string	Account requesting access. This will be displayed to the user in the push message. For example. Mark, John553, jack123@aol.com, etc.
reason	string	Reason for access. This will be displayed to the user in the push message. eg. Login, Payment Verification, etc.
relyingParty	string	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.

Sample WCF C# Method

 AuthServerU2FResponseSendPush resp = SendPushMessage("accountLogin",
                     "accountKey", 
                     "Mandy, 
                     "", 
                     0,
                     "Windows",                     
                     "Mandy2",
                     "Login",
                     "https://verification,yourco.com?Id=0");

Sample 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 parameter	data type	description
spAccountLoginName	string	SurePassID account login name
spAccountLoginKey	string	SurePassID account login key
username	string	user account login name
type	string	send_push_message
printedSerialNumber	string	A specific device assigned to this user. If this is left empty then the first device assigned device is used
deliveryMethod	string	How to deliver the push message to the user. pushsmsquestion, pushapp, pushappu2f
appName	string	Application that is requesting access. This will be displayed to the user in the push message. For example Windows Login, Payment Verification, etc.
accountName	string	Account requesting access. This will be displayed to the user in the push message. For example. Mark, jackfake123@phoney.com, etc.
reason	string	Reason for access. This will be displayed to the user in the push message. For example. Login, Payment Verification, etc.
relyingParty	string	The URI of the requesting party. The query string Id= is required. the Id is the PartnerId.

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

Sample 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