Creates a user.
Try it now
Test
RAM authorization
Request syntax
POST /v2/user/create HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
Request body parameters. |
|
| user_id |
string |
Yes |
User ID. Maximum length is 64 characters. Cannot contain the # character. |
pdsuserid1 |
| nick_name |
string |
No |
Nickname. Maximum length is 128 characters. |
pdsuer |
| status |
string |
No |
User status. Default is enabled.
|
enabled |
| role |
string |
No |
Role. Default is user.
If your domain supports subdomains, you can also use subdomain_super_admin or subdomain_admin. Valid values:
|
user |
| avatar |
string |
No |
Profile picture URL. If using HTTP, start the URL with http:// or https://. Maximum length is 4 KB. If using data URI format, start with data:// and use Base64 encoding. Maximum length is 300 KB. |
http://a.b.c/pds.jpg |
| phone |
string |
No |
Phone number. |
13900001111 |
|
string |
No |
Email address. |
123@pds.com |
|
| user_data |
object |
No |
Custom user data. Maximum length is 1024 characters. |
md |
|
any |
No |
|||
| group_info_list |
array<object> |
No |
Audience group information. |
|
|
object |
No |
|||
| group_id |
string |
No |
Group ID. |
g123 |
| user_name |
string |
No |
Username. Maximum length is 128 characters. |
pdsusername |
| description |
string |
No |
User description. Maximum length is 1024 characters. |
The VIP user |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Response data. |
||
| domain_id |
string |
Domain ID. |
bj1 |
| user_id |
string |
User ID. |
dingding_abc001 |
| avatar |
string |
Profile picture URL. |
http://aa.com/1.jpg |
| created_at |
integer |
Creation time in milliseconds since Unix epoch (00:00:00 UTC on January 1, 1970). |
1639762579768 |
| updated_at |
integer |
Last update time in milliseconds since Unix epoch (00:00:00 UTC on January 1, 1970). |
1639762579768 |
| nick_name |
string |
Nickname. |
001 |
| user_name |
string |
Username. |
pds |
| phone |
string |
Phone number. |
13900001111 |
|
string |
Email address. |
a@a.com |
|
| role |
string |
Role.
Valid values:
|
admin |
| status |
string |
Status.
Valid values:
|
enabled |
| description |
string |
Description. |
vipuser |
| default_drive_id |
string |
Default drive ID. |
1 |
| user_data |
object |
Custom user data. |
|
|
any |
Custom property. |
dog |
|
| creator |
string |
Creator. |
user1 |
Examples
Success response
JSON format
{
"domain_id": "bj1",
"user_id": "dingding_abc001",
"avatar": "http://aa.com/1.jpg",
"created_at": 1639762579768,
"updated_at": 1639762579768,
"nick_name": "001",
"user_name": "pds",
"phone": "13900001111",
"email": "a@a.com",
"role": "admin",
"status": "enabled",
"description": "vipuser",
"default_drive_id": "1",
"user_data": {
"key": "dog"
},
"creator": "user1"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.