PyramidUserObject

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

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

createdDate

The number representation of the user creation date

 -

integer

int64

lastLoginDate

The number representation of the user last login date

 -

integer

int64

domainName

The user's domain name (relevant in case the user is authenticated using LDAP)

 -

string

externalId

The user's external identifier

 -

string

secondaryMobilePhone

The user's secondary mobile phone.

 -

string

id

The user's system ID.

Y

string

uuid

userName

The login username for the user

 -

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

language

The user's language

 -

LanguageType

*Required elements are only used for API parameters

Usages
  • /API3/access/findUser
  • /API3/access/getMe
  • /API3/access/getTenantUsersByUserType
  • /API3/access/getUser
  • /API3/access/getUserByExternalId
  • /API3/access/getUsersByName
  • /API3/access/getUsersByRole