POST
/api/v1/auth/impersonate/stopEnd an impersonation session
Authenticated scope and endpoint-specific rulesDeclared request fields: sessionId (optional).
SCREEN GUIDE · 11 OCT 2026
Support impersonation
Inspect and manage platform support sessions separately from ordinary sign-in.
OVERVIEW
What you can do
01
Start/stop impersonation
02
Open sessions
03
Close lapsed sessions
04
Audit history
BEFORE YOU BEGIN
Access & setup
Intended access: Platform administrator.
- Platform administrator access.
- Choose the relevant school, academic session or child before working.
Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
STEP BY STEP
How the workflow works
- 01
Review the permitted support context
Platform administrator access.
- 02
Start the intended support session only when authorised
Open sessions is part of the documented workflow.
- 03
Stop the session and review its audit record
Review the result in the connected record or workspace before moving on.
Request fields to understand
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
sessionId | string | Optional |
CURRENT BEHAVIOUR
Rules & current limits
- Public guided demos do not issue ERP credentials. Impersonation is restricted to platform administrators and is audited.
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
LEARN BY DOING
Launch guided demo →Try support impersonation
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
4 source-declared operations
GET
/api/v1/auth/impersonate/activeOpen impersonation sessions (platform admins only)
Authenticated scope and endpoint-specific rulesPOST
/api/v1/auth/impersonate/close-lapsedClose expired impersonation sessions (platform admins only)
Authenticated scope and endpoint-specific rulesGET
/api/v1/auth/impersonate/historyImpersonation audit history (platform admins only)
Authenticated scope and endpoint-specific rulesOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.