Purpose: This Article will provide steps on how to SSO to specific pages within Advisor Portal.
Simple Use Case: You would like users to land on commonly used pages when they SSO, such as a specific prospect.
Scope and Outputs: How to implement contextual SSO or iFraming for Advisor Portal.
Process Overview: After retrieving the Advisor Portal token (https://developers.orionadvisor.com/guides/generating-an-advisor-portal-element-token/) provide the routeUrl to authenticate to a specific page in Advisor Portal.
Process Steps:
You can directly navigate to a specific Element household by utilizing the Single Sign on and/or iFrame endpoints. There are a variety of query parameters that allow you to pass specific details via a GET request to directly navigate to your specific household, even if you’re starting a new household via an integration.
Environment Base Urls
Environment | BaseUrl |
---|---|
Development | https://dev.orionelement.com/web/#/login |
Stage | https://stage.orionelement.com/web/#/login |
Production | https://www.orionelement.com/web/#/login |
Required Parameters
The following parameters are required, and must be supplied for each call. If only these parameters are supplied, you will be routed to a brand new Prospect
Parameter | Accepted Values | Details |
---|---|---|
element_token | See Authentication Page | Your element token from your authentication call |
routeUrl | /rep/proposal | Enforces navigation to the Prospect |
Example :
An example of navigating to a new prospect in the SSO or iFrame experience
https://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal
Optional Parameters
The following parameters are required, and must be supplied for each call. If only these parameters are supplied, you will be routed to a brand new Prospect
Parameter | Accepted Values | Example | Details |
---|---|---|---|
householdId | any integer | https://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&householdId=1 | Continues the specified prospect. |
mode | iframe | https://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&mode=iframe | Removes non-essential formatting surrounding the prospect experience |
integrationApp | Redtail or AdviceWorks | https://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&integrationApp=Redtail | Specifies which integration to use when creating a new prospect |
externalToken | any string | https://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&integrationApp=Redtail&externalToken=MyToken | Must be used in conjunction with the integrationApp parameter, specifies the authentication to use for the specified integration |
crmId | any string | https://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&integrationApp=Redtail&crmId=1 | Must be used in conjunction with the integrationApp parameter, specifies the integration client Id to use for the specified integration |