Account and directory
Who am I
GET /api/whoami
Response 200
{
"user": { "id": "…", "email": "ben.carter@contoso.com", "name": "Ben Carter", "isAdmin": false, "via": "edge", "roles": { "orgAdmin": false, "auditor": false, "approver": false, "builder": true, "delegated": [] } },
"product": "vastframe",
"version": "0.0.4-m4"
}
Licence
GET /api/license
The organization's licence and plan. Any signed-in user gets { tenant, status, plan, messages, blocks } (the console banner); Org Admins and Auditors get the full state.
The tenant field describes the organization: { id, name, mode, directory }. Without a valid identity it answers 401 UNAUTHENTICATED.
Directory
The people and group picker in the console. Any signed-in user.
| Method | Path | Query | Response |
|---|---|---|---|
GET | /api/directory/users | q, limit (default 20) | { users: [{ id, name, email, jobTitle, department, managerId, accountEnabled }] } |
GET | /api/directory/users/:id | { user, groups, managerChain, directReports } | |
GET | /api/directory/groups | q, limit | { groups: [{ id, name, description }] } |
GET | /api/directory/groups/:id/members | { group, members } |
Errors: 404 USER_NOT_FOUND, 404 GROUP_NOT_FOUND.
Notifications
The console's bell and inbox.
| Method | Path | Body / query | What it does |
|---|---|---|---|
GET | /api/notifications | ?limit=30&unread=true | { notifications, unread } |
POST | /api/notifications/read | { ids: [1, 2] } or { all: true } | Mark as read: { marked, unread } |
POST | /api/notifications/:id/resolve | { choice, to? } | Answer an "owner left" notification. choice is keep, transfer (with to) or archive. |
Was this page helpful?