How to send PUSH notifications on Symantec VIP app using an Rest API

[Rahul]

Hello all,

I have a use case where our HelpDesk needs to send push notifications with accept/reject options to validate user identities on demand. Could anyone provide documentation or examples on how to achieve this?

Thanks in Advance

[haro]

Hi,

Basically you need to program your self simple authentication service.
Check out following documentations and needed interface definition files from your VIP Manager.

• About VIP User Services 
• About VIP Access Push
• Symantec VIP User Services Developer's Guide (PDF)
• Download "VIP_UserServicesWSDL.zip" file from your VIP Manager's [Accounts] > [Download Files] > [Web_Services_API] page

Hope this helps.

[Andreas Horlacher]

In addition to Haro's recommendation to utilize the VIP Web Service APIs to build an application, your team can utilize the VIP test portal. The helpdesk enters the VIP Credential ID into the portal and observes when the PUSH is accepted: 

------------------------------
Kind regard,
Andreas
------------------------------

[Rahul]

This is exactly what we want to do but we want to do this using API's. Is there any easier way to do this using API's. API documentation is little confusing and involves lot of steps/configurations on both sides VIP (Source) and (Target) platforms.  

One other question, is there a link that directly takes us to TEST screen instead of clicking "TEST" button.

Thanks in Advance.

[Maren Peasley]

Hi Rahul,

Via API will require a few minutes of setup, but these videos summarize the work needed:

https://www.youtube.com/playlist?list=PL2eggx_qRWrTvPoVxFPBTep_pWJ21h8XZ

The API needed is authenticateUserWithPush (so you need to have the user name).  Example from my environment looks like this:

That makes the Push on the device look like this:

To pick up the response, we need pollPushStatus():

Does that help?

[Rahul]

Thanks a lot , This gave a more detail picture.

Is it safe to assume we don't have REST based API?

and also does it support any other authentication type other than certification based authentication?

appreciate all the help. 

[Maren Peasley]

No problem!

No REST-based PUSH at the moment.  Cert-based authN only at the moment.  If you are interested in REST-based PUSH or code-based authN (or any other product enhancement), please open a support case to request these so that we can track them.

[Rahul]

One last question, What does this error mean?

<?xml version='1.0' encoding='UTF-8'?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"><S:Body><AuthenticateUserWithPushResponse xmlns="https://schemas.symantec.com/vip/2011/04/vipuserservices"><requestId>e928c04f47235910bc6c6e32736d43c5</requestId><status>600B</status><statusMessage>Schema validation failed. (Error encountered during schema validation.  Invalid element pin, otp, or temporaryPassword value.)</statusMessage></AuthenticateUserWithPushResponse></S:Body></S:Envelope>

I found this link , but I was sending RequestID within specified requirements example "abc123" 

Schema error 600B when RequestID in Symantec VIP Web Service API call is less than 4 or more than 40 characters

Broadcom		remove preview
Schema error 600B when RequestID in Symantec VIP Web Service API call is less than 4 or more than 40 characters Issue/Introduction Schema error 600B when RequestID in Symantec VIP Web Service API call is greater than 40 characters or less than 4 characters. Sample error in the response: 600B Schema validation failed. (Error encountered during schema validation.) The RequestID parameter can be between 4 and 40 characters. View this on Broadcom >

[Maren Peasley]

Hi Rahul,

Can you try the requestId with more characters?  Schema validations generally mean the system didn't like something about the syntax: Values, elements, missing characters, etc.

Also, can you provide the request with the associated response?

Thank you!

[Rahul]

See here I used 32 characters but still I got the same response

<?xml version='1.0' encoding='UTF-8'?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"><S:Body><AuthenticateUserWithPushResponse xmlns="https://schemas.symantec.com/vip/2011/04/vipuserservices"><requestId>e928c04f47235910bc6c6e32736d43c5</requestId><status>600B</status><statusMessage>Schema validation failed. (Error encountered during schema validation.  Invalid element pin, otp, or temporaryPassword value.)</statusMessage></AuthenticateUserWithPushResponse></S:Body></S:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:vip="https://schemas.symantec.com/vip/2011/04/vipuserservices">
   <soapenv:Header/>
   <soapenv:Body>
      <vip:AuthenticateUserWithPushRequest>
         <vip:requestId>e928c04f47235910bc6c6e32736d43c5</vip:requestId>
         <!--Optional:-->
         <vip:onBehalfOfAccountId></vip:onBehalfOfAccountId>
         <vip:userId>xxxxx.yyyyy</vip:userId>
         <!--Optional:-->
         <vip:pin></vip:pin>
         <vip:pushAuthData>
            <!--0 to 20 repetitions:-->
            <vip:displayParameters>
               <vip:Key></vip:Key>
               <vip:Value></vip:Value>
            </vip:displayParameters>
            <!--0 to 20 repetitions:-->
            <vip:encryptedDisplayParameters>
               <vip:key></vip:key>
               <vip:cipherData></vip:cipherData>
               <vip:pubkeyHash></vip:pubkeyHash>
               <vip:algName></vip:algName>
               <!--Optional:-->
               <vip:nonce></vip:nonce>
            </vip:encryptedDisplayParameters>
            <!--0 to 20 repetitions:-->
            <vip:requestParameters>
               <vip:Key></vip:Key>
               <vip:Value></vip:Value>
            </vip:requestParameters>
         </vip:pushAuthData>
         <!--Optional:-->
         <vip:authContext>
            <!--0 to 20 repetitions:-->
            <vip:params>
               <vip:Key></vip:Key>
               <vip:Value></vip:Value>
            </vip:params>
         </vip:authContext>
      </vip:AuthenticateUserWithPushRequest>
   </soapenv:Body>
</soapenv:Envelope>

[Maren Peasley]

Try this:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:vip="https://schemas.symantec.com/vip/2011/04/vipuserservices">
   <soapenv:Header/>
   <soapenv:Body>
      <vip:AuthenticateUserWithPushRequest>
         <vip:requestId>e928c04f47235910bc6c6e32736d43c5</vip:requestId>
         <vip:userId>xxxxx.yyyyy</vip:userId>
         <vip:pushAuthData>
            <vip:displayParameters>
               <vip:Key>display.message.text</vip:Key>
               <vip:Value>Sample</vip:Value>
            </vip:displayParameters>
         </vip:pushAuthData>
      </vip:AuthenticateUserWithPushRequest>
   </soapenv:Body>
</soapenv:Envelope>

[Rahul]

This one worked , Thank You !

[Maren Peasley]

You're welcome!  Glad it's working ok.

[Rahul]

I am back with one more question,  When I am calling pollPushStatus method , it is returning incorrect <authnTime>. Do I have to send any other parameter to get the correct <authnTime>

<authnTime>1970-01-01T00:00:00.000Z</authnTime>

[Namish Tiwari]

Currently authnTime is defaulting to unix epoch time and not the time when Push auth is performed which seems an issue and will be looked at by the VIP Eng team. Currently we do not have any ETA to share but should be done at some point in future. Let us know if any questions.

Thanks

Namish