更新用户组信息 | 大装置帮助中心
跳到主要内容

更新用户组信息

接口描述

PATCH /v1/groups/{group_id} 更新用户组信息

请求头(Request Header)

参考认证(authentication)

请求参数(Request Parameters)

名称位置类型必须描述
group_idpathstring(uuid)true用户组id
update_maskquerystring(field-mask)false更新标记

请求体(Request Body)

名称位置类型必须描述
bodybodyGrouptruenone

请求示例(Request Example)

curl --request PATCH \
--url https://example.com/v1/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"id":"string","name":"string","display_name":"string","user_count":0,"remark":"string","tenant_id":"string"}'

响应参数(Response Parameters)

StatusMeaningDescriptionSchema
200OKOKGroup

响应示例(Response Example)

200 Response

{
"id": "string",
"name": "string",
"display_name": "string",
"user_count": 0,
"remark": "string",
"create_time": "2019-08-24T14:15:22Z",
"update_time": "2019-08-24T14:15:22Z",
"join_time": "2019-08-24T14:15:22Z",
"tenant_id": "string"
}

数据结构(Schemas)

Group

名称类型必须限制描述
idstringfalsenone用户组id
namestringtruenone用户组名称
display_namestringtruenone用户组显示名称
user_countinteger(int32)falsenone用户组成员数
remarkstringfalsenone备注
create_timestring(date-time)falseread-only用户组创建时间
update_timestring(date-time)falseread-only用户组更新时间
join_timestring(date-time)falseread-only某用户加入组的时间
tenant_idstringfalsenone租户id