Create a user

post

https://{hostname}/identity-management/v2/user-admin/ui-identities

Create a user in the account specified in your own API client credentials or clone an existing user's role assignments. Optionally, send 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 password is included in the response.

Query Params

sendEmail

boolean

Defaults to false

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

accountSwitchKey

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

Specifies a user.

address

string

The user's street address.

authGrants

array of objects

required

The user's role assignments, per group.

authGrants*

city

string

The user's city.

cloneFrom

string

The username to clone a user's authGrants from. If you provide this member in a POST request, don't include the authGrants member in the request too.

contactType

string

To help characterize the user, this can be any value available from the View contact types operation.

country

string

required

Part of the user's location. This can be any value available from the View supported countries operation.

string

required

The user's email address.

firstName

string

required

The user's first name.

jobTitle

string

The user's job title.

lastName

string

required

The user's last name.

mobilePhone

string

The user's mobile phone number, represented as a 10-digit integer within a string.

notifications

object

Emails the user can receive for their products.

phone

string

required

The user's main phone number, represented as a ten-digit integer within a string.

preferredLanguage

string

This can be any value available from the View languages operation.

secondaryEmail

string

The user's alternate email address.

sessionTimeOut

integer

The number of seconds it takes for the user's Control Center session to time out if there hasn't been any activity. This corresponds to the value from the View timeout policies operation's response.

state

string

The name of the state where the user is located.

tfaEnabled

boolean

When enabled, two-factor authentication confirms the user's identity.

timeZone

string

The user's time zone. The value can be any that are available from the View time zones operation.

timezone

string

The user's time zone. The value can be any that are available from the View time zones operation.

zipCode

string

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

Response

200The response returns the created user.