Update a user

put

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

Modify user information. Pass the entire body of data in the request, including members you're not changing. Otherwise, the operation removes unspecified data.

Path Params

uiIdentityId

string

required

A unique identifier for a user.

Query Params

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 user's profile.

address

string

The user's street address.

city

string

The user's city.

contactType

string

Any of the values available from the View contact types operation.

country

string

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

string

The user's email address.

firstName

string

length between 1 and 50

The user's first name.

jobTitle

string

length between 1 and 75

The user's job title.

lastName

string

length between 1 and 50

The user's last name.

mobilePhone

string

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

phone

string

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

preferredLanguage

string

Any of the values 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 output of the View timeout policies operation.

state

string

The user's state if country=USA, or the user's province if country=Canada. For all other countries, this field is optional.

tfaEnabled

boolean

Indicates whether two-factor authentication is enabled.

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 updated user's profile.