Add user

Create a new user and return the user's information.

  • The contact email of the new user is set to email; the returned email is the internal user ID.
  • contact_email is no longer accepted as a parameter (v13).
  • If email sending is configured, the new user receives an invitation email (see add_user_tip).
  • If enforced for your SecureCloud instance, the user must change the password on first login.

Permission: System admin (is_staff) whose admin role grants can_manage_user. Admin roles with a restricted permission set (e.g. audit_admin, system_admin) receive 403.

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

Email address of the new user.

string
required

Initial password.

boolean
Defaults to false

Create the user as system admin.

boolean
Defaults to true

Activate the account.

string

User role (Pro only), must be one of the configured roles, e.g. default or guest.

string
length ≤ 64

Display name, max. 64 characters, must not contain /.

string

Unique login ID.

integer
≥ 0

Quota in MB (>= 0). In an organization context it must not exceed the organization quota.

Responses

400

Invalid parameter (email invalid., password required., role must be in [...], name too long, invalid quota), user or login ID already exists, or the licensed number of users is exceeded.

403

Permission denied: the account is not a system admin, or its admin role lacks the required admin permission.

500

Internal server error.

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