CesiumAccessClient Interface @beta

Provides access tokens and endpoint URLs for Cesium Ion assets. Supply an implementation via TileAdmin.Props.cesiumAccess to control how Cesium assets are resolved.

Two authentication paths:

  • Direct Cesium Ion: set TileAdmin.Props.cesiumIonKey — uses a built-in client that authenticates directly with Cesium Ion. Suitable for apps with their own Cesium Ion subscription.
  • Custom / iTwin Platform proxy: supply a CesiumAccessClient implementation — for example, one that calls the iTwin Platform Cesium Curated Content API using an iTwin access token.

If both cesiumIonKey and cesiumAccess are supplied, cesiumAccess takes precedence. Note that this precedence applies when resolving an asset by id; reality models persisted with a legacy key-bearing URL (e.g. $CesiumIonAsset=<id>:<key>) continue to authenticate directly with the embedded key and are not routed through a registered cesiumAccess client.

@see - TileAdmin.Props.cesiumAccess

  • TileAdmin.Props.cesiumIonKey

Methods

Name Description
getAssetEndpoint(assetId: string, iTwinId?: string): Promise<CesiumAssetEndpoint | undefined> Obtain an endpoint URL and access token for the specified Cesium Ion asset.  

Defined in

Last Updated: 23 June, 2026