Samsara OAuth Configuration
Here’s a step-by-step guide to configure an OAuth2 client for Samsara
Overview
This guide provides detailed instructions on integrating Samsara with your Terminal instance.
This is required for Samsara specifically in order to guarantee:
- The OAuth flow is consistent with your branding.
- The permissions are customized for your specific needs.
- You can publish your application in the Samsara marketplace.
Creating a Developer Account
You can skip this step if you already have a Samsara developer account
- Submit Samsara’s partner application form.
- Accept the invite Samsara sends you to create a developer account. This may take up to 7 business days.
- If you don’t receive an invite after 7 business days, reach out to
support@withterminal.com.
- If you don’t receive an invite after 7 business days, reach out to
- Invite
support@withterminal.comto your Samsara organization.
Creating an OAuth Application
To create an OAuth application with Samsara, follow these steps:
-
Create a new application:
- Log in to your Samsara dashboard and go to the Apps tab
- Click Create new app
- Enter the required details (name, tag line, logo, etc.)
-
Under Redirect URLs, add:
- Choose the necessary Scopes for your application.
Which scopes should I choose?
Which scopes should I choose?
Below is a summary of the scopes you might need from Samsara, depending on the Terminal common models you intend to utilize.
It’s best to request all the permissions you might need upfront. Adding permissions later will require customers to re-authenticate, which can be avoided with early planning.
| Common Model | Samsara Scope |
|---|---|
| General (required) | Setup & Administration > Read Org InformationSetup & Administration > Read WebhooksSetup & Administration > Write Webhooks |
| Vehicles (required) | Vehicles > Read Vehicles |
| Groups | Setup & Administration > Read Tags |
| Devices | Setup & Administration > Read Gateways |
| Drivers | Drivers > Read Drivers |
| Vehicle Locations Vehicle Stat Logs | Vehicles > Read Vehicle StatisticsAssignments > Read Assignments |
| Trips | Vehicles > Read Vehicle Trips |
| Trailers | Trailers > Read TrailersEquipment > Read Equipment |
| Trailer Locations | Trailers > Read Trailer StatisticsEquipment > Read Equipment Statistics |
| HOS Logs HOS Daily Logs HOS Available Time | Compliance > Read ELD Hours of ServiceCompliance > Read ELD Compliance Settings |
| Safety Events | Safety & Compliance > Read Safety Events & ScoresSafety & Cameras > Read Camera Media (optional) |
| IFTA Summaries | Compliance > Read IFTA (US) |
| Passthrough | Select any other scopes you plan to leverage if using passthrough |
- Click Save to create your application.
- Click on the application you just created.
- In the top right, change the app state to
Beta. Learn more about app states here. - Click Save to make your application available for customer use.
- Invite
support@withterminal.comto your Samsara organization.
Update Samsara Configuration in the Terminal Dashboard
If you haven’t obtained production access to Terminal yet, you can skip this step and complete it when you have production access.
You must be a Terminal Dashboard admin to perform this step.
- Go to the Terminal Dashboard Settings
- Scroll down to Samsara
- Paste the Client ID and Client Secret from Samsara into the Terminal dashboard.
- Click Save Changes to save the configuration.
- Begin connecting Samsara fleets to Terminal 🚛
Publishing Your Application
Once your integration is in production and Samsara fleets have connected to your application, you can request that Samsara review your application for inclusion in their marketplace.
Contact us when ready, and we’ll help introduce you to the Samsara team to expedite the review process.