Create groups in batches

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If this document description is incorrect, please refer to V3 API.

To create groups in batches, a group must contain a group name and a unique identifier code, and it must be a legal English identifier, such as developers.

Method name

ManagementClient.createGroupsBatch

Request parameters

Name	Type	Required	Default value	Description	Sample value
list	<a CreateGroupReqDto[]	Yes	-	Batch grouping Array length limit: 50.

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If it is a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.createGroupsBatch({
    list: [
      {
        code: "developer",
        name: "Developer",
        description: "Description",
      },
    ],
  });

  console.log(JSON.stringify(result, null, 2));
})();

Request response

Type: GroupListRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	array	response data

Sample result:

json

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "id": "60b49eb83fd80adb96f26e68",
    "code": "developer",
    "name": "Developer",
    "description": "Description content",
    "type": "static",
    "members": {
      "userId": "6229ffaxxxxxxxxcade3e3d9",
      "createdAt": "2022-07-03T03:20:30.000Z",
      "updatedAt": "2022-07-03T03:20:30.000Z",
      "status": "Activated",
      "workStatus": "Active",
      "externalId": "10010",
      "email": "test@example.com",
      "phone": "188xxxx8888",
      "phoneCountryCode": "+86",
      "username": "bob",
      "name": "Zhang San",
      "nickname": "xxxx",
      "photo": "https://files.authing.co/authing-console/default-user-avatar.png",
      "loginsCount": 3,
      "lastLogin": "2022-07-03T03:20:30.000Z",
      "lastIp": "127.0.0.1",
      "gender": "M",
      "emailVerified": true,
      "phoneVerified": true,
      "passwordLastSetAt": "2022-07-03T03:20:30.000Z",
      "birthdate": "2022-06-03",
      "country": "CN",
      "province": "BJ",
      "city": "BJ",
      "address": "Beijing Chaoyang",
      "streetAddress": "Beijing Chaoyang District xxx Street",
      "postalCode": "438100",
      "company": "steamory",
      "browser": "Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0",
      "device": "iOS",
      "givenName": "xx",
      "familyName": "xx",
      "middleName": "James",
      "profile": "alice",
      "preferredUsername": "alice",
      "website": "https://my-website.com",
      "zoneinfo": "GMT-08:00",
      "locale": "af",
      "formatted": "132, My Street, Kingston, New York 12401.",
      "region": "Xinjiang Uyghur Autonomous Region",
      "userSourceType": "register",
      "passwordSecurityLevel": 1,
      "departmentIds": "[\"624d930c3xxxx5c08dd4986e\",\"624d93102xxxx012f33cd2fe\"]",
      "identities": {
        "identityId": "62299d8b866d2dab79a89dc4",
        "extIdpId": "6076bacxxxxxxxxd80d993b5",
        "provider": "wechat",
        "type": "openid",
        "userIdInIdp": "oj7Nq05R-RRaqak0_YlMLnnIwsvg",
        "accessToken": "57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx",
        "refreshToken": "57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx",
        "originConnIds": "[\"605492ac41xxxxe0362f0707\"]"
      },
      "identityNumber": "420421xxxxxxxx1234",
      "customData": {
        "school": "xxx",
        "age": 22
      },
      "statusChangedAt": "2022-07-03T03:20:30.000Z"
    }
  }
}

Data Structure

CreateGroupReqDto

Name	Type	Required	Description	Sample value
code	string	Yes	Group code	`developer`
name	string	Yes	Group name	`Developer`
description	string	Yes	Group description	`Description content`
type	string	Yes	Group type	`static`
customData	object	No	Custom data, the key in the passed object must first define the relevant custom field in the user pool	`{"custom_id":"xxx"}`

GroupDto

name	type	Is it required?	Description	Sample value
id	string	yes	Group ID	`60b49eb83fd80adb96f26e68`
code	string	yes	Group code	`developer`
name	string	yes	Group name	`Developer`
description	string	yes	Group description	`Description content`
type	string	yes	Group type	`static`
metadataSource	array	yes	Group metadata information
members	array	yes	Member list nested type: <a UserDto.

UserDto

