For the complete documentation index, see llms.txt. This page is also available as Markdown.

User Roles Reference

This page documents the different permissions that can be assigned to a user role.

Access Control

Tenants

Tenant Management

Permission
Description

View tenants

Allows the user to view their tenant and any sub-tenants.

Add tenant

Allows the user to add tenants. Requires "View Tenants"

Edit tenant

Allows the user to edit (change settings, etc.) for tenants they have access to.

Delete tenant

Allows the user to delete tenants (and all devices and users contained therein).

Appearance & Map

Permission
Description

Change tenant logo and styling

Allows the user to access the "Web App Styling" screen in GAP Admin, permitting them to configure the look and feel of GAP web apps.

Change app default settings

Allows the user to the configure the tenant-level default settings for the GAP smartphone app.

Change app default features

Allows the user to the configure the available features for the GAP smartphone app.

Configure Quick Call

Allows the user to set up the GAP smartphone app's Quick Call feature.

Other

Permission
Description

Change contacts

Allows the user to change the Technical and Sales contacts for a tenant.

Alert management

Allows the user to change the Emergency Planning details for a tenant.

Data logs

Allows the user to configure data exports via the "Data Exports" screen in GAP Admin.

Change allowed device types

Allows the user to change which device types are available for a tenant.

Access billing

Allows the user to download invoice details via the GAP Web API.

Configure web hooks

Allows the user to configure web hooks via the Webhooks screen in GAP Admin.

Manage SSO

Allows the user to set up SSO for a tenant via the Manage SSO screen in GAP Admin.

Users

User Management

Permission
Description

View other users

Allows the user to view user accounts other than their own.

Add user

Allows the user to create users. "View user roles" permission is also required.

Edit other user

Allows the user to edit user accounts other than their own. "View other users" permission is also required.

Change user role

Allows the user to change the user role assigned to another user account. "Edit other users" permission is also required.

Change user trial

Allows the user to change the expiry date of a temporary user account. "Edit other users" permission is also required.

Delete user

Allows the user to delete user accounts assigned user roles with fewer permissions than their own.

Add and delete users in this role

Allows the user to create and delete user accounts assigned the same user role as their own.

Other

Permission
Description

Change user alert contacts

Allows the user to change the emergency contacts.

Tag user

Allows the user to add tags to a user.

View PIN codes

Allows the user to view other users' PIN codes. Not required for a user to see their own PIN code.

Display external link on Options page

Reset 2-step verification

Allows the user to reset 2-step verification for another user.

Manage other users' API keys

Allows a user to view and regenerate other users' API keys.

Manage own API key

Allows a user to view and regenerate their own API key.

Roles

Role Management

Permission
Description

View user roles

Allows the user to view user role definitions via the "Roles" screen in GAP Admin.

Add user role

Allows the user to create new user roles with fewer permissions than their own via the "Roles" screen in GAP Admin.

Edit user role

Allows the user to edit roles with fewer permissions than their own via the "Roles" screen in GAP Admin.

Delete user role

Allows the user to delete user roles with fewer permissions than their own via the "Roles" screen in GAP Admin.

Collections

Collection Management

Permission
Description

View collections

Allows the user to view collections.

Manage collections

Allows the user to create, edit and delete collections.

Devices

Devices

Device Access

Permission
Description

All

Allows the user to view all devices to which they have access.

All in emergency state

Allows the user to view all devices to which they have access that are currently in an emergency state or have been in the last 24 hours.

Own device only

Allows the user to view only devices assigned to their user account.

Device Management

Permission
Description

Add device

Allows the user to create devices.

Add own device

Allows the user to create devices assigned solely to their own user account.

Edit device

Allows the user to edit devices to which they have access.

Delete device

Allows the user to delete devices to which they have access.

Messaging

Permission
Description

Remotely configure device

Allows the user to change the configuration of a device via the GAP Portal (e.g. set tracking interval, etc.)

Message device

Allows the user to send messages that do not change the configuration of the device (e.g. text messages, location requests, etc.).

Broadcast

Allows the user to use the Broadcast feature in the GAP Portal.

View inbox messages

Allows the user to view the device's inbox via the GAP Portal.

Show device outbox

Allows the user to view the device's outbox via the GAP Portal.

Show conversation view

Allows the user to view the device's conversation screen via the GAP Portal.

Delete messages

Allows the user to delete messages from the device's inbox via the GAP Portal.

Monitoring

Permission
Description

Check in device

Allows the user to check in a device manually, useful when devices are being monitored.

Raise or cancel emergency state

Allows the user to remotely trigger and cancel an emergency against a device via the GAP Portal.

Override stop monitoring behaviour

Allows the user to forcibly stop server-side monitoring. Note that this can lead to the user believing they are being monitored when they are not and thus should be used with caution.

Customization

Permission
Description

Change app features

Allows the user to set which app features are available.

Custom map icon

Allows the user to upload custom map icons for devices.

External links

Allows the user to view configured External Links on the device detail page.

Other

Permission
Description

Change device ID

Allows the user to change a device's ID.

Change device user

Allows the user to re-assign devices to other user accounts.

Change device provisioning status

Allows the user to change a device's provisioning status via the GAP Portal.

Change tenant

Allows the user to move devices between tenants. Note this feature can result in data loss and should be used with caution.

