更新用户组信息
接口描述
PATCH /v1/groups/{group_id}
更新用户组信息
请求头(Request Header)
请求参数(Request Parameters)
名称 | 位置 | 类型 | 必须 | 描述 |
---|---|---|---|---|
group_id | path | string(uuid) | true | 用户组id |
update_mask | query | string(field-mask) | false | 更新标记 |
请求体(Request Body)
名称 | 位置 | 类型 | 必须 | 描述 |
---|---|---|---|---|
body | body | Group | true | none |
请求示例(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)
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Group |
响应示例(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
名称 | 类型 | 必须 | 限制 | 描述 |
---|---|---|---|---|
id | string | false | none | 用户组id |
name | string | true | none | 用户组名称 |
display_name | string | true | none | 用户组显示名称 |
user_count | integer(int32) | false | none | 用户组成员数 |
remark | string | false | none | 备注 |
create_time | string(date-time) | false | read-only | 用户组创建时间 |
update_time | string(date-time) | false | read-only | 用户组更新时间 |
join_time | string(date-time) | false | read-only | 某用户加入组的时间 |
tenant_id | string | false | none | 租户id |