UpdateUserObject

Represents a user to be updated in the system

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

id

The user's system ID.

Y

string

uuid

userName

The login username for the user. Requires that the password field is also specified

-

string

firstName

The user's first name

-

string

lastName

The user's last name

-

string

email

The user's email

-

string

phone

The user's phone

-

string

proxyAccount

The user's proxy account needed for connecting to different data sources

-

string

proxy2

The user's second proxy account needed for connecting to different data sources

-

string

adminType

The user's administration level using the admin type enumeration

-

AdminType

roleIds

The user's list of roles

-

string [ ]

clientLicenseType

The user's license type using the type enumeration

-

ClientLicenseType

statusID

The user's status using the status type enumeration

-

UserStatus

tenantId

The user's tenant ID

-

string

profileId

The profile ID to be applied for this user

-

string

profileType

The user's profileType

-

UserProfileType

language

The user's language

-

LanguageType

password

User's password. Relevant for all DB users and enterprise admins in OpenID/SAML authentications

-

string

*Required elements are only used for API parameters

Usages
  • /API3/access/updateUsers