User

idint64

Internal user id. Returned by GET; never accept on POST — upsert key is login_account.

first_namestringrequired

Required. User's given name.

last_namestringrequired

Required. User's family name.

emailemailrequired

Required. Unique across all users in this tenant.

login_accountstringrequired

Required. Stable login handle. Unique across all users in this tenant. This is the upsert key on POST.

login_typeintegerrequired

Required. 1 = username/password, 2 = SSO.

Possible values: [1, 2]

sso_providerstringnullable

The alias of the IdP configuration to use for this user (login_type=2). Matches idp_sso_config.alias (e.g. "nuntiq", "default").

is_activeboolean

Whether the user can sign in. Defaults to true.

active_fromdate-timenullable

Optional start date when the user becomes active.

active_todate-timenullable

Optional end date after which the user is no longer active. Set automatically by DELETE /users and POST /users/deactivate-inactive.

must_change_passwordboolean

True if the user must rotate their password on next sign-in. Set automatically when the API receives a password.

groups object[]

Group memberships. Same shape on POST and GET. On POST, only external_code is honoured — name (if sent) is ignored. Replace-all semantics: omit the field to leave memberships untouched, or send [] to clear them. Unknown codes return 400.

Array [

external_codestringrequired

The customer-supplied stable code for the group (configured in the customer portal on each user group).

namestring

Group display name. Returned by GET; ignored on POST.

]

created_atdate-time

updated_atdate-time

User

{
  "id": 0,
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "login_account": "string",
  "login_type": 1,
  "sso_provider": "string",
  "is_active": true,
  "active_from": "2024-07-29T15:51:28.071Z",
  "active_to": "2024-07-29T15:51:28.071Z",
  "must_change_password": true,
  "groups": [
    {
      "external_code": "FINANCE",
      "name": "Finance Team"
    },
    {
      "external_code": "AP_TEAM",
      "name": "Accounts Payable"
    }
  ],
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}