User Parent topic

Parameter
Data Type
Description
Required?
user
Container
The container of information about a user.
Property type: Element
Yes
user.id
String
The GUID of the user.
Property type: Attribute
Yes
user.loginname
String
The user login name.
Property type: Attribute
Yes
user.usertype
String
The platform that manages the user.
Property type: Attribute
Valid values:
  • localuser—user is managed by SecureCloud.
  • aduser—user is managed by Trend Micro Active Directory.
  • ssouser—user is managed by Trend Micro Licensing Management Platform.
Yes
user.href
String
The callback URL to obtain information about this user.
Property type: Attribute
Yes
user.authType
String
The means of authentication for the user.
Property type: Attribute
Valid values:
  • Local Authentication—user is authenticated by SecureCloud.
  • SSO—user is authenticated by Trend Micro Licensing Management Platform's Single Sign On.
Yes
user.version
Double
The message version.
Property type: Attribute
No
user.logintext
String
The new logon passphrase for the user.
Property type: Attribute
No
user.lastlogintext
String
The old logon passphrase for the user.
Property type: Attribute
No
user.lastModified
DateTime
The date and time this user was last modified.
Property type: Attribute
Valid value: a date and time in the format "yyyy-MM-ddThh:mm:ss.sss, UTC"
No
user.isPending
Boolean
Indicates whether the user is waiting for activation.
Property type: Attribute
No
user.isCurrent
Boolean
Indicates whether this the user currently logged on.
Property type: Attribute
No
user.ssoIdPName
String
The IdP name used for Single Sign On.
Property type: Attribute
No
user.MFAStatus
Integer
The status of Multi-factor Authentication (MFA).
Property type: Attribute
Valid values:
  • 0—MFA is disabled.
  • 1—MFA is enabled.
  • 2—MFA has been created.
  • 3—MFA is in use.
No
user.Role
Container: Role
The container of information about a user role.
Property type: Element
Valid values:
  • Account Administrator
  • Auditor
  • Key Approver
  • Data Analyst
  • Security Administrator
No
user.Account
Container: Account
The container of account information about the user.
Property type: Element
No
user.contact
Container
The container of the user's contact information.
Property type: Element
No
contact.firstName
String
The user's first name.
Property type: Element
Yes
contact.lastName
String
The user's last name.
Property type: Element
Yes
contact.email
String
The user's email address.
Property type: Element
Yes