Administrator impersonation

Last update:
Aug 21, 2026
Note: This API is only provided for impersonation use cases, initiated by the portal administrator / SuperUser. This API must not be used for user-initiated Inbound SSO use cases.
  • Portal Admin user login into a portal's admin website and impersonates HSID user to recreate the user's experience.
  • Portal Backend applications call HSID Aikyam Impersonation API (Headless SSO API) endpoint through Aikyam Service Gateway, handles the response (receiving assertion), then Portal UI redirects to Aikyam SSO V2 endpoint with assertion.
  • The new API to call is https://nonprod.identity.healthsafe-id.com/api/rest/headless/sso. Similar to the existing API, this API also requires an access token to be passed in as Authorization header, which can be retrieved below.
  • This flow does not support HSID account creation, as the administrator is supposed to impersonate the existing HSID account holder.
Related information
HSID EDA portal implementation guide
Get Access TokenAikyam impersonation API callRedirection from Portal
Previous: 1-hop: External vendor – PingFederate interaction
Next: Get Access Token

On this page

Powered by Aikyam @2025 All rights reserved

Solutions

B2B Solution
B2C Solution
Admin Solution

Developer

Explore
Integrate
Scale

Resources

Documentation

Support

Partner Support
+1 866 451 2735
hsid_support@aikyam.com

Member Support
+1 855 819 5909
optumsupport@optum.com