Identity
The User domain object represents a user who has access to the platform. The type of access provided is governed by the roles of the user. For example, with a role of AccountManager, a user has access to an account (see Organization Management), whereas with an Agent (CSR) role the user is restricted to acting as an agent on the platform.
Basic attributes of the user include their first and last names as well as their email address and Time Zone. Users are normally created ahead of time, but can be created dynamically as needed.
User
| Field
|
Type
|
Description
|
Since
|
| externalId
|
string
|
Unique login id
|
7.3.3
|
| loginEnabled
|
Boolean
|
Is agent allowed to login through an interface?
|
7.3.3
|
| locale
|
string
|
Locale information (See locale section in Other Types)
|
7.3.3
|
| firstName
|
string
|
First name of user
|
7.3.3
|
| lastName
|
string
|
Last name of user
|
7.3.3
|
| timeZone
|
string
|
User’s time zone
|
7.3.3
|
| email
|
string
|
User’s contact email address
|
7.3.3
|
| roles
|
string[]
|
Roles of user (see Appendix for supported roles)
|
7.3.3
|
| defaultPhoneNumber
|
string
|
User’s contact phone number
|
7.3.3
|
| preferences
|
Attribute[]
|
Persistent user context as set of name/value pairs
|
7.7.0
|
| createdDate
|
dateTime
|
Entity created date
|
7.3.3
|
| updatedDate
|
dateTime
|
Entity last modified date
|
7.3.3
|
| createdBy
|
User (K)
|
Abbreviated creator
|
U
|
| modifiedBy
|
User (K)
|
Abbreviated modifier
|
U
|
Attributes
| Attribute
|
Type
|
Type Qualifier
|
Description
|
Since
|
| passwordExpirationDate
|
dateTime
|
User
|
Date that this users password will expire
|
7.5.0
|
| passwordChangeRequired
|
Boolean
|
User
|
If true user must change password at next login
|
8.5.0
|
| registrationMethod
|
registrationMethods
|
Agent
|
How does agent connect
|
8.5.0
|
| registrationPhoneNumber
|
string
|
Agent
|
Phone Number to register
|
8.10
|
| tags
|
string
|
Agent
|
Comma separated tags associated with agent
|
11.2
|
| securityQuestionId1
|
string
|
User
|
Users first security question's internal id
|
11.8
|
| securityQuestionId2
|
string
|
User
|
Users second security question's internal id
|
11.8
|
| securityQuestionId3
|
string
|
User
|
Users third security question's internal id
|
11.8
|
| securityQuestionText1
|
string
|
User
|
Users first security question's text
|
11.8
|
| sercurityQuestionText2
|
string
|
User
|
Users second security question's text
|
11.8
|
| sercurityQuestionText3
|
string
|
User
|
Users third security question's text
|
11.8
|
| sercurityQuestionAnswer1
|
string
|
User
|
Users first security question's answer
|
11.8
|
| sercurityQuestionAnswer2
|
string
|
User
|
Users second security question's answer
|
11.8
|
| securityQuestionAnswer3
|
string
|
User
|
Users third security question's answer
|
11.8
|
| emailValidationDate
|
string
|
User
|
When was user's email address validated?
|
11.8
|
| failedPasswordResetAttempt
|
string
|
User
|
Number of times user has failed password reset attempt
|
11.8
|
PasswordResetRequest
| Field
|
Type
|
Description
|
Since
|
| user
|
User (K)
|
Abbreviated owning user
|
11.9
|
| owner
|
Org (K)
|
Abbreviated owning enterprise detais
|
11.9
|
| createdDate
|
dateTime
|
Entity created date
|
11.9
|
| updatedDate
|
dateTime
|
Entity last modified date
|
11.9
|
| createdBy
|
User (K)
|
Abbreviated creator
|
11.9
|
| modifiedBy
|
User (K)
|
Abbreviated modifier
|
11.9
|
Attribute
| Attribute
|
Type
|
Type Qualifier
|
Description
|
Since
|
| url
|
String
|
User
|
Url for validating password reset request.
|
11.9
|
ContactPointValidation
| Field
|
Type
|
Description
|
Since
|
| user
|
User (K)
|
Abbreviated owning user
|
11.9
|
| createdDate
|
dateTime
|
Entity created date
|
11.9
|
| updatedDate
|
dateTime
|
Entity last modified date
|
11.9
|
| createdBy
|
User (K)
|
Abbreviated creator
|
11.9
|
| modifiedBy
|
User (K)
|
Abbreviated modifier
|
11.9
|
Attribute
| Attribute
|
Type
|
Type Qualifier
|
Description
|
Since
|
| url
|
String
|
User
|
Url for validating password reset request.
|
11.9
|
