@fairfleet/geotab / User
A user of the system. A user can be a MyGeotab user or a user that is a Driver.
-
↳
User↳↳
Driver
- acceptedEULA
- accessGroupFilter
- activeDashboardReports
- activeFrom
- activeTo
- authorityAddress
- authorityName
- availableDashboardReports
- bookmarks
- cannedResponseOptions
- carrierNumber
- changePassword
- comment
- companyAddress
- companyGroups
- companyName
- countryCode
- dateFormat
- defaultGoogleMapStyle
- defaultHereMapStyle
- defaultMapEngine
- defaultOpenStreetMapStyle
- defaultPage
- designation
- displayCurrency
- displayMeasurementProfile
- driveGuideVersion
- electricEnergyEconomyUnit
- employeeNo
- featurePreview
- firstDayOfWeek
- firstName
- fuelEconomyUnit
- groups
- hosRuleSet
- id
- isAdverseDrivingEnabled
- isDriver
- isEULAAccepted
- isEmailReportEnabled
- isExemptHOSEnabled
- isLabsEnabled
- isMetric
- isNewsEnabled
- isPersonalConveyanceEnabled
- isServiceUpdatesEnabled
- isYardMoveEnabled
- issuerCertificate
- language
- lastAccessDate
- lastName
- mapViews
- maxPCDistancePerDay
- mediaFiles
- name
- nullifyAccessGroupFilter
- password
- phoneNumber
- phoneNumberExtension
- privateUserGroups
- reportGroups
- securityGroups
- showClickOnceWarning
- timeZoneId
- userAuthenticationType
- version
- wifiEULA
- windowsAuthenticationUserId
- zoneDisplayMode
• acceptedEULA: number
Gets or sets a value indicating the user accepted MyGeotab EULA revision number. Default [null].
src/types/Checkmate/ObjectModel/User.ts:24
• accessGroupFilter: GroupFilter
Gets or sets the GroupFilter that the user belongs to, which is used to determine what the user can see within the database.
src/types/Checkmate/ObjectModel/User.ts:26
• activeDashboardReports: string[]
Gets or sets the list of active dashboards for the user, displayed on the dashboard page. Default [empty].
src/types/Checkmate/ObjectModel/User.ts:28
• activeFrom: Date
Gets or sets the date the user is active from. Default [UtcNow].
src/types/Checkmate/ObjectModel/User.ts:30
• activeTo: Date
Gets or sets the date the user is active to. Default [MaxDate].
src/types/Checkmate/ObjectModel/User.ts:32
• authorityAddress: string
Gets or sets the HOS authority address of the user. Default [""].
src/types/Checkmate/ObjectModel/User.ts:34
• authorityName: string
Gets or sets the HOS authority name of the user. Default [""].
src/types/Checkmate/ObjectModel/User.ts:36
• availableDashboardReports: string[]
Gets or sets list of all available dashboard reports to the user. Default [empty].
src/types/Checkmate/ObjectModel/User.ts:38
• bookmarks: string[]
Gets or sets the list of bookmarked pages. Default [empty].
src/types/Checkmate/ObjectModel/User.ts:40
• cannedResponseOptions: string[][]
Gets or sets the user's stored list of custom response options to choose from when sending a TextMessage. Each item is a set of predefined response options. Default [empty].
src/types/Checkmate/ObjectModel/User.ts:42
• carrierNumber: string
Gets or sets the carrier number. Default [""].
src/types/Checkmate/ObjectModel/User.ts:44
• changePassword: boolean
Gets or sets a flag indicating whether the user's password requires resetting. If [true], the user will be forced to change their password on next login. Default [false].
src/types/Checkmate/ObjectModel/User.ts:46
• comment: string
Gets or sets free text field where any user information can be stored and referenced for this entity. Default [""].
src/types/Checkmate/ObjectModel/User.ts:48
• companyAddress: string
Gets or sets the company address for the user. Default [""].
src/types/Checkmate/ObjectModel/User.ts:50
• companyGroups: Group[]
Gets or sets the list of organization Group(s) that the user belongs to.
src/types/Checkmate/ObjectModel/User.ts:52
• companyName: string
Gets or sets the name of the company for the user. Default [""].
src/types/Checkmate/ObjectModel/User.ts:54
• countryCode: string
Gets or sets the user two symbols country ISO code (https://www.iso.org/iso-3166-country-codes.html). Maximum length [2] Default [""]
src/types/Checkmate/ObjectModel/User.ts:56
• dateFormat: string
Gets or sets the format dates will be displayed to this user. Default ["MM/dd/yy HH:mm:ss"].
src/types/Checkmate/ObjectModel/User.ts:58
• defaultGoogleMapStyle: GoogleMapStyle
Gets or sets the default GoogleMapStyle tiles when using Google maps. Default [Roadmap].
src/types/Checkmate/ObjectModel/User.ts:60
• defaultHereMapStyle: HereMapStyle
Gets or sets the default HereMapStyle tiles when using Here Maps. Default [Roadmap].
src/types/Checkmate/ObjectModel/User.ts:62
• defaultMapEngine: string
Gets or sets the default map engine to use for this user. System map engines are: GoogleMapsHereMapMapBox Default ["MapBox"].
src/types/Checkmate/ObjectModel/User.ts:68
• defaultOpenStreetMapStyle: OpenStreetMapStyle
Gets or sets the default OpenStreetMapStyle tiles when using Open Street Maps. Default [MapBox].
src/types/Checkmate/ObjectModel/User.ts:70
• defaultPage: string
Gets or sets the default start page to view when login is complete. Maps to the hash portion of the web site URL (https://url/enpoint/[#page]). Default [helpGuide].
src/types/Checkmate/ObjectModel/User.ts:72
• designation: string
Gets or sets the designation or title of the employee. Maximum length [50] Default [""].
src/types/Checkmate/ObjectModel/User.ts:74
• displayCurrency: Currency
Gets or sets the user's preferred currency for display in the UI.
src/types/Checkmate/ObjectModel/User.ts:76
• displayMeasurementProfile: DisplayMeasurementProfile
Gets or sets the DisplayMeasurementProfile.
src/types/Checkmate/ObjectModel/User.ts:78
• driveGuideVersion: number
Gets or sets the driver's last viewed guide version. Default [0].
src/types/Checkmate/ObjectModel/User.ts:80
• electricEnergyEconomyUnit: ElectricEnergyEconomyUnit
Gets or sets the user's preferred ElectricEnergyEconomyUnit for viewing fuel economy. Default [LitersEPer100Km].
src/types/Checkmate/ObjectModel/User.ts:82
• employeeNo: string
Gets or sets the employee number or external identifier. Maximum length [50] Default [""].
src/types/Checkmate/ObjectModel/User.ts:84
• featurePreview: string
Gets or sets a value indicating which features user enabled to preview. Default [""].
src/types/Checkmate/ObjectModel/User.ts:86
• firstDayOfWeek: number
Gets or sets the user's preferred day to represent the start of the week. Default ["Sunday"].
src/types/Checkmate/ObjectModel/User.ts:88
• firstName: string
Gets or sets the first name of the user. Maximum length [255].
src/types/Checkmate/ObjectModel/User.ts:90
• fuelEconomyUnit: FuelEconomyUnit
Gets or sets the user's preferred FuelEconomyUnit for viewing fuel economy. Default [LitersPer100Km].
src/types/Checkmate/ObjectModel/User.ts:92
• groups: Group[]
Gets or sets the aggregated list of all user groups.
src/types/Checkmate/ObjectModel/User.ts:94
• hosRuleSet: HosRuleSet
Gets or sets the HosRuleSet the user follows. Default [None].
src/types/Checkmate/ObjectModel/User.ts:96
• id: string
Gets or sets the unique identifier for the User. See Id.
src/types/Checkmate/ObjectModel/User.ts:98
• isAdverseDrivingEnabled: boolean
Gets or sets a value indicating whether the user is allowed to Adverse Driving conditions exempt. Default [false].
src/types/Checkmate/ObjectModel/User.ts:100
• isDriver: boolean
Gets or sets the is driver toggle, if [true] the user is a driver, otherwise [false]. Default [false].
src/types/Checkmate/ObjectModel/User.ts:102
• isEULAAccepted: boolean
Gets a value indicating whether the old EULA has been accepted by the end user. Default [false].
src/types/Checkmate/ObjectModel/User.ts:106
• isEmailReportEnabled: boolean
Gets or sets the isEmailReportEnabled, if [true] the user will receive the emailed report, otherwise [false]. Default [true].
src/types/Checkmate/ObjectModel/User.ts:104
• isExemptHOSEnabled: boolean
Gets or sets a value indicating whether the user is allowed to HOS personal conveyance. Default [false].
src/types/Checkmate/ObjectModel/User.ts:108
• isLabsEnabled: boolean
Gets a value indicating whether labs are enabled for this user. When set to true this will enable experimental features that are still in the process of being developed. Default [false].
src/types/Checkmate/ObjectModel/User.ts:110
• isMetric: boolean
Gets or sets whether the current regional settings is in metric units of measurement (or US/Imperial). Default [true].
src/types/Checkmate/ObjectModel/User.ts:112
• isNewsEnabled: boolean
Gets or sets a value that indicates whether news notifications are enabled for this user. Default [true].
src/types/Checkmate/ObjectModel/User.ts:114
• isPersonalConveyanceEnabled: boolean
Gets or sets a value indicating whether the user is allowed to HOS personal conveyance. Default [false].
src/types/Checkmate/ObjectModel/User.ts:116
• isServiceUpdatesEnabled: boolean
Gets or sets a value indicating whether are service update notifications enabled for this user. Default [false].
src/types/Checkmate/ObjectModel/User.ts:118
• isYardMoveEnabled: boolean
Gets or sets a value indicating whether the user is allowed to HOS yard move. Default [false].
src/types/Checkmate/ObjectModel/User.ts:122
• issuerCertificate: Certificate
Gets or sets the issuer Certificate for the user. Will only be populated for users not using basic authentication.
src/types/Checkmate/ObjectModel/User.ts:120
• language: string
Gets or sets the user's culture identifier as a predefined CultureInfo name, CultureInfo.Name of an existing System.Globalization.CultureInfo, or Windows-only culture name. Default: ["en"] for English.
src/types/Checkmate/ObjectModel/User.ts:124
• lastAccessDate: Date
Gets or sets the user's Last access date of the system.
src/types/Checkmate/ObjectModel/User.ts:126
• lastName: string
Gets or sets the last name of the user. Maximum length [255].
src/types/Checkmate/ObjectModel/User.ts:128
• mapViews: unknown[]
Gets or sets the list of the of the available MapViews from the live map. Default [continent of the user's selected Timezone].
src/types/Checkmate/ObjectModel/User.ts:130
• maxPCDistancePerDay: number
Gets or sets a value indicating the maximum personal conveyance distance per day in meters. Default [0].
src/types/Checkmate/ObjectModel/User.ts:132
• mediaFiles: MediaFile[]
Gets or sets the list of MediaFile(s) photos of this user. Currently, a user can only be associated with at most one photo.
src/types/Checkmate/ObjectModel/User.ts:137
• name: string
Gets or sets the user's email address / login name. Maximum length [255].
src/types/Checkmate/ObjectModel/User.ts:139
• nullifyAccessGroupFilter: boolean
Gets or sets a value to nullify AccessGroupFilter.
src/types/Checkmate/ObjectModel/User.ts:141
• password: string
Gets or sets the user's password.
src/types/Checkmate/ObjectModel/User.ts:143
• phoneNumber: string
Gets or sets the user phone number with space separated country phone code. Example +1 5555555555. Maximum length [20] Default [""]
src/types/Checkmate/ObjectModel/User.ts:145
• phoneNumberExtension: string
Gets or sets the user phone number without formatting. Maximum length [5] Default [""]
src/types/Checkmate/ObjectModel/User.ts:147
• privateUserGroups: Group[]
Gets or sets the private Group(s) that the user belongs to.
src/types/Checkmate/ObjectModel/User.ts:149
• reportGroups: Group[]
Gets or sets the report Group(s) for reporting that this user belongs to. The selected reporting groups will allow the user to sort entities that are children of the selected groups. It will not allow them to see entities that are outside of their data access. Default [empty].
src/types/Checkmate/ObjectModel/User.ts:151
• securityGroups: Group[]
Gets or sets the security Group(s) this user belongs to; which define the user's access.
src/types/Checkmate/ObjectModel/User.ts:153
• showClickOnceWarning: boolean
Gets or sets a flag indicating whether to show ClickOnce support warning as the default page. (legacy) Default [false].
src/types/Checkmate/ObjectModel/User.ts:155
• timeZoneId: string
Gets or sets the IANA Timezone Id of the user. All data will be displayed in this Timezone. Default ["America/New_York"].
src/types/Checkmate/ObjectModel/User.ts:157
• userAuthenticationType: UserAuthenticationType
Gets or sets the UserAuthenticationType. Default [Basic].
src/types/Checkmate/ObjectModel/User.ts:159
• version: number
Gets or sets the version of the entity.
src/types/Checkmate/ObjectModel/NameEntityWithVersion.ts:10
• wifiEULA: number
Gets or sets a value indicating the user accepted Wifi specific EULA revision number. Default [0].
src/types/Checkmate/ObjectModel/User.ts:161
• windowsAuthenticationUserId: string
Gets or sets the windows authentication user Id. This property is so we don't return both User Id and Name to the client side when they have the same value. User Id and Name only differ for WindowsAuthentication users.
src/types/Checkmate/ObjectModel/User.ts:167
• zoneDisplayMode: ZoneDisplayMode
Gets or sets the default ZoneDisplayMode used on the map. Default [Default].