v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Users

Create a user

Creates a user.

Sends an email with a generated password if the password is missing.

post/users

Request body

emailstring required

Email address of the user.

passwordstring nullable

Password for the user.

Password must include atleast one lowercase character, uppercase character, numeric character as well as a special character.

expireAfterDaysinteger nullable

Expire after the specified days. Must be left blank for users that do not expire.

isInternalboolean

Creates the user as an internal user.

Internal users are excluded from billing and license counts.

Use this option for testing, background services, or other non-customer-facing purposes.

bypassMfaboolean

Bypasses multi-factor authentication for the user.

When enabled, the user will not be prompted for two factor authentication during login.

Example request

{
  "email": "user@domain.com",
  "expireAfterDays": 7,
  "isInternal": true,
  "bypassMfa": true
}

Response

When request is accepted. Returns a hypermedia 'Link' object of the user to be created.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable