tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Organization
    Documentation
    Download PDF

    CreateUser

    Last updated: 2024-11-27 21:24:30
    Download PDF

    1. API Description

    Domain name for API request: organization.intl.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: 2021-03-31.
    Region No String Common Params. This parameter is not required.
    ZoneId Yes String Space ID.
    UserName Yes String User name, which must be unique within the space and cannot be modified. It contains up to 64 characters, including digits, English letters, and special characters such as plus signs (+), equal signs (=), commas (,), periods (.), at signs (@), hyphens (-), and underscores (_).
    FirstName No String Last name of the user, which contains up to 64 characters.
    LastName No String First name of the user, which contains up to 64 characters.
    DisplayName No String Display name of the user, which contains up to 256 characters.
    Description No String User description, which contains up to 1024 characters.
    Email No String Email address of the user, which must be unique within the directory and contains up to 128 characters.
    UserStatus No String User status. Valid values: Enabled (default), Disabled.
    UserType No String User type. Manual: manually created, Synchronized: imported from external sources.

    3. Output Parameters

    Parameter Name Type Description
    UserInfo UserInfo User details.
    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

    This example shows you how to create a user.

    Input Example

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

{
    "ZoneId": "z-33w3je****",
    "UserName": "Alice",
    "FirstName": "Alice",
    "LastName": "Alice",
    "DisplayName": "Alice",
    "Description": "this is user",
    "Email": "Alice@example.com",
    "UserStatus": "Enabled"
}

    Output Example

    {
    "Response": {
        "UserInfo": {
            "UserName": "Alice",
            "FirstName": "Alice",
            "LastName": "Alice",
            "DisplayName": "Alice",
            "Description": "this is user",
            "Email": "Alice@example.com",
            "UserStatus": "Enabled",
            "UserType": "Manual",
            "UserId": "u-2342ds2s",
            "CreateTime": "2024-02-02 12:12:12",
            "UpdateTime": "2024-02-02 12:12:12"
        },
        "RequestId": "e297543a-80de-4039-83c8-9d35d4545"
    }
}

    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.IdentityCenterNotOpen The CIC service is not enabled.
    FailedOperation.UserOverUpperLimit Users created exceed the upper limit.
    FailedOperation.ZoneIdNotExist The user zoneId of the CIC service does not exist.
    InvalidParameter.EmailAlreadyExists The email address already exists.
    InvalidParameter.UsernameAlreadyExists The username already exists.
    InvalidParameter.UsernameFormatError The username has a format error.
    LimitExceeded.CreateUserLimitExceeded Requests for creating users exceed the limit.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy