Development Guides

Advisor Portal Prospect (Element) SSO & iFrame

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

EnvironmentBaseUrl
Developmenthttps://dev.orionelement.com/web/#/login
Stagehttps://stage.orionelement.com/web/#/login
Productionhttps://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

ParameterAccepted ValuesDetails
element_tokenSee Authentication PageYour element token from your authentication call
routeUrl/rep/proposalEnforces 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

ParameterAccepted ValuesExampleDetails
householdIdany integerhttps://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&householdId=1Continues the specified prospect.
modeiframehttps://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&mode=iframeRemoves non-essential formatting surrounding the prospect experience
integrationAppRedtail or AdviceWorkshttps://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&integrationApp=RedtailSpecifies which integration to use when creating a new prospect
externalTokenany stringhttps://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&integrationApp=Redtail&externalToken=MyTokenMust be used in conjunction with the integrationApp parameter, specifies the authentication to use for the specified integration
crmIdany stringhttps://dev.orionelement.com/web/#/login?element_token=MyToken&routeUrl=/rep/proposal&integrationApp=Redtail&crmId=1Must be used in conjunction with the integrationApp parameter, specifies the integration client Id to use for the specified integration