Domain name for API request: cam.tencentcloudapi.com.
This API is used to create a sub-user.
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: AddUser. |
Version | Yes | String | Common Params. The value used for this API: 2019-01-16. |
Region | No | String | Common Params. This parameter is not required for this API. |
Name | Yes | String | Sub-user username |
Remark | No | String | Sub-user remarks |
ConsoleLogin | No | Integer | Whether or not the sub-user is allowed to log in to the console. 0: No; 1: Yes. |
UseApi | No | Integer | Whether or not to generate keys for sub-users. 0: No; 1: Yes. |
Password | No | String | Sub-user's console login password. If no password rules have been set, the password must have a minimum of 8 characters containing uppercase letters, lowercase letters, digits, and special characters by default. This parameter will be valid only when the sub-user is allowed to log in to the console. If it is not specified and console login is allowed, the system will automatically generate a random 32-character password that contains uppercase letters, lowercase letters, digits, and special characters. |
NeedResetPassword | No | Integer | If the sub-user needs to reset their password when they next log in to the console. 0: No; 1: Yes. |
PhoneNum | No | String | Mobile number |
CountryCode | No | String | Country/Area Code |
No | String |
Parameter Name | Type | Description |
---|---|---|
Uin | Integer | Sub-user UIN |
Name | String | Sub-user username |
Password | String | If the combination of input parameters indicates that a random password should be generated, the generated password is returned |
SecretId | String | Sub-user's key ID |
SecretKey | String | Sub-user's secret key |
Uid | Integer | Sub-user UID |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddUser
<Common request parameters>
{
"Remark": "test",
"Name": "test124",
"CountryCode": "86",
"NeedResetPassword": "0",
"PhoneNum": "10086",
"UseApi": "1",
"ConsoleLogin": "1",
"Password": "test123456",
"Email": "123%40qq.com"
}
{
"Response": {
"Uid": 5648765,
"Uin": 100000546533,
"Name": "test124",
"Password": "test123456",
"SecretId": "faweffewagwaegawe",
"SecretKey": "fawef23rjhiuaefhuaifhiuawef",
"RequestId": "b46d2afe-6893-4529-bc96-2c82d9214957"
}
}
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 |
---|---|
AuthFailure.UnauthorizedOperation | No permission. |
FailedOperation | Operation failed. |
InvalidParameter.ParamError | Invalid input parameter. |
InvalidParameter.PasswordViolatedRules | Password incompatible with user safety settings. |
InvalidParameter.SubUserFull | Limit on number of sub-accounts reached. |
InvalidParameter.SubUserNameInUse | Sub-user name repeated. |
InvalidParameter.UserNameIllegal | Invalid username. |
RequestLimitExceeded.CreateUser | The frequency limit of creating sub-users has been reached. |
Was this page helpful?