Skip to main content

UserWrite

idstring

Key: the Nuntiq id

Possible values: Value must match regular expression ^[0-9]+$

login_accountstringrequired

required

Possible values: <= 255 characters

first_namestringrequired

required

Possible values: <= 255 characters

last_namestringrequired

required

Possible values: <= 255 characters

emailstringrequired

required

Possible values: <= 320 characters

login_typeintegerrequired

required

Possible values: [1, 2]

sso_providerstring

Possible values: <= 100 characters

active_fromstring<date-time>

kept when a POST leaves it out

active_tostring<date-time>

kept when a POST leaves it out

is_activeboolean

kept when a POST leaves it out; default true

source_systemstring

The integration that owns the record. Defaults to the API key's source system. Another one is accepted only when the API user owns All records or All integrated records; otherwise the record is refused (source_system_mismatch).

Possible values: <= 100 characters

source_record_idstring

Key: the record's id in the source system (with source_system)

Possible values: <= 255 characters

source_updated_atstring<date-time>

When the source last changed the record. An older value than the stored one is not applied (stale_source_update warning).

passwordstring

write-only

Possible values: <= 200 characters

send_inviteboolean

write-only

groups[]

write-only

UserWrite
{
"id": "string",
"login_account": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"login_type": 1,
"sso_provider": "string",
"active_from": "2024-07-29T15:51:28.071Z",
"active_to": "2024-07-29T15:51:28.071Z",
"is_active": true,
"source_system": "string",
"source_record_id": "string",
"source_updated_at": "2024-07-29T15:51:28.071Z",
"password": "string",
"send_invite": true,
"groups": [
null
]
}