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:
|
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:
|
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:
|
No
|
user.Role
|
Container: Role
|
The container of information about a user role.
Property type: Element
Valid values:
|
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
|