批量创建用户组

POST

/public-api/user-groups/add

接口简介

若请求中有用户组的externalParentGroupId在当前用户组以及请求userGroups中都不存在，或者用户组父子关系逻辑成环，都将导致本次用户组创建失败（全部都不创建）。

请求参数

Body 参数application/json

token

string

应用Token

必需

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

userGroups

array [object {3}]

用户组列表

必需

需要创建的用户组列表，包含用户组ID（外部系统的唯一ID），显示名称及上级用户组ID

name

string

用户组名

必需

externalGroupId

string

用户组id

必需

externalParentGroupId

string

上级用户组ID

可选

示例

{
    "token":"sdjfghfodjgjshgfiw23ehrt43",
    "userGroups": [
        {
            "name": "groupA",
            "externalGroupId": "gId1"
        },
        {
            "name": "groupB",
            "externalGroupId": "gId2",
            "externalParentGroupId":"gId1"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/user-groups/add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token":"sdjfghfodjgjshgfiw23ehrt43",
    "userGroups": [
        {
            "name": "groupA",
            "externalGroupId": "gId1"
        },
        {
            "name": "groupB",
            "externalGroupId": "gId2",
            "externalParentGroupId":"gId1"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

result

string

请求状态

必需

枚举值: ok、fail

response

string

响应结果

必需

示例

{
    "result": "ok",
    "response": "2 Groups added successfully"
}

🔴500服务器错误

修改于 2025-02-28 06:19:13

修改用户状态

批量修改用户组