Customer Portals

Customer Portals API

📄️Provision Customer Portal Access

Provision access to a customer's portal for one of the customer's users through SSO. Creates the portal if the customer has none. Provisioning is asynchronous; the response carries a URL to redirect the user to. Idempotent per portal and username: calling again updates the user's email, userRole and entireFleetAccess. The response is the login URL when provisioning completes within the call, otherwise the waiting-page URL.

📄️Get Customer Portal Access Request

Read the state of a provisioning run started through POST /customer-portal-access. Completed requests are kept for 30 days; after that the response is 404.

📄️Get Impersonated API Token

Get Impersonated API Token for Customer Portal

📄️Get Customer Portal

Read a customer portal by its id. The portal is ready when its status is FINISHED.

📄️Update Customer Portal

Update Customer Portal configuration/template assignment.

📄️Get Customer Portal for Customer by External Reference

Read the customer portal that serves a given customer, addressed by external reference. Portals belong to root customers; for a sub-customer this returns the portal of its root customer, the same portal its users are provisioned on. The portal is ready when its status is FINISHED.

📄️Update Customer Portal by Customer External Reference

Update Customer Portal configuration/template assignment for a given customer external reference.

📄️Create Customer Portal for Customer by External Reference

Create Customer Portal for a given customer external reference. This operation is asynchronous. The Customer portal will be created in the background. The portal is ready when its status is FINISHED. Users are added separately, for example through POST /customer-portal-access.

📄️Get Customer Portal for Customer

Read the customer portal that serves a given customer. Portals belong to root customers; for a sub-customer this returns the portal of its root customer, the same portal its users are provisioned on. The portal is ready when its status is FINISHED.

📄️Update Customer Portal for Customer

Update Customer Portal configuration for a given customer.

📄️Create Customer Portal for Customer

Create Customer Portal for a given customer. This operation is asynchronous. The Customer portal will be created in the background. The portal is ready when its status is FINISHED. Users are added separately, for example through POST /customer-portal-access.