RemoveUserGroupMembers - 批量移除用户组成员

更新时间:
复制 MD 格式

用于从指定用户组中批量移除直接成员关系。

接口说明

请求说明

  • 该接口支持通过提供用户组 ID 及一个或多个用户 ID 来批量移除这些用户与指定用户组之间的直接成员关系。

  • userIds 参数接受一个整数数组,表示待移除的平台用户 ID 列表。

  • 如果尝试移除的用户不是该用户组的直接成员,则不会影响最终的结果计数。

  • 接口调用成功后返回实际被移除的成员数量以及请求处理前的成员数量等信息。

  • 此操作需要相应的权限认证,并且会记录到操作审计中。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /openapi/removeUserGroupMembers HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

tenantId

string

否

租户 ID,公共参数;winnexo-cli 通过 --tenant-id 显式传入

10000

userGroupId

string

是

目标用户组 ID

7ea8973f-7a5c-4e8a-956b-4fe0e7e2eb11

userIds

array

是

待移除的平台用户 ID 列表;支持单个或批量

1

integer

否

待移除的平台用户 ID。

1000001

返回参数

名称

类型

描述

示例值

object

批量移除用户组成员响应。

code

string

状态码。

200

message

string

状态码描述。

ok

requestId

string

请求 ID。

019FF406-1B10-0065-A97D-2D1920C2A03D

userGroupId

string

目标用户组 ID

7ea8973f-7a5c-4e8a-956b-4fe0e7e2eb11

requestedCount

integer

去重前请求成员数量

2

affectedCount

integer

实际移除成员关系数量

2

示例

正常返回示例

JSON格式

{
  "code": "200",
  "message": "ok",
  "requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
  "userGroupId": "7ea8973f-7a5c-4e8a-956b-4fe0e7e2eb11",
  "requestedCount": 2,
  "affectedCount": 2
}

错误码

访问错误中心错误中心查看更多错误码。

变更历史

更多信息,参考变更详情变更详情。