将用户添加至用户组

POST

/public-api/user/add-to-groups

接口简介

批量添加用户到用户组列表中

请求参数

Body 参数application/json

token

string

应用Token

必需

在观远平台管理员设置-系统集成-统一账户集成中获得

loginIds

array[string]

账户列表

必需

用户界面登录以及通过api管理用户属性的id ，数组大小不能超过100

ugIds

array[string]

用户组列表

必需

isExternal为true时视为外部用户组Id列表，否则为内部用户组Id列表

isExternal

boolean

是否是外部用户组的Id列表

可选

默认为true

默认值:

true

示例

{
    "token": "string",
    "loginIds": [
        "string"
    ],
    "ugIds": [
        "string"
    ],
    "isExternal": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/user/add-to-groups' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string",
    "loginIds": [
        "string"
    ],
    "ugIds": [
        "string"
    ],
    "isExternal": true
}'

返回响应

🟢200成功

application/json

Body

result

string

请求状态

必需

枚举值: ok、fail

response

string

响应结果

必需

示例

{
    "result": "ok",
    "response": "success"
}

修改于 2025-02-28 06:44:02

添加单个用户组

将用户从用户组删除