post https://iris.trackunit.com/api/customer/v1/customer-portal-access
Provision Customer Portal access for a provided user. Will return an access request ID to keep track of the provisioning process.
This guide explains how to provision customer portal access for your customers using Single Sign-On (SSO).
Overview
After creating a customer and assigning assets to them, you can provision access to the customer portal. This portal provides customers with visibility into all their assigned assets.
Prerequisites
- An SSO connection must be configured in advance
- Contact your Trackunit representative for SSO setup instructions
- This API is only available for IrisX customers
Process Flow
- Create a customer and assign assets to them
- When a customer user needs access to their telematics data, call this API to provision their access
- The API will return a URL - redirect the user's browser to this URL
- If additional setup is required, a waiting screen will be displayed to the user
- The user will be authenticated using the preconfigured SSO connection
- Upon successful authentication, the user will see a branded version of Trackunit Manager with their assets
The API endpoint is idempotent, so may be called each time a user logs in. This also ensures that any changes in user details will be synchronized.
Subscription Requirement
This API is exclusively available for IrisX customers. Learn more about the IrisX subscription.