Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

Tenant user. Users authenticate via OAuth device flow (the CLI / SDK path) or via the web app. The DataUser shape carries profile information; credential storage is separate (see DataUserAuth).

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "email": "[email protected]",
  "name": "Alex Liddell",
  "active": true,
  "jobRoleId": "jobrole_01HJOBROLE_ENGINEER",
  "costCenterId": "costcenter_01HCOSTCENTER_PRODUCT",
  "userGroup": [
    "group_01HGROUP_EVERYONE",
    "group_01HGROUP_DEV"
  ],
  "timezone": "Europe/London",
  "currency": "GBP",
  "country": "GB"
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
namestringRequiredDisplay name shown across the UI.
initialsstringRequired
emailstringRequiredUser’s email. Used as the matching key during migrations and as the recipient for notifications.
localestringOptional
timezonestringOptionalIANA timezone (e.g. Europe/London). Drives time-display in notifications and reports.
darkModestringOptional
costCenterstringOptional
jobRolestringOptional
workingHoursstringOptional
notificationsbooleanOptional
superAdminbooleanOptional
activebooleanOptionalWhen false, the user can’t sign in but their authoring history is preserved.
lockedstring • nullableOptional
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Request body

  • POST /api/user
  • PUT /api/user

​
Response body

  • GET /api/user/{id}
  • GET /api/user

​
CLI

ekso user — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.