Sign in with assigned account details and keep platform support access separate from school accounts.
Intended access: Platform administrator.
Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
An assigned school account with the required permissions.
Current profile is part of the documented workflow.
Token refresh is part of the documented workflow.
Review the result in the connected record or workspace before moving on.
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
identifier | string | Required by declaration |
password | string | Required by declaration |
schoolCode | string | Optional |
tenantSlug | string | Optional |
deviceName | string | Optional |
refreshToken | string | Optional |
userId | string | Required by declaration |
reason | string | Required by declaration |
minutes | number | Optional |
sessionId | string | Optional |
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.
/api/v1/auth/loginLogin by email / phone / employee code / admission no
Public/capability access as implementedDeclared request fields: identifier (required), password (required), schoolCode (optional), tenantSlug (optional), deviceName (optional).
/api/v1/auth/refreshRotate a refresh token for a new token pair
Public/capability access as implementedDeclared request fields: refreshToken (required).
/api/v1/auth/logoutRevoke the current session (or all sessions)
Authenticated scope and endpoint-specific rulesDeclared request fields: refreshToken (optional).
/api/v1/auth/meCurrent user profile, roles and permissions
Authenticated scope and endpoint-specific rules/api/v1/auth/impersonateStart acting as another user (platform admins only)
Authenticated scope and endpoint-specific rulesDeclared request fields: userId (required), reason (required), minutes (optional).
/api/v1/auth/impersonate/stopEnd an impersonation session
Authenticated scope and endpoint-specific rulesDeclared request fields: sessionId (optional).
/api/v1/auth/impersonate/activeOpen impersonation sessions (platform admins only)
Authenticated scope and endpoint-specific rules/api/v1/auth/impersonate/close-lapsedClose expired impersonation sessions (platform admins only)
Authenticated scope and endpoint-specific rules/api/v1/auth/impersonate/historyImpersonation audit history (platform admins only)
Authenticated scope and endpoint-specific rulesERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.