tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateUser

Last updated: 2024-08-23 18:05:53

1. API Description

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

This API is used to create a user

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: CreateUser.
Version Yes String Common Params. The value used for this API: 2024-08-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
UserAccount Yes String User account
UserName Yes String User name
AccountType Yes Integer User account type. 2: Platform administrator; 3: Ordinary member.
Password Yes String Account password. Use CreatePresetKey to get the public key to encrypt the password.
KeyId Yes String Call CreatePresetKey to get the keyID from RequestId
PlatformId Yes String Platform ID

3. Output Parameters

Parameter Name Type Description
Data ResourceIdStringInfo Response data, user ID
Note: This field may return null, indicating that no valid values can be obtained.
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.

4. Example

Example1 CreateUser

Input Example

POST / HTTP/1.1
Host: tcmpp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateUser
<Common request parameters>

{
    "UserAccount": "OpenApiUser0819174740",
    "UserName": "OpenApiUser0819174740",
    "AccountType": 3,
    "KeyId": "8d3834f4-3f2b-440f-8ba7-37aa85e27549",
    "Password": "WY80bHGTqbNKhSl9I6lsh0li5EPcHO7WMlqoZzqK2rHpdNqtPeJINReB/PfrrJBX9tinDt6L0meKN/yts7M62D8Wc+zDJKjcDLFKlRIVtbkgLIccb+klbHH1+MT4SXpZFprJsaIp+jQx2xRf97ZRqBFJxPvbLbA4FzsnOK2Nk98=",
    "PlatformId": "T04257DS9431720WTAG"
}

Output Example

{
    "Response": {
        "Data": {
            "ResourceId": "U20240819174742HGXHXT"
        },
        "RequestId": "7ec65677-eef5-4c9a-87bf-aff8141e54e6"
    }
}

5. Developer Resources

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
FailedOperation Operation failed.
FailedOperation.GetOperateResourceFailed Failed to obtain the operation resource.
FailedOperation.PackageAlreadyExpired The TCMPP plan under the current account has expired.
InternalError Internal error
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.ExistUserAccount The account already exists.
InvalidParameterValue.InvalidPlatformId Invalid platform ID
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy