PUT
/integration/v1/users/{user_id}
Update user
Update user
operationId Update user
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id
|
string | required | Path parameter: user_id |
Request body
Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
user_id
|
string (uuid) | required | user_id |
username
|
string | optional | Username |
password
|
string | optional | Password |
employee_id
|
string | optional | Employee ID |
external_id
|
string | optional | External ID |
group_ids
|
object | optional | The COMPLETE set of groups this user should belong to, not an addition (BGR-1225). Omitting a group the user is currently in removes that membership, so a request that would remove one or more memberships is refused with 412 group_removal_requires_confirmation, naming those groups, instead of deleting them silently. Send the full current set plus your additions to keep an update additive, or set confirm_group_removal=true to accept the removals. Omit or leave empty to leave the user's groups untouched. |
confirm_group_removal
|
boolean | optional | BGR-1225: confirms the memberships this update would delete. group_ids is a complete desired set, so omitting a group the user is currently in deletes that membership; by default the endpoint answers 412 group_removal_requires_confirmation and names the groups rather than deleting them silently. Send true only when the removals are intended. A purely additive group_ids never needs this flag. By default false. |
subscription_id
|
string (uuid) | optional | Subscription ID |
auto_license
|
boolean | optional | Auto License |
active
|
boolean | optional | Is Active Bool |
notify_on_update
|
boolean | optional | Is Not Notify |
city
|
string | optional | City |
company
|
string | optional | Company |
custom_fields
|
array | optional | Extra |
id
|
string (uuid) | required | Custom field id |
value
|
string | required | Custom field value |
first_name
|
string | optional | First Name |
last_name
|
string | optional | Last Name |
national_id
|
string | optional | National ID |
email
|
string (email) | optional | |
phone_number
|
string (phone) | optional | Phone Number |
gender
|
string | optional | gender enum: `m`, `f` |
center
|
string | optional | Center |
position
|
string | optional | Position |
department
|
string | optional | Department |
date_of_birth
|
string (date) | optional | Date of Birth YYYY-MM-DD |
Responses
200
application/json schema
{
"type": "object",
"nullable": true
}412 Invalid parameters
500 Server error
512 Specification violations