To determine whether to show impersonator.jsp or impersonatee.jsp for a specific authenticated session, you must build logic into your custom web pages. Use the following information to build the menu options in the web pages for impersonation.
The default user portal uses an Identity Server endpoint to determine which impersonation-related menu items to display for a particular end-user session. The endpoint is located in https://NIDP-hostname:port/nidp/portal/uiIcons.xml.
When you send an HTTP GET request to that endpoint from an authenticated session, it returns XML similar to the following:
<UIIcons> <UIIcon altText="Help Desk Session..." linkTarget="_top" tags="LANDING_PAGE|width=425|type=dialog|height=300" title="Help Desk Session..." url="nidp/jsp/impersonatee.jsp"/> <UIIcon altText="Start Help Desk Session..." linkTarget="_top" tags="LANDING_PAGE|width=425|type=dialog|height=300" title="Start Help Desk Session..." url="nidp/jsp/impersonator.jsp"/> </UIIcons>
Within the UIIcons element, there are zero, one, or two child elements named UIIcon. The title attribute on those elements is one of the following three strings (if the user's locale is English):
End Help Desk Session
When this element is available, the default user portal displays a menu item with the same name. When a user selects this menu item, it ends impersonation by calling https://NIDP-hostname:port/nidp/app/ilogout.
NOTE:impersonator.jsp includes a way to end a current impersonation session. You do not need to check or act on this element if you have implemented this in impersonator.jsp.
This element is available only if the Impersonation feature is enabled in Administration Console, and the currently authenticated session is an active impersonation session.
When this element is available, other two elements, Start Help Desk Session and Help Desk Session are not available.
Start Help Desk Session
When this element is available, the default User Portal displays a menu item with the same name. When a user selects this menu item, the User Portal loads impersonator.jsp in an iFrame.
This element is only available if the Impersonation feature is enabled in Administration Console, currently authenticated session is not an active impersonation session, and currently authenticated user has a help desk role (as configured in the Impersonation feature in Administration Console).
When this element is available, the Help Desk Session element is also available.
Help Desk Session
When this element is available, the default user portal displays a menu item with the same name. When a user selects the menu item, user portal loads impersonatee.jsp in an iFrame.
This element is available only if the Impersonation feature is enabled in Administration Console, and the currently authenticated session is not an active impersonation session.
When this element is available, the Start Help Desk Session element might also be available, if the currently authenticated user has a help desk role (as configured in the Impersonation feature in Administration Console).