User Object Formats
| Include Page | ||||
|---|---|---|---|---|
|
User Object Properties
Required properties are in bold.
Property | Type | Description | |||||||||
Activated | boolean | Identifies is the user record is activated. If not activated the user will be unable to logon to the system. Valid values are:
| |||||||||
| AuthenticationID | string | When ServicePower enables the entity to run within a unique domain for SSO purposes, the system will utilize this field for authentication purposes. User API will replicate value of the required UserID field into the AuthenticationID field, in the case that an AuthenticationID value hasn't been provided. It is highly recommended that an AuthenticationID value be provided when the customer is using either 3rd party authentication or a custom domain.
| |||||||||
Deleted | boolean | Identifies if the user record is to be deleted. Notes:
Valid values are:
| |||||||||
| DGroupID | string | Specifies the Deployment Group the user is assigned to. | |||||||||
| Specifies the email address of the user. | ||||||||||
EntityEmployeeNumber | string |
| |||||||||
Extensions | collection |
| |||||||||
FaceTime | string | Identifies the Apple FaceTime ID associated with the user. | |||||||||
FirstName | string | Identifies the first name of the user. | |||||||||
| Locked | bool | Identifies is the user account is locked. If true, then this user will not be able to access the Nexus management console or the ServiceMobility mobile application. An administrator has the ability to lock any user (except their own). Valid values are:
3.13 | |||||||||
| IsMobileWorker | bool | Identifies if the user is a mobile worker. If true, then this user has access to the ServiceMobility mobile application. Valid values are:
v.3.13 | |||||||||
LanguageCode | string | Identifies the language in which the mobile application will be run for the user. If the mobile application does not have the selected language translations deployed it will default to English. | |||||||||
LastName | string | Identifies the last name of the user. | |||||||||
Phones | collection | A collection of phone numbers associated with the contact. Phone Properties
| |||||||||
Password | string | Identifies the password for the user. Passwords are always stored encrypted with a unique user cryptography salt value. | |||||||||
ResetPassword | boolean | Identifies if the password should be reset to the value specified by the Password property. Valid values are:
| |||||||||
| ServiceTeamID | string | Identifies the service team the user is associated with. This field should be populate for any user that is a field technician / worker. If the user is a manager or planner then this field can be left empty.
| |||||||||
SMS | string | This field contains the number used to send SMS to the user. Typically this is a user's mobile phone number. | |||||||||
Status | string | Future. This field is currently not used. | |||||||||
StorageLocationID | string | Identifies the storage location assigned to the user. When the user is using the mobile application this is the inventory location where parts will be consumed from. If you are not using / tracking inventory then this field can be left blank. | |||||||||
UserID | string | This field represents the user's logon to the system. This includes both the portal and mobile application. Note, based on the user's roles access either the portal or mobile application may be restricted. |