Document toolboxDocument toolbox

User Object

Owned by Andrew Hill (Deactivated)
Last updated: Oct 17, 2024 by Jason Andrew

The User object contains properties related to a user. Users include mobile workers or technicians, planners, managers and administrators. 

On this page:

Related pages:

User Object Formats

JSON Format 
 {
	"Activated": true,
	"AuthenticationID": "",
	"Deleted": false,
	"DGroupID": "",
	"Email": "",
    "EnableMobileDiagnostics": false,
	"Extensions": {
		"key1": "value1",
		"key2": "value2"
	},
	"FaceTime": "",
	"FirstName": "",
	"IsMobileWorker": true,
	"LanguageCode": "",
	"LastName": "",
	"Locked": false,
	"Password": "",
	"Phones": [{
		"PhoneNum": "",
		"PhoneType": ""
	}],
	"ResetPassword": false,
	"ServiceTeamID": "",
	"SMS": "",
	"Status": "",
	"StorageLocationID": "",
	"UserID": ""
}

User Object Properties

(info) 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:

  • true - User is active and can use the system.
  • false - User is not active and can not logon to the system.
AuthenticationIDstring

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.

3.32.0

Deleted

boolean

Identifies if the user record is to be deleted.

Notes:

  • This field is only used in conjunction with the Bulk APIs
  • Individual users can be deleted using the DELETE method of the User REST API

Valid values are:

  • true - The user object should be deleted
  • false - The user object should not be deleted. This is the default value if this property is not specified.


DGroupIDstringSpecifies the Deployment Group the user is assigned to.

Email


Specifies the email address of the user.

EntityEmployeeNumber

string

This property is deprecated. Please use the Extensions property instead.

EnableMobileDiagnostics

boolean

Specifies if the capability to collect diagnostics information is enabled for a mobile worker. 

Valid values are:

  • true - ServiceMobility will record session for diagnostics
  • false - ServiceMobility will not collect and record sessions. This is the default value if this property is not specified.

4.10.2

Extensions

collection

This object contains an optional collection of key/value pairs.

These key/value are defined and controlled by the customer and are typically used to assist in integration by pass additional data around the system.

FaceTime

string

Identifies the Apple FaceTime ID associated with the user.

FirstName

string

Identifies the first name of the user.

Lockedboolean

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:

  • true - The user is locked out of the system
  • false (default) - The user is not locked out of the system

3.13

IsMobileWorkerbool

Identifies if the user is a mobile worker. If true, then this user has access to the ServiceMobility mobile application.

Valid values are:

  • true - The user is a mobile worker
  • false (default) - This user is not a mobile worker

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

PropertyTypeDescription
PhoneNumstringThe phone number.
PhoneTypestring

Identifies the type of phone number.

See: Phone Types

Password

string

Identifies the password for the user.

Passwords are always stored encrypted with a unique user cryptography salt value.

Password Requirements

  • Minimum length: 8
  • Maximum length: 64

Valid passwords will contain at least the minimum number of characters from each section

SectionValid ValuesMinimum Count
Lower Casea-z1
Upper CaseA-Z1
Number0-91
Special Characters!#%&?+*_.,:;1

4.15.0

ResetPassword

boolean

Identifies if the password should be reset to the value specified by the Password property.

Valid values are:

  •  true = The password will be reset to the value identifies by the Password property
  •  false = The password will not be reset. This is the default value if this property is not provided.
ServiceTeamIDstring

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.

3.20.0

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.