Tenant Cloud
Management and Audit
Cloud Organization
Identity Center User Management APIs
CreateUser
1. Interface Description
Interface request domain name: cic.api3.convergecloud.com.
Create User
Default interface request rate limit: 20 times per second.
Interface update time: 2024-12-11 12:17:58.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateUser |
| Version | Yes | No | String | Public parameter, The value of this interface: 2021-03-31 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| FirstName | No | Yes | String | Last name of the user, which contains up to 64 characters. Example: Alice |
| Description | No | Yes | String | User description, which contains up to 1024 characters. Example: description |
| UserStatus | No | Yes | String | User status. Valid values: Enabled (default), Disabled. Example: Enabled |
| UserType | No | Yes | String | User type. Manual: manually created, Synchronized: imported from external sources. Example: Manual |
| ZoneId | Yes | Yes | String | Space ID. Example: z-2d8shd8*** |
| LastName | No | Yes | String | First name of the user, which contains up to 64 characters. Example: Alice |
| DisplayName | No | Yes | String | Display name of the user, which contains up to 256 characters. Example: Alice |
| No | Yes | String | Email address of the user, which should be unique within the directory and contains up to 128 characters. Example: Alice@example.com |
|
| UserName | Yes | 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 (_). Example: Alice |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| UserInfo | UserInfo | User Details Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| FailedOperation.IdentityCenterNotOpen | |
| FailedOperation.ZoneIdNotExist | |
| InvalidParameter.UsernameFormatError | |
| InvalidParameter.UsernameAlreadyExists | |
| InvalidParameter.EmailAlreadyExists | |
| FailedOperation.UserOverUpperLimit | |
| LimitExceeded.CreateUserLimitExceeded |