Skip to main content
GET
/
api
/
auth
/
impersonate
/
{userId}
Get impersonation credentials for a user
curl --request GET \
  --url https://your-instance.example.com/api/auth/impersonate/{userId} \
  --header 'Authorization: Bearer <token>'
{
  "email": "sam.patel@acme.example",
  "impersonationToken": "imp_5f7b1c2e8a1d4e0012c3b4a5e6f7a8b9c0d1e2f3a4b5c6d7e8",
  "fullName": "Sam Patel",
  "originalAdmin": {
    "id": "5f7b1c2e8a1d4e0012c3b4a5",
    "email": "admin@acme.example",
    "fullName": "Acme Admin",
    "organizationId": "5f7b1c2e8a1d4e0012c3b4a5",
    "accessRole": "ADMIN",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Zjdi..."
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
userId
string
required

Response

Impersonation credentials returned

​
email
string<email>
required
​
impersonationToken
string
required
​
fullName
string
​
originalAdmin
object

Original admin payload returned alongside an impersonation token so the SPA can later restore the admin session via /api/auth/exit-impersonation.

Example:
{
  "id": "5f7b1c2e8a1d4e0012c3b4a5",
  "email": "admin@acme.example",
  "fullName": "Acme Admin",
  "organizationId": "5f7b1c2e8a1d4e0012c3b4a5",
  "accessRole": "ADMIN",
  "conversationOpenPreference": "split",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Zjdi..."
}