post https://services.azuga.com/azuga-ws-oauth/v3/users.json
Use this API to view the account information of users. Users are people in your organization that use Azuga for tracking vehicles and reporting on performance and productivity. Driver accounts are also considered as user accounts with limited access to the application.
Sample Request
https://services.azuga.com/azuga-ws-oauth/v3/users?limit=2&offset=0&userType=Users
API Response Explanation
| Field | Description | Data Type |
|---|---|---|
| id | Unique identifier assigned to the associated user. | String |
| firstName | First name of the user | String |
| lastName | Last name of the user | String |
| Email address associated to the user account. | String | |
| primaryContactNumber | Main contact number of the associated user. | String |
| alternateContactNumber | Alternate contact number of the associated user. | Long |
| roleId | Role ID assigned to the current user account which is assigned according to the role of the user. | String |
| userName | The username of the account | String |
| password | The password used by the user account - encrypted | String |
| pin | The pin set by the user to password protect the device. | String |
| isGetMaintenanceAlert | Boolean value denoting whether the maintenance alert package is enabled or not for the user. | String |
| isGetNewReleaseAlert | Boolean value denoting whether the new release alert package is enabled or not for the user. | String |
| customerId | Unique identifier of customer ID that the user is associated to. | Long |
| createdBy | The user account which created the current user. | String |
| lastModifiedBy | The user who made the last modification to the associated user account. | String |
| userType | The types of users available on Azuga application. Each user type has an exclusive identifier assigned to them. They are: 1 - Super User (Administrator for all customer account and used by Azuga team to login any account) 2 - Admin (Administrator of customer account) 3 -Web Admin(User created by Admin) 4 - Driver (Driver associated with the vehicle) | Object |
| lastModifiedAt | The time stamp at which last modification was made to the user account. | Timestamp |
| deleted | Boolean value represents the delete status of the user True = Deleted False = Not Deleted | boolean |
| createdAt | For Azuga internal use | Timestamp |
| timeZone | Timezone of the user | String |
| deletedAt | For Azuga internal use | Timestamp |
| apiKey | The unique code that is passed in to the API to identify the calling user. | String |
| lastLoginDateTime | Time stamp at which last login was made by the user account. | Timestamp |
| licenseNumber | Licence number linked with the user account(Driver). | String |
| licenseIssuedDate | The issue date of the user's license. | Date |
| licenseExpiry | The date on which the user's licence will expire. | Date |
| licenseIssuedState | The state from which the user's licence has been issued from. | String |
| profilepicUrl | The URL of the profile picture | String |
| emailVerification | Boolean value denoting whether the email account linked to the user account has been verified. | boolean |
| userDetails | Details of the user account. | Object |
| vehicleId | Vehicle ID associated with the user account | String |
| vehicleName | Name of the vehicle associated with the user account. | String |
| fromDeleteDevice | For Azuga Internal use | boolean |
| fullName | The full name of the user i.e. combination of the first name and last name. | String |
| tags | The tags associated with the users | String |
| userTagsAssociated | Tags associated with the user | List |
| userTagsNames | Tag names associated with the user | List |
| roleName | The role assigned to the associated user. | String |
| adminingGroups | The groups administered by the associated user. | List |
| countryId | The ID of the country to which the associated user belongs to. | Integer |
| groupIdsAndNames | The group IDs and names which are linked with the user. | List |
| userTypeName | The type of user associated with the account. | String |
| userTypeId | The unique identifier assigned to each user type. The ID designated to each user type are: 1 - Super User (Administrator for all customer account and used by Azuga team to login any account) 2 - Admin (Administrator of customer account) 3 -Web Admin(User created by Admin) 4 - Driver (Driver associated with the vehicle) | Integer |
| enabledPackageNames | The list of packages enabled for the associated user account. | String |
| pairingTypeId | The types of pairing method available on Azuga application. Each pairing method has a unique identifier assigned to them. They are: 0 - Web 1 - Bluetooth 2 - Beacon 3 - NoPairing 4 - E-Logs 5- Bluetooth | Integer |
| pairingType | The pairing method used to associate the device to the user profile. | String |
| nodeTableCreated | For Azuga Internal use | boolean |
| employeeId | The employee ID linked to the user account. | String |
| serviceHour | The number of hours the associated user needs to complete. | Boolean |
| dispatchNumber | The unique number of the package being dispatched. | String |
| dispatchStatus | The latest status of the package being dispatched. | String |
| dispatchRedirectURL | RedirectURL of the package being dispatched. | String |
| notInGroup | Boolean value denoting whether the current user account is linked to any group. | boolean |
| pageName | Name of the page. | String |
| pageId | The unique identifier of the different modules of web page. You can select a module from the Azuga web app to exclusively appear as the home page for a particular users. The modules are represented by the following code: 0 - Null(Default homepage of Azuga web application) 1 - map.html'(Live Map) 2 - dashboardsoverview.html(Live Map) 3 - reports.html(Live Map) 4 - admin.html(Live Map) 5 - rewards.html(Live Map) 6 - maintenance.html(Live Map) 9 - reseller.html(Live Map) 11 - safetycam.html(Live Map)_ | long |
| pageUrl | URL of the displayed page. | String |
| groupIds | List of group IDs to which the user account has been assigned to. | List |
| groupId | String | |
| groupNames | List of group names to which the user is assigned to. | String |
| userDocumentList | The list of document names saved by the user. | List |
| userDocsDeleted | The list of documents the associated user has deleted. | List |
| userDocs | The object which consists of all metadata of the docs which the current user account has stored in the server. | String |
| uploadType | The media type of the uploaded file. | List |
| userDocURIs | The URL of user documents where the user documents have been stored. | List |
| notLoggedinHasAccessToGroup | The list of group the associated user has access to without logging in. | boolean |
| fuelCardNumber | The fuel card number linked to the current user account. | String |
| plainPassword | The decrypted password set by the user. | String |
| useDefaultRole | Boolean representing whether the user is assigned with use default role | boolean |
| useDefaultGroup | Boolean representing whether the user is assigned with use default group | boolean |
| fetchCompleteResponse | For Azuga internal use | boolean |
| adminUserId | The user ID of the admin to which the user account is linked to. | String |
| node | For Azuga Internal use | String |
| loginPwdOption | For Azuga Internal use | Short |
| prevLastLoginDateTime | For Azuga Internal use | Timestamp |
| ssouser | For Azuga Internal use | boolean |
| elogVistrack | For Azuga Internal use | boolean |