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.
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. |
| 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. |
| NeedResetPassword | No | Boolean | Whether password reset is required. valid values: true (need to reset), false (not required to reset password). default value: false. |
| 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. |
This example shows you how to create a user.
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"
}
{
"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",
"Password": "d893nd8!@HK&",
"CreateTime": "2024-02-02 12:12:12",
"UpdateTime": "2024-02-02 12:12:12"
},
"RequestId": "e297543a-80de-4039-83c8-9d35d4545"
}
}
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 |
|---|---|
| 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. |
文档反馈