Creates a group.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request syntax
POST /v2/group/create HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| body | object | No | The request parameters. | |
| group_name | string | Yes | The name of the group. The name must be 1 to 128 characters in length. | test group |
| description | string | No | The description of the group. The description can be up to 1,024 characters in length. | test group description |
| is_root | boolean | No | Specifies whether the group is a root group. A root group cannot be added to any other group. In most cases, a root group is the top-level organization in the organizational structure. | false |
| parent_group_id | string | No | The ID of the parent group to which the group is added. If this parameter is specified, the system automatically adds the group to the specified parent group after the group is created. | 2e43ec8427dd45f19431b7504649a1b3 |
Response parameters
Examples
Sample success responses
JSONformat
{
"domain_id": "bj1",
"group_id": "b45c0c0c373c41ec9ebb5c85a025a08f",
"group_name": "test group",
"description": "created by system",
"created_at": 0,
"updated_at": 0,
"creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
"is_sync": true
}Error codes
For a list of error codes, visit the Service error codes.