Post

post

https://api.formant.io/v1/admin/users

Create a new user.
Resource: users
Authorized roles: administrator

Body Params

CreateUserRequest

password

string

length ≥ 8

Enter a password for this user. If you don't fill in this field, the user will receive an email prompt to set a password.

emailConfigurationId

uuid

createdAt

date-time

updatedAt

date-time

tags

object

organizationId

uuid

ID of the organization to which this user belongs.

accountId

uuid | null

ID of the account to which this user belongs.

roleId

uuid | null

required

ID of this user's role.

string

required

Email address of this user.

externalUserId

string | null

Ignore this - for internal use only.

firstName

string

required

length ≤ 255

First name of this user.

lastName

string

length ≤ 255

Last name of this user.

scope

object

teamId

uuid | null

ID of the team to which this user belongs.

phoneNumber

string

User's phone number (e.g., +14155550100).

enabled

boolean

Enable or disable this user. Set this to False to delete this user.

isOrganizationOwner

boolean

Should this user have organization owner privileges?

termsAccepted

string

Has this user accepted Formant terms and conditions?

lastLoggedIn

date-time

passwordHash

string | null

isSingleSignOn

boolean

smsOptInStatus

string | null

enum

Allowed:

region

string

enum

Allowed:

isServiceAccount

boolean

allowCustomEmailConfiguration

boolean

jobTitle

string

language

string

enum

Allowed:

units

string

enum

Allowed:

timezone

string

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201