Skip to main content
POST
Create a user

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Body

application/json
name
string
required
Required string length: 1 - 200
email
string<email>
required

The new user's email address. They sign in with it and receive their password link there.

Maximum string length: 254
role
string

Instance role, as for updates. Defaults to the instance's default role for new users.

Required string length: 1 - 64

Response

The new user

user
object
required
passwordSetupEmail
enum<string>
required

Whether the link to choose a password was emailed: not_configured without SMTP, not_needed when the account is for single sign-on. The link itself is never returned.

Available options:
sent,
failed,
not_configured,
not_needed