UserData

The user object contains all relevant meta-data for the user.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

id

The user's system ID

-

string

uuid

userName

The user's login name.

-

string

password

-

string

firstName

The user's first name.

-

string

lastName

The user's last name.

-

string

email

The user's email.

-

string

mobilePhone

The user's mobile phone.

-

string

secondaryMobilePhone

The user's secondary mobile phone.

-

string

adminType

The user's administration type flag.

-

AdminType

roles

The role object contains meta-data for the role.

-

RoleData []

userSettings

-

UserSettingsData

clientLicenseType

The user's client license type.

-

ClientLicenseType

statusID

The user's system status.

-

integer

int32

adDomain

The user's AD domain (if relevant).

-

string

adAccount

The user's AD username (if relevant).

-

string

adSid

The user's AD SID (if relevant).

-

string

proxyAccount

-

string

upgradeVersion

-

string

adGuid

The user's AD GUID (if relevant).

-

string

createdDate

-

integer

int64

modifiedDate

-

integer

int64

lastLoginDate

-

integer

int64

version

-

string

tenantId

The user's tenant (ID).

-

string

principalName

The user's principal name (UPN).

-

string

privateProfileId

-

string

tenantsInfo

-

TenantInfo []

newUserId

-

string

uuid

migratedUser

-

boolean

tenantName

-

string

userWorkspace

-

UserWorkspaceSettings

profilePicture

-

string

Usages
  • /API/admin/createUser
  • /API/admin/createUsers
  • /API/admin/deleteUser
  • /API/admin/getAllUsersByCurrentTenant
  • /API/admin/getUser
  • /API/admin/getUserList
  • /API/admin/getUserStatus
  • /API/admin/getUsersByName
  • /API/admin/getUsersByRole
  • /API/admin/updateUser