¶ 批量创建分组

更新时间: 2024-10-10 07:28:40

批量创建分组，一个分组必须包含分组名称与唯一标志符 code，且必须为一个合法的英文标志符，如 developers。

¶ 请求参数

名称	类型	必填	默认值	描述	示例值
list	CreateGroupReqDto[]	是	-	批量分组。

¶ 示例代码

import { ManagementClient } from 'authing-node-sdk';
// 在 Node.js 中引用：
// const { ManagementClient } = require('authing-node-sdk');

const managementClient = new ManagementClient({
  accessKeyId: 'AUTHING_USERPOOL_ID',
  accessKeySecret: 'AUTHING_USERPOOL_SECRET',
});

(async () => {
  const result = await managementClient.createGroupsBatch({
    list: [{
            code: 'developer',
          name: '开发者',
          description: '描述内容',
      }],
 });
})();

¶ 请求响应

类型： GroupListRespDto

名称	类型	描述
statusCode	number	业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
message	string	描述信息
apiCode	number	细分错误码，可通过此错误码得到具体的错误类型。
data	array	响应数据

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "code": "developer",
    "name": "开发者",
    "description": "描述内容"
  }
}

¶ 数据结构

¶ CreateGroupReqDto

名称	类型	必填	描述
code	string	是	分组 code。示例值： `developer`
name	string	是	分组名称。示例值： `开发者`
description	string	是	分组描述。示例值： `描述内容`

¶ GroupDto

名称	类型	必填	描述
code	string	是	分组 code。示例值： `developer`
name	string	是	分组名称。示例值： `开发者`
description	string	是	分组描述。示例值： `描述内容`