| Name | Type | Is this field required? | Description | Sample value | | --------------------- | ------ | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------------------------ | ------- | --- | ------------------------------------ | --- | | userId | string | Yes | The unique identifier of the user, which can be user ID, user name, email, phone number, externalId, or ID in an external identity source. For details, see the description of the userIdType field. The default is user id. | 6229ffaxxxxxxxxcade3e3d9 | | createdAt | string | yes | creation time | 2022-07-03T03:20:30.000Z | | updatedAt | string | yes | update time | 2022-07-03T03:20:30.000Z | | status | string | yes | current status of the account:
- Activated: normal status
- Suspended: deactivated
- Deactivated: disabled
- Resigned: resigned
- Archived: archived
| Suspended | | workStatus | string | yes | current work status of the account | Closed | | externalId | string | no | third-party external ID | 10010 | | email | string | no | email address, case insensitive | test@example.com | | phone | string | no | Phone number without area code. If it is an overseas phone number, please specify the area code in the phoneCountryCode parameter. | 188xxxx8888 | | phoneCountryCode | string | no | Phone area code. This parameter is optional for phone numbers in mainland China. The GenAuth SMS service does not yet support international phone numbers. You need to configure the corresponding international SMS service in the GenAuth console. For a complete list of phone area codes, please refer to https://en.wikipedia.org/wiki/List_of_country_calling_codes. | +86 | | username | string | no | User name, unique in the user pool | bob | | name | string | no | User's real name, not unique | xxxx xxx | | nickname | string | no | Nickname | xxxx xxx | | photo | string | no | 6229ffaxxxxxxxxcade3e3d9 | | createdAt | string | yes | creation time | 2022-07-03T03:20:30.000Z | | updatedAt | string | yes | update time | 2022-07-03T03:20:30.000Z | | status | string | yes | current status of the account:
- Activated: normal status
- Suspended: deactivated
- Deactivated: disabled
- Resigned: resigned
- Archived: archived
| Suspended | | workStatus | string | yes | current work status of the account | Closed | | externalId | string | no | third-party external ID | 10010 | | email | string | no | email address, case insensitive | test@example.com | | phone | string | no | Phone number without area code. If it is an overseas phone number, please specify the area code in the phoneCountryCode parameter. | 188xxxx8888 | | phoneCountryCode | string | no | Phone area code. This parameter is optional for phone numbers in mainland China. The GenAuth SMS service does not yet support international phone numbers. You need to configure the corresponding international SMS service in the GenAuth console. For a complete list of phone area codes, please refer to https://en.wikipedia.org/wiki/List_of_country_calling_codes. | +86 | | username | string | no | User name, unique in the user pool | bob | | name | string | no | User's real name, not unique | xxxx xxx | | nickname | string | no | Nickname | xxxx xxx | | photo | string | no | BJ | | address | string | No | Address | Beijing Chaoyang | | streetAddress | string | No | Street address | Beijing Chaoyang District xxx Street | | postalCode | string | No | Postal code | 438100 | | company | string | No | Company | steamory | | browser | string | No | Last login browser UA | Mozilla/5.0 (Linux; Android 10; V2001A; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/87.0.4280.141 Mobile Safari/537.36 VivoBrowser/10.2.10.0 | | device | string | No | Last login device | iOS | | givenName | string | No | Name | xx | | familyName | string | no | Last Name | Zhang | | middleName | string | no | Middle Name | James | | profile | string | no | Preferred Username | alice | | preferredUsername | string | no | Preferred Username | alice | | website | string | No | User personal website | https://my-website.com | | zoneinfo | string | No | User time zone information | GMT-08:00 | | locale | string | No | Locale | af | | formatted | string | No | Standard full address | 132, My Street, Kingston, New York 12401. | | region | string | No | User location | Xinjiang Uyghur Autonomous Region | | userSourceType | string | Yes | Source type:
- excel: Imported through excel
- register: User self-registration
- adminCreated: Manual creation by the administrator backend (including creating users using the management API)
- syncTask: Synchronization task of the synchronization center
| excel | | userSourceId | string | No | Application ID or synchronization task ID | | | lastLoginApp | string | No | ID of the application that the user last logged in to | | | mainDepartmentId | string | No | ID of the user's main department | | | lastMfaTime | string | No | The time when the user last performed MFA authentication | | | passwordSecurityLevel | number | No | User password security strength level | 1 | | resetPasswordOnNextLogin | boolean | no | Require password reset on next login | | | registerSource | array | no | Registration method | | | departmentIds | array | no | List of department IDs to which the user belongs | ["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"] | | identities | array | no | External identity source Nested type: <a IdentityDto. | | | identityNumber | string | No | User ID number | 420421xxxxxxxx1234 | | customData | object | No | User's extended field data | {"school":"Peking University","age":22} | | postIdList | array | No | User's associated department ID | | | statusChangedAt | string | No | User status last modified time | 2022-07-03T03:20:30.000Z | | tenantId | string | No | User tenant ID | |

