Create a new user

post {protocol}://{userdomain}:{port}/api/open/v1/users

Creates a new user, currently just support to create a new gateway user.

Body Params

account

string

required

length ≤ 128

User email.

pwd

password

required

length ≤ 64

Password, minimum eight characters, at least one letter, one number and one special character:.

change_pwd_on_login

boolean

Require to change password when user login

role

string

required

For creating user, only member or admin role can be allowed.

member - member
admin - team administrator

group

int32

0 to 2147483647

The ID of the group the user is associated. For default group, its group id is 0.

category

string

required

For creating user, only local_user category can be allowed.

local_user - general user

sos

boolean

SOS capability settings of the user, false by default.

web

boolean

Web access capability settings of the user, false by default.

status

boolean

Status settings of the user, false by default.

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://user.domain.com:443/api/open/v1/users \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "role": "member",
8
  "category": "local_user"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response.

429Error response for too many request.

defaultDefault api error response.