UpdateUserObject
Represents a user to be updated in the system
API Section: Objects
Type: Object
Properties
Name |
Description |
Required |
Type |
Format |
---|---|---|---|---|
lastName |
The user's last name |
- |
string |
|
adminType |
The user's administration level using the admin type enumeration |
- | ||
proxyAccount |
The user's proxy account needed for connecting to different data sources |
- |
string |
|
clientLicenseType |
The user's license type using the type enumeration |
- | ||
language |
The user's language |
- | ||
principalName |
The user's external principal name. Only supported in OpenID/SAML authentications |
- |
string |
|
userName |
The login username for the user. Requires that the password field is also specified |
- |
string |
|
firstName |
The user's first name |
- |
string |
|
password |
User's password. Relevant for all DB users and enterprise admins in OpenID/SAML authentications |
- |
string |
|
roleIds |
The user's list of roles |
- |
string [ ] |
|
statusID |
The user's status using the status type enumeration |
- | ||
profileType |
The user's profileType |
- | ||
phone |
The user's phone |
- |
string |
|
profileId |
The profile ID to be applied for this user |
- |
string |
|
tenantId |
The user's tenant ID |
- |
string |
|
id |
The user's system ID. |
Y |
string |
uuid |
proxy2 |
The user's second proxy account needed for connecting to different data sources |
- |
string |
|
|
The user's email |
- |
string |
*Required elements are only used for API parameters