IdentityDto

Name	Type	Is it required	Description	Sample value
identityId	string	yes	Identity source ID	`62299d8b866d2dab79a89dc4`
extIdpId	string	yes	Identity source connection ID	`6076bacxxxxxxxxd80d993b5`
provider	string	yes	External identity source type: - `wechat`: WeChat - `qq`: QQ - `wechatwork`: WeChat for Business - `dingtalk`: DingTalk - `weibo`: Weibo - `github`: GitHub - `alipay`: Alipay - `baidu`: Baidu - `lark`: Feishu - `welink`: Welink - `yidun`: NetEase Yidun - `qingcloud`: Qingyun - `google`: Google - `gitlab`: GitLab - `gitee`: Gitee - `twitter`: Twitter - `facebook`: Facebook - `slack`: Slack - `linkedin`: Linkedin - `instagram`: Instagram - `oidc`: OIDC-type enterprise identity source - `oauth2`: OAuth2-type enterprise identity source - `saml`: SAML-type enterprise identity source - `ldap`: LDAP-type enterprise identity source - `ad`: AD-type enterprise identity source - `cas`: CAS-type enterprise identity source - `azure-ad`: Azure AD Type of enterprise identity source	oidc
type	string	yes	Identity type, such as unionid, openid, primary	`openid`
userIdInIdp	string	yes	ID in the external identity source	`oj7Nq05R-RRaqak0_YlMLnnIwsvg`
userInfoInIdp	object	yes	User's identity information in idp
accessToken	string	no	Access Token in the external identity source (this parameter is returned only when the user actively obtains it, and it is not returned by the management interface).	`57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx`
refreshToken	string	no	Refresh Token in the external identity source (this parameter is returned only when the user actively obtains it, and it is not returned by the management interface).	`57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx`
originConnIds	array	yes	Identity source connection ID list from which the identity comes	`["605492ac41xxxxe0362f0707"]`

Authenticate Your First User

Trial Period

QR Code Login

Use Self-built App for QR Code Login

Extend Authentication Process

Manage New Data Resource Permissions

Data Policies and Authorization

Self-built Applications

Protocol Configuration

Single Sign-On SSO

Third-party SSO Solutions

Social Identity Providers

Custom Database

Password Security

Multi-factor Authentication

Pipeline

用户字段管理

Login

Logout

Token Management

Registration

User Profile

Account Binding

MFA Factor Management

User Related Resources

Message Service

Authorization

WeChat Related APIs

Others

User Management

Organization Management

Role Management

User Group Management

Custom Field Management

Resource and Permission Management

Manage Data Resources and Permissions

Manage Applications

Manage Identity Sources

Manage Security Configuration

Manage Message Service

Manage Pipeline

Manage Webhook

Get Audit Logs

Manage Metering and Billing

Login

Logout

Register

User Profile

Account Binding

MFA Factor Management

User Related Resources

Message Service

WeChat Related APIs

Others

User Management

Organization Management

Role Management

User Group Management

Custom Field Management

Resource and Permission Management

管理应用

管理身份源

管理安全配置

管理消息服务

管理 Pipeline

管理 Webhook

获取审计日志

管理计量计费

Create groups in batches ​

Method name ​

Request parameters ​

Sample code ​

Request response ​

CreateGroupReqDto ​

GroupDto ​

UserDto ​

IdentityDto ​