tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateUser

Last updated: 2024-08-08 15:32:32

1. API Description

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

This API is used to create users.

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: 2021-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
UserId Yes String Sub-user UIN that needs to be granted permissions. It can be checked through the upper right corner of Tencent Cloud Console → Account Information → Account ID.
UserDescription No String User description, which can make it easy to identify different users.
PolicySet.N No Array of Policy Collections of permissions bound to users
UserType No String Types of users. ADMIN: administrators; COMMON: general users. When the type of user is administrator, the collections of permissions and bound working groups cannot be set. Administrators own all the permissions by default. If the parameter is not filled in, it will be COMMON by default.
WorkGroupIds.N No Array of Integer Collection of IDs of working groups bound to users
UserAlias No String User alias, and its characters are less than 50.

3. Output Parameters

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.

4. Example

Example1 Creating a User

Input Example

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

{
    "UserDescription": "Test User",
    "UserAlias": "Testname",
    "UserId": "1248065439",
    "PolicySet": [
        {
            "Table": "TableName",
            "Catalog": "COSDataCatalog",
            "Operation": "ALL",
            "Database": "DatabaseName"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "1287310-badou889lodj-1231jk12"
    }
}

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 The operation failed.
FailedOperation.GrantPolicyFailed Authorization failed.
InternalError An internal error occurred.
InternalError.InternalSystemException The business system is abnormal. Please try again or submit a ticket to contact us.
InvalidParameter.DuplicateUserName The username is duplicated.
InvalidParameter.InvalidAccessPolicy The access policy is invalid.
InvalidParameter.InvalidDescription The description information is invalid.
InvalidParameter.InvalidUserAlias The username is invalid.
InvalidParameter.InvalidUserName The username is invalid.
InvalidParameter.InvalidUserType The user type is invalid.
ResourcesSoldOut The resource is sold out.
ResourcesSoldOut.UnauthorizedGrantPolicy There is no permission authorization policy.
ResourcesSoldOut.UnauthorizedOperation There is no permission to operate.
UnauthorizedOperation.GrantPolicy Sub-users do not have the authority to grant specific permissions.
UnauthorizedOperation.UserNotExist The sub-user does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy