UpdateUser

Last updated: 2020-01-13 17:23:37

PDF

1. API Description

Domain name for API request: cam.tencentcloudapi.com.

This API is used to update a sub-user.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

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 parameter. The value used for this API: UpdateUser
Version Yes String Common parameter. The value used for this API: 2019-01-16
Region No String Common parameter. 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.
Password No String Sub-user’s console login password. If no password rules have been set, the default rules require the password to have at least 8 characters, at least one lowercase letter, one uppercase letter, one number, and one special character. This value is valid only when the sub-user is allowed to log in to the console. If no value is specified, and console login is allowed, the system will automatically generate a password. The automatically generated passwords are 32 characters long and contain letters (both upper and lower cases), numbers, 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
Email No String Email

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Updating a Sub-User

Input Example

https://cam.tencentcloudapi.com/?Action=UpdateUser
&Name=test124
&Remark=test
&ConsoleLogin=1
&Password=test123456
&NeedResetPassword=0
&PhoneNum=10086
&CountryCode=86
&Email=123%40qq.com
&<Common Request Parameters>

Output Example

{
  "Response": {
    "RequestId": "b46d2afe-6893-4529-bc96-2c82d9214957"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter.PasswordViolatedRules Password incompatible with user safety settings.
ResourceNotFound.UserNotExist User does not exist.