Auth Token for Driver

Create auth token for a driver

Creates a short-lived auth token a driver can use to login.

<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write Driver Auth Token under the Drivers category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

post/fleet/drivers/auth-token

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Request body

codestring required

Required. Random 12+ character string, used with the auth token to help secure the client from intercepted tokens.

driverIdinteger

Optional. Samsara ID of the driver. One of id, externalId, or username is required.

externalIdstring

Optional. External ID of the driver, in the format key:value (e.g., payrollId:ABFS18600). One of id, externalId, or username is required.

usernamestring

Optional. Username of the driver. This is the login identifier configured when the driver is created. One of id, externalId, or username is required.

Example request

{
  "code": "dp[gZc1wAigz4uGa0Hh",
  "driverId": 1234,
  "externalId": "payrollId:ABFS18600",
  "username": "johndoe"
}

Response

OK response.

Example response

{
  "data": {
    "expirationTime": 1710000000000,
    "token": "ZmFrZVRva2VuXzMyQnl0ZXNMb25nRm9yVGVzdA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.