Skip to content

Auth clients⚓︎

Auth clients allow you to create and manage OAuth 2.0 credentials for accessing the API within FleetControl. Auth clients is located under Administration > Auth Clients. Using the created credentials, you can request data from the API on demand and send vehicle commands. We recommend you create a separate auth client for every application. If you want to continuously receive event data, the event subscription feature might be more useful to you.

Creating a new auth client⚓︎

To create a new auth client, select Add Auth Client.

Auth clients Add

Select an appropriate name for your new auth client.

Auth clients Name

Consider what data and commands your application might require access to. Choose the respective permissions by ticking the boxes and, if applicable, selecting between read-only and read & write. For a full description of each permission, click here.

Auth clients Permissions

Finally, select Add to create your auth client.

Auth clients Finish Add

Warning

Immediately copy and save the client secret after adding a new auth client as it cannot be accessed again afterwards.

Client secret⚓︎

The client secret, alongside the client ID, is the key to accessing the API. Client secrets are only shown a single time immediately after adding a new client.

Generating a new secret⚓︎

If you lose the client secret, you will be unable to access the API using the respective auth client. To generate a new client secret, open the auth client and click the obscured secret.

Auth clients secret hidden

Select Generate Secret to create a new client secret that will replace the old one.

Auth clients new secret

Remember to immediately copy and save the new secret. Also, update the secret in all appplications using this auth client.

Actions⚓︎

You can edit the name of an auth client and delete it. To do so, open the auth client and select Actions.

Auth clients actions

To change the permissions of an auth client, simply open it and tick or untick the respective boxes. Finally, remember to select Save.

Auth clients edit permissions