View Single User

Use this API to view the account information of a user in your account. 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.Warning : Make sure that you are setting the method to GET. The same endpoint is used for deleting a user using DELETE method. The deletion of the user is an irreversible action.

📘

Sample Request

https://services.azuga.com/azuga-ws-oauth/v3/users/020f3be1-649c-11ea-a7f6-5b458131c070

API Response Explanation

FieldDescriptionData Type
idUnique identifier assigned to the current user.String
firstNameThe first name of the userString
lastNameThe last name of the userString
emailEmail address linked to the user account.String
primaryContactNumbeMain contact number of the associated user.String
alternateContactNumberAlternate contact number of the associated user.Long
roleIdRole ID assigned to the current user account which is assigned according to the role of the user.String
userNameThe username of the accountString
passwordThe password set by the user for the user account.String
pinThe pin set by the user to password protect the device.String
isGetMaintenanceAlertBoolean value denoting whether the maintenance alert package is enabled or not for the user.String
isGetNewReleaseAlertBoolean value denoting whether the new release alert package is enabled or not for the user.String
customerIdUnique identifier of customer ID to which the user is associated to.Long
createdByUser name of the account which was used to create the current user account.String
lastModifiedByUser name of the account via which the last modification was made to the current user account.String
userTypeThe type 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
lastModifiedAtThe time stamp at which last modification was made to the user account.Timestamp
deletedBoolean value represents the delete status of the user
True = Deleted
False = Not Deleted
boolean
createdAtFor Azuga internal useTimestamp
timeZoneTimezone of the userString
deletedAtFor Azuga internal useTimestamp
apiKeyThe unique code that is passed in to the API to identify the calling user.String
lastLoginDateTimeTime stamp at which last login was made by the user account.Timestamp
licenseNumberLicence number linked with the user account(Driver).String
licenseIssuedDateThe issue date of the user's license.Date
licenseExpiryThe date at which the user's licence will expire.Date
licenseIssuedStateThe state of a country's where the user's lString
profilepicUrlThe URL of the profile pictureString
emailVerificationBoolean value denoting whether the email account linked to the user account has been verified.boolean
userDetailsThe details of the user account.Object
vehicleIdthe vehicle ID associated with the user accountString
vehicleNameThe name of the vehicle associated with the user account.String
fromDeleteDeviceBoolean value denoting whether the current user account has been disassociated from the device it was paired with.boolean
fullNameThe full name of the user.String
tagsThe tags associated with theString
userTagsAssociatedThe server generated tags associated with the current user accounts.List
userTagsNamesTag names associated with the userList
roleNameThe role assigned to the associated user.String
adminingGroupsThe groups administered by the associated user.List
countryIdThe ID of the country to which the associated user belongs to.Integer
groupIdsAndNamesThe group IDs and names which are linked with the user.List
userTypeNameThe user type assigned to the user account.String
userTypeIdThe unique identifier assigned to each user type.

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
enabledPackageNamesThe list of packages enabled for the associated user account.String
pairingTypeIdThe 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
pairingTypeThe pairing method used to associate the device to the user profile.String
nodeTableCreatedFor Azuga Internal useboolean
employeeIdThe employee ID linked to the user account.String
serviceHourThe number of hours the associated user needs to complete.Boolean
dispatchNumberThe unique number of the package being dispatched.String
dispatchStatusThe latest status of the package being dispatched.String
dispatchRedirectURLRedirectURL of the package being dispatched.String
notInGroupBoolean value denoting whether the current user account is linked to any group.boolean
pageNameThe name of the page.String
pageIdThe 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 - dashboards_overview.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
pageUrlThe URL of the page.String
groupIdsList of group IDs to which the user account has been assigned to.List
groupIdFor Azuga internal useString
groupNamesList of group names to which the user is assigned to.String
userDocumentListThe list of documents saved by the user.List
userDocsDeletedThe list of documents the associated user has deleted.List
userDocsThe object which consists of all metadata of the docs which the current user account has stored in the server.String
uploadTypeThe media type of the uploaded file.String
userDocURIsThe URL of user documents where the user documents have been stored.List
notLoggedinHasAccessToGroupThe list of group the associated user has acces to without logging in.boolean
fuelCardNumberThe fuel card number linked to the user account.String
plainPasswordThe decrypted password set by the user.String
useDefaultRoleBoolean representing whether the user is assigned with use default roleboolean
useDefaultGroupBoolean representing whether the user is assigned with use default groupboolean
fetchCompleteResponseFor Azuga internal useboolean
adminUserIdThe user ID of the admin to which the user account is linked to.String
nodeFor Azuga internal useString
loginPwdOptionFor Azuga internal useShort
prevLastLoginDateTimeFor Azuga internal useTimestamp
elogVistrackFor Azuga internal useboolean
ssouserFor Azuga internal useboolean
Language
Authorization
Header
Click Try It! to start a request and see the response here!