Domain name for API request: organization.tencentcloudapi.com.
This API is used to add users to a user group.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: AddUserToGroup. |
Version | Yes | String | Common Params. The value used for this API: 2021-03-31. |
Region | No | String | Common Params. This parameter is not required. |
ZoneId | Yes | String | Space ID. |
GroupId | Yes | String | User group ID. |
UserId | Yes | String | User ID. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to add users to a user group.
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddUserToGroup
<Common request parameters>
{
"ZoneId": "z-d8dh38bd",
"GroupId": "g-dsuen8n",
"UserId": "u-s3ndin23"
}
{
"Response": {
"RequestId": "e297543a-80de-4039-83c8-9d324545"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.GroupUserCountOverUpperLimit | Members of the CIC user group exceed the limit. |
FailedOperation.IdentityCenterNotOpen | The CIC service is not enabled. |
FailedOperation.SynchronizedGroupNotAddUser | The synchronized user group does not allow adding users. |
FailedOperation.UserAddGroupCountOverUpperLimit | Users joining the user group exceed the limit. |
FailedOperation.ZoneIdNotExist | The user zoneId of the CIC service does not exist. |
InvalidParameter.GroupNotExist | The user group does not exist. |
InvalidParameter.GroupUserAlreadyExists | The user already exists in the user group. |
LimitExceeded.AddUserToGroupLimitExceeded | Requests for adding users to the user group exceed the limit. |
ResourceNotFound.UserNotExist | The user does not exist. |
Was this page helpful?