Update a user

PUT https://{{host}}/identity-management/v3/user-admin/ui-identities/:uiIdentityId/basic-info

This operation modifies a user's basic information. Pass the entire body of data in the request, including members you're not changing, or the unspecified data are removed. To edit detailed settings, run the Modify a user's group and role assignments or Update a user's notifications operations.

Request Params

KeyDatatypeRequiredDescription
accountSwitchKeystring(Optional) 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.

Request Body

{"additionalAuthentication"=>"TFA", "address"=>"first Street", "city"=>"Santa Clara", "contactType"=>"Billing", "country"=>"USA", "firstName"=>"John", "jobTitle"=>"Engineer", "lastName"=>"Smith", "mobilePhone"=>"3456787657", "phone"=>"3456788765", "preferredLanguage"=>"English", "secondaryEmail"=>"john.smith@example.com", "sessionTimeOut"=>30, "state"=>"CA", "timeZone"=>"GMT", "zipCode"=>"34567"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"additionalAuthentication":"TFA","additionalAuthenticationConfigured":false,"address":"first Street","city":"Santa Clara","contactType":"Billing","country":"USA","email":"jsmith@example.com","firstName":"John","isLocked":false,"jobTitle":"Engineer","lastLoginDate":"2016-04-12T20:54:24.000Z","lastName":"Smith","mobilePhone":"3456787657","passwordExpiryDate":"2023-04-12T20:54:24.000Z","phone":"3456788765","preferredLanguage":"English","secondaryEmail":"john-smith@example.com","sessionTimeOut":30,"state":"CA","timeZone":"GMT","uiIdentityId":"1-ABCDE","uiUserName":"jsmith","zipCode":"34567"}