PyramidUserObject

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

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

-

AdminType

secondaryMobilePhone

The user's secondary mobile phone.

-

string

proxyAccount

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

-

string

clientLicenseType

The user's license type using the type enumeration

-

ClientLicenseType

language

The user's language

-

LanguageType

principalName

The user's SAML identifier (relevant in case the user is authenticated using SAML)

-

string

lastLoginDate

The number representation of the user last login date

-

integer

int64

userName

The login username for the user

-

string

firstName

The user's first name

-

string

createdDate

The number representation of the user creation date

-

integer

int64

roleIds

The user's list of roles

-

string [ ]

statusID

The user's status using the status type enumeration

-

UserStatus

phone

The user's phone

-

string

domainName

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

-

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

email

The user's email

-

string

*Required elements are only used for API parameters

Usages
  • /API3/access/getMe
  • /API3/access/getTenantUsersByUserType
  • /API3/access/getUser
  • /API3/access/getUserByPrincipalName
  • /API3/access/getUsersByName
  • /API3/access/getUsersByRole