users_sessions_impersonate

Tool

users_sessions_impersonate

Start an impersonated session as one user of this product — support access, hard-capped.

Start an impersonated session as one user of this product — support access, hard-capped. Returns an access token that expires within 30 minutes and CANNOT be refreshed; there is no refresh token. While it is in use, every credential, factor, identifier and session mutation is refused, the user is emailed (unless the product turned that notice off), and the whole thing is recorded in the audit trail against you. Give a real reason: it goes into the audit row and into that email.

Behavior

HTTP: POST /users/sessions/impersonate

Arguments

Name	Type	Required	Description
reason	string	•	Why. Recorded in the audit trail and shown to the user in the notification email — write what you would want to read in an incident review (a ticket number and one sentence).
userId	string	•	The end user to sign in as.

Response

Field	Type	Always	Description
userId	string	•
expiresAt	string	•	When the session dies. It cannot be extended or refreshed.
expiresIn	integer	•	Seconds until the access token expires.
sessionId	string	•
accessToken	string	•	The access JWT of the impersonated session. There is NO refresh token.

Try it

Start an impersonated session as one user of this product — support access, hard-capped.

When to use

Example

Ask your agent something like this:

Start an impersonated session as one user of this product — support access, hard-capped.

The agent will invoke users_sessions_impersonate with these arguments:

{
  "reason": "<reason>",
  "userId": "<userId>"
}