API Reference

create a new user

post
https://user.domain.com/api/open/v1/users

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 128

User email.

password
required
length ≤ 64

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

boolean

Require to change password when user login

string
enum
required

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

  • member - member
  • admin - team administrator
Allowed:
int32
0 to 2147483647

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

string
enum
required

For creating user, only local_user category can be allowed.

  • local_user - general user
Allowed:
boolean

SOS capability settings of the user, false by default.

boolean

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

boolean

Status settings of the user, false by default.

Responses

Updated about 2 years ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago