EPISHIP API Impersonation overview

EPISHIP Impersonation API icon 32px svg

Overview

The EPISHIP Impersonation API enables administrators to securely assume the identity of other users within the system. You can develop tools that facilitate support troubleshooting, user verification, and administrative actions by temporarily acting as another user without requiring their credentials.

View Doc →

The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Impersonation services.

EPISHIP Impersonation API diagram

Figure 1. EPISHIP API relationship diagram. Impersonation session initiation and termination flow.

EPISHIP App

EPISHIP’s administrative interface leverages impersonation to allow support staff to “see what the user sees.” This capability is critical for diagnosing permission issues, validating user-specific configurations, and providing hands-on assistance.

EPISHIP API

The REST API that manages the lifecycle of an impersonation session. It handles the secure switching of user contexts and the restoration of the original administrator session upon completion.

Authentication

Strictly controlled via Bearer tokens. Only users with specific administrative privileges can initiate impersonation requests. The system logs all actions taken during an impersonation session for security auditing.

Session Management

A mechanism that temporarily overrides the current user’s identity with that of the target `userId`. This session remains active until an explicit “leave” command is issued, which redirects the administrator back to their original context.

What can users do with the EPISHIP Impersonation API?

Users can use the EPISHIP Impersonation API to perform common workflows, such as:

  • Initiate an impersonation session for a specific target user ID
  • Perform actions on behalf of the impersonated user for testing or support
  • Terminate the impersonation session securely
  • Redirect automatically to the admin dashboard upon leaving a session

Impersonation properties and parameters available through the EPISHIP Impersonation API:

  • Target User ID (userId)
  • Redirect Home Flag (redirect_home)

Additional info

  • Learn more about developing with EPISHIP Impersonation API, including handling authentication, authorization, reference the Develop on EPISHIP API for your workspace. More
  • Learn more about how to launch and run an EPISHIP Impersonation API app, read the Developer Page. More →

Related

Related Categories