Authentication
Stay organized with collections
Save and categorize content based on your preferences.
google.maps.journeySharing.AuthToken
interface
The auth token returned by the token fetcher.
Properties |
|---|
expiresInSeconds |
Type: number
The expiration time in seconds. A token expires in this amount of time after fetching. |
token |
Type: string
The token. |
google.maps.journeySharing.AuthTokenContext
interface
Contains additional information needed to mint JSON Web Tokens.
Properties |
|---|
deliveryVehicleId optional |
Type: string optional
When provided, the minted token should have a private DeliveryVehicleId claim for the provided deliveryVehicleId. |
taskId optional |
Type: string optional
When provided, the minted token should have a private TaskId claim for the provided taskId. |
trackingId optional |
Type: string optional
When provided, the minted token should have a private TrackingId claim for the provided trackingId. |
tripId optional |
Type: string optional
When provided, the minted token should have a private TripId claim for the provided tripId. |
vehicleId optional |
Type: string optional
When provided, the minted token should have a private VehicleId claim for the provided vehicleId. |
google.maps.journeySharing.AuthTokenFetcherOptions
interface
Options for the auth token fetcher.
Properties |
|---|
context |
The auth token context. IDs specified in the context should be added to the request sent to the JSON Web Token minting endpoint. |
serviceType |
The Fleet Engine service type. |
google.maps.journeySharing.FleetEngineServiceType
constants
Types of Fleet Engine services.
Access by calling const {FleetEngineServiceType} = await google.maps.importLibrary("journeySharing").
See Libraries in the Maps JavaScript API.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[],[],null,["[AuthToken](#AuthToken)\ninterface\n\n\ngoogle.maps.journeySharing`.`AuthToken\ninterface\n\nThe auth token returned by the token fetcher.\n\n| Properties ||\n|-------------------------------------------------|-----------------------------------------------------------------------------------------------------------|\n| [expiresInSeconds](#AuthToken.expiresInSeconds) | **Type:** `number` The expiration time in seconds. A token expires in this amount of time after fetching. |\n| [token](#AuthToken.token) | **Type:** `string` The token. |\n\n[AuthTokenContext](#AuthTokenContext)\ninterface\n\n\ngoogle.maps.journeySharing`.`AuthTokenContext\ninterface\n\nContains additional information needed to mint JSON Web Tokens.\n\n| Properties ||\n|---------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| [deliveryVehicleId](#AuthTokenContext.deliveryVehicleId)` `optional | **Type:** `string `optional When provided, the minted token should have a private `DeliveryVehicleId` claim for the provided deliveryVehicleId. |\n| [taskId](#AuthTokenContext.taskId)` `optional | **Type:** `string `optional When provided, the minted token should have a private `TaskId` claim for the provided taskId. |\n| [trackingId](#AuthTokenContext.trackingId)` `optional | **Type:** `string `optional When provided, the minted token should have a private `TrackingId` claim for the provided trackingId. |\n| [tripId](#AuthTokenContext.tripId)` `optional | **Type:** `string `optional When provided, the minted token should have a private `TripId` claim for the provided tripId. |\n| [vehicleId](#AuthTokenContext.vehicleId)` `optional | **Type:** `string `optional When provided, the minted token should have a private `VehicleId` claim for the provided vehicleId. |\n\n[AuthTokenFetcher](#AuthTokenFetcher)\ntypedef\n\n\ngoogle.maps.journeySharing`.`AuthTokenFetcher\ntypedef\n\nAuth token function type. \n\nA function that accepts a [AuthTokenFetcherOptions](/maps/documentation/javascript/reference/3.59/journey-sharing-authentication#AuthTokenFetcherOptions) object, containing details about the auth token to be minted. This function should mint the token and return a [AuthToken](/maps/documentation/javascript/reference/3.59/journey-sharing-authentication#AuthToken) containing the token and its expiry time.\n\n`function(`[AuthTokenFetcherOptions](/maps/documentation/javascript/reference/3.59/journey-sharing-authentication#AuthTokenFetcherOptions)`): `[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)`\u003c`[AuthToken](/maps/documentation/javascript/reference/3.59/journey-sharing-authentication#AuthToken)`\u003e` \n\n[AuthTokenFetcherOptions](#AuthTokenFetcherOptions)\ninterface\n\n\ngoogle.maps.journeySharing`.`AuthTokenFetcherOptions\ninterface\n\nOptions for the auth token fetcher.\n\n| Properties ||\n|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [context](#AuthTokenFetcherOptions.context) | **Type:** [AuthTokenContext](/maps/documentation/javascript/reference/3.59/journey-sharing-authentication#AuthTokenContext) The auth token context. IDs specified in the context should be added to the request sent to the JSON Web Token minting endpoint. |\n| [serviceType](#AuthTokenFetcherOptions.serviceType) | **Type:** [FleetEngineServiceType](/maps/documentation/javascript/reference/3.59/journey-sharing-authentication#FleetEngineServiceType) The Fleet Engine service type. |\n\n[FleetEngineServiceType](#FleetEngineServiceType)\nconstants\n\n\ngoogle.maps.journeySharing`.`FleetEngineServiceType\nconstants\n\nTypes of Fleet Engine services.\n\nAccess by calling `const {FleetEngineServiceType} = await google.maps.importLibrary(\"journeySharing\")`. \nSee [Libraries in the Maps JavaScript API](/maps/documentation/javascript/libraries).\n\n| Constants ||\n|------------------------------------------------------------------------------|--------------------------------------------------------|\n| [DELIVERY_VEHICLE_SERVICE](#FleetEngineServiceType.DELIVERY_VEHICLE_SERVICE) | Fleet Engine service used to access delivery vehicles. |\n| [TASK_SERVICE](#FleetEngineServiceType.TASK_SERVICE) | Fleet Engine service used to access task information. |\n| [TRIP_SERVICE](#FleetEngineServiceType.TRIP_SERVICE) | Fleet Engine service used to access trip information. |\n| [UNKNOWN_SERVICE](#FleetEngineServiceType.UNKNOWN_SERVICE) | Unknown Fleet Engine service. |"]]
