Create a user

This operation creates a user, or clones an existing user's role assignments, in the account specified in your API client credentials. Optionally, this sends a randomly generated one-time use password to the new user. If you send the email with the password directly to the user, the response for this operation doesn't include that password. If you don't send the password to the user through email, the operation's response returns the password.

Query Params
boolean
Defaults to true

Sends a one-time password to the new user, true by default.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Represents a request to create a new user with specified details and access permissions.

string
enum
required

Specifies the user's multi-factor authentication method, confirming their identity. Either TFA, MFA, or NONE, which offers no additional authentication.

Allowed:
string
length ≥ 1

The user's street address.

authGrants
array
required
length ≥ 1

The user's role assignments, per group. You need to assign at least one role to a user, with only one role allowed for the user per group. Account level roles are optional. Provide either this or the cloneFrom.

authGrants*

The user's role assignments, per group. Provide either this or the cloneFrom.

integer
required
≥ 0

Unique identifier for each group. To get this value, run the List groups operation.

string
length ≥ 1

Descriptive label for the group.

boolean

Blocks a user's access to a group.

string
length ≥ 1

Descriptive label for the role to convey its use.

integer | null
required
≥ 1

Unique identifier for each role. To get this value, run the List roles operation. You need to assign at least one role to a user, with only one role allowed for the user per group. Setting the value to null in POST leaves the default role: either unassigned or cascaded from a parent group. For PUT, it clears the current assignment and reverts it to the default role.

string
length ≥ 1

Descriptive label for the role.

subGroups
array of objects
length ≥ 0

Children of the parent group. Permissions cascade downward from parent to child unless the child group's isBlocked is true.

subGroups
string
length ≥ 1

The user's city.

string
length ≥ 1

The username to clone a user's authGrants from. Provide either this or the authGrants.

string
length ≥ 1

User's contact type. To get the available values, run the View contact types operation.

string
required
length ≥ 1

User's country. To get the available values, run the View supported countries operation.

string
required

The user's email address. It needs to be a valid email address users can access, as they'll be sent an OTP to enter while logging in for the first time. To learn more, see Frequently asked questions.

string
required
length ≥ 1

The user's first name.

string
length ≥ 1

The user's position at the company.

string
required
length ≥ 1

The user's surname.

string
length ≥ 1

The user's mobile phone number in ITU-T E.164 format, expressed as +country code-area code-subscriber number. For Canadian and US phone numbers, you can omit the country code. For example, +16175550142 or 6175550142.

notifications
object

Specifies email notifications the user receives for products.

string
length ≥ 1

The user's phone number in ITU-T E.164 format, expressed as +country code-area code-subscriber number. For Canadian and US phone numbers, you can omit the country code. For example, +16175550142 or 6175550142.

string
length ≥ 1

The user's language. To get the available values, run the View languages operation.

string

The user's alternate email address.

integer
≥ 0

The number of seconds it takes for the user's Control Center session to time out after no activity. To get the available values, run the View timeout policies operation. Make sure to select a value that's equal or smaller to the Max session timeout value, set for your account in the Identity and Access Management interface's Settings tab.

string
length ≥ 1

The user's state or province if user's country is USA or Canada. To get the available values, run the View states for a user profile operation.

string
length ≥ 1

The user's time zone. To get the available values, run the View time zones operation.

string
length ≥ 1

The user's five-digit postal code, represented as a string.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json