Manage device encryption keys

Allows the user to manage keys for devices that support encryption.

Add device log notes

Allows the user to add free-text notes to the device log.

Tag device

Allows the user to apply tags to devices.

Access list view

Allows the user to access list view for devices in the GAP Portal. Note this also requires View Other Users and View Groups.

Groups

Group Access

Permission
Description

All

Allows a user to access all groups

Groups user is assigned to via collections

Allows a user to access only groups they have been assigned to using a collection.

None

Does not allow the user to access groups.

Group Management

Permission
Description

Manage groups

Allows the user to create and edit groups, including changing group membership. Requires access to all groups.

Other

Permission
Description

Message groups

Allows the user to send text messages and assign check-in schedules to devices in groups.

Tag groups

Allows the user to apply tags to groups.

Intel

Geofences

Geofence Management

Permission
Description

View geofences

Allows the user to view geofences.

Manage geofences

Allows the user to add, edit and delete geofences via the "Geofences" screen in GAP Admin.

Other

Permission
Description

Tag geofences

Allows the user to apply tags to geofences.

Points Of Interest

PoI Management

Permission
Description

View points of interest

Allows the user to view points of interest.

Manage points of interest

Allows the user to add, edit and delete their own points of interest.

Manage global points of interest

Allows the user to add, edit and delete tenant-level points of interest.

KML Files

KML File Management

Permission
Description

View KML files

Allows the user to view KML layers.

Manage user KML files

Allows the user to add, edit and delete their own KML layers.

Manage global KML files

Allows the user to add, edit and delete tenant-level KML layers.

Notifications

Address Book

Address Book Management

Permission
Description

View device address book

Allows the user to view the address book for devices to which they have access.

View global address book

Allows the user to view the global address book.

Manage device address book

Allows the user to edit the address book for devices to which they have access.

Manage global address book

Allows the user to edit the global address book.

Check-In Schedules

Schedule Management

Permission
Description

Manage schedules

Allows the user to add, edit and delete check-in schedules.

Schedule Actions

Permission
Description

Assign schedules to devices

Allows the user to assign a check-in schedule to devices to which they have access.

Enable and disable schedules

Allows the user to enable and disable check-in schedules.

Event Notifications

Notification Management

Permission
Description

View device event notifications

Allows the user to view event notifications for devices to which they have access.

View global event notifications

Allows the user to view global event notifications for tenants to which they have access.

Manage device event notifications

Allows the user to edit event notifications for devices to which they have access.

Manage global event notifications

Allows the user to edit global event notifications for tenants to which they have access.

Other

Permission
Description

Include global event notifications with event notifications

Allows the user to view all notifications that apply to a device in the device-level event notifications screen.

Canned Messages

Management

Permission
Description

View canned messages

Allows the user to view canned messages.

Manage device canned messages

Allows the user to add, edit and delete canned messages at the device level.

Manage global canned messages

Allows the user to add, edit and delete canned messages at the tenant-level.

Web Apps

Portal

Alert Management

Permission
Description

Change alert settings

Allows the user to configure the portal alert settings, including onscreen alerts and sound.

Admin

Main Access

Permission
Description

View Admin web app

Allows the user access to the GAP Admin app.

Logs

Permission
Description

View email log

Allows the user to view the E-Mail Log screen.

View SMS log

Allows the user to view the SMS Log screen.

View IVR log

Allows the user to view the IVR Log screen.

View importer log

Allows the user to view the Importer Log screen.

Facilities

Permission
Description

View facilities

Allows the user to view facilities.

Manage facilities

Allows the user to add, edit and delete facilities.

Reports

Main Access

Permission
Description

View Reports web app

Allows the user access to the GAP Reports app.

Management

Permission
Description

Manage report schedules

Allows the user to add, edit and delete report schedules.

Manage report jobs

Allows the user to add, edit and delete report jobs.

Comms

Main Access

Permission
Description

View Comms web app

Allows the user access to the GAP Comms app.

Messages

Permission
Description

View messages

Allow the user to view comms messages.

Send messages

Allows the user to send comms messages.

Delete messages

Allows the user to delete comms messages.

Manage message templates

Allows the user to create, edit and delete comms message templates via GAP Admin.

Insights

Intelligence

Permission
Description

View intelligence

Allows the user to view alerts, points, routes and regions.

Manage intelligence

Allows the user to create, edit and delete alerts, points, routes and regions.

Itineraries

Permission

View itineraries

Allows the user to view all itineraries in tenants to which they have access.

Manage own itineraries

Allows the user to edit their own itineraries.

Create itineraries

Allows the user to add itineraries.

Documents

Permission
Description

View documents

Allows the user to view documents.

Manage documents

Allows the user to create, share and delete folder, and upload and delete files.

Others

Permission
Description

Show hidden folders

Allows the user to view hidden folders in the Documents feature

Manage rules engine

Allows the user to view, add, edit and delete rules.

Edit settings

Allows the user to configure GAP for Travel settings.

Journeys

Main Access

Permission
Description

View Journeys web app

Allows the user access to the GAP Journeys app.

Management

Permission
Description

View all journeys

Allows the user to view all journeys in tenants to which they have access.

Manage journey classification

Allows the user to classify journeys.

Manage off road data

Allows the user to manage Fuel Tax Credit (FTC) data.

Last updated