Skip to main content
POST
/
users
Create a user
curl --request POST \
  --url https://api.smokeball.com/users \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "user@domain.com",
  "password": "<string>",
  "expireAfterDays": 7,
  "isInternal": true,
  "bypassMfa": true
}
'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Body

​
email
string
required

Email address of the user.

Minimum string length: 1
Example:

"user@domain.com"

​
password
string | null

Password for the user.

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

​
expireAfterDays
integer<int32> | null

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

Example:

7

​
isInternal
boolean

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.

Example:

true

​
bypassMfa
boolean

Bypasses multi-factor authentication for the user.

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

Example:

true

Response

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

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET