PUT
/integration/v1/users/{user_id}
Update user
Update user
operationId Update user
معلمات المسار
| الاسم | النوع | الإلزامية | الوصف |
|---|---|---|---|
user_id
|
string | مطلوب | معلمة المسار: user_id |
نص الطلب
Content-Type: application/json
| الحقل | النوع | الإلزامية | الوصف |
|---|---|---|---|
user_id
|
string (uuid) | مطلوب | user_id |
username
|
string | اختياري | Username |
password
|
string | اختياري | Password |
employee_id
|
string | اختياري | Employee ID |
external_id
|
string | اختياري | External ID |
group_ids
|
object | اختياري | 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 | اختياري | 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) | اختياري | Subscription ID |
auto_license
|
boolean | اختياري | Auto License |
active
|
boolean | اختياري | Is Active Bool |
notify_on_update
|
boolean | اختياري | Is Not Notify |
city
|
string | اختياري | City |
company
|
string | اختياري | Company |
custom_fields
|
array | اختياري | Extra |
id
|
string (uuid) | مطلوب | Custom field id |
value
|
string | مطلوب | Custom field value |
first_name
|
string | اختياري | First Name |
last_name
|
string | اختياري | Last Name |
national_id
|
string | اختياري | National ID |
email
|
string (email) | اختياري | |
phone_number
|
string (phone) | اختياري | Phone Number |
gender
|
string | اختياري | gender enum: `m`, `f` |
center
|
string | اختياري | Center |
position
|
string | اختياري | Position |
department
|
string | اختياري | Department |
date_of_birth
|
string (date) | اختياري | Date of Birth YYYY-MM-DD |
الاستجابات
200
مخطط application/json
{
"type": "object",
"nullable": true
}412 Invalid parameters
500 Server error
512 Specification violations