API keys, authentication and the proxy

Some basemaps and layers come from services that need a key or a sign-in. This page covers where those credentials go, how they are stored, and what the Icon Map proxy does when a server does not allow Power BI to read it.

Enter an API key

1. Select the visual and open Format pane > API Keys & Authentication > API Keys.
2. Paste the key into the box for the provider.
3. Choose the provider as the basemap or turn on the layer that uses it.

API Keys

The group starts with the note "See ArcGIS Authentication section for ArcGIS API Key". ArcGIS has its own group, described next.

Which provider needs which key is covered in Other basemap providers and Weather, traffic and daylight. Icon Map basemaps need no key.

ArcGIS Authentication

The ArcGIS Authentication group sets how the map connects to ArcGIS Online or ArcGIS Enterprise. The full guide, with steps for each method, is Connect to ArcGIS. In summary:

Send Credential As sets how the credential travels to ArcGIS: URL Parameter (Default) or Authorization Header (Bearer). Leave it on URL Parameter unless your server rejects it. ArcGIS Enterprise 11.5 and later may reject newer API keys on the URL with "Invalid Token". Those servers need the Authorization Header option and must allow the Authorization header in their CORS settings.

With no credential, ArcGIS content is read as public content.

How credentials are stored

• API keys are saved in the report as ordinary settings. Anyone who can edit the report can read them, and the visual sends each key to its own provider when it requests tiles. Restrict keys at the provider where you can, for example to the services the map uses.
• The ArcGIS Client Secret is saved in protected form and shown as dots after you enter it.
• Sessions from a personal ArcGIS sign-in are kept in the visual's local storage on the reader's device, not in the report. This needs your Power BI tenant to allow local storage for custom visuals.
• The Icon Map license key, where one is used, is saved in the report in Icon Map Pro > License Key (for non-user based licensing). See License keys and activation.

The proxy

Why a proxy exists

Power BI runs every custom visual in a sandboxed frame. A web server must explicitly allow requests from that frame, through CORS headers, before the visual can read its response. Most public map services do. Some servers do not, typically ArcGIS Enterprise servers and some tile, GeoJSON and WFS servers. A layer from such a server stays blank, even though the same link opens in a browser.

The fix that keeps everything in your control is to allow CORS on your server. When you cannot, the Icon Map proxy can fetch the resource on the visual's behalf and return it with the headers Power BI needs.

The proxy is a relay service run by Icon Map at proxy.icon-map.com. It is off by default. It requires an Icon Map license key, and proxied requests may consume additional usage credits.

When the proxy is used

In this version the proxy is available for WMS reference layers only.

What is sent to the proxy

Nothing is sent to the proxy unless a proxy switch is on, with one exception described under "WMS layers that use OAuth 2.0" below.

To open a session, the visual sends:

• the Icon Map license key from the Icon Map Pro card
• the environment the report is running in (for example Power BI Desktop, the Power BI service or Power BI Embedded)
• the product name
• the optional Reference from the Icon Map Pro card
• the visual's instance ID and a session ID

The proxy answers with a short-lived session token, which the visual reuses until shortly before it expires.

For each proxied request, the visual sends:

• the full address of the resource, including its query string. A token or key that is part of the address travels with it
• the session token
• any extra request headers the server needs, for example an authorization header

The proxy makes the request to your server and passes the response back, including binary content such as tiles. For a WMS layer, if a session cannot be opened, the visual sends the license key and the session details with each request instead of a session token.

What this means:

• The proxy service sees the address of each proxied request, any credential attached to it, and the response.
• The rows of your Power BI data are not sent by this mechanism. Only layer and tile requests are. If you build a layer's link or filter from your data with conditional formatting, the values in that link are part of the address.
• Your server must be reachable from the internet for the proxy to fetch from it. The proxy cannot reach a server that is only available inside your network.

WMS layers that use OAuth 2.0

When a WMS reference layer has its Authentication Type set to OAuth 2.0, the visual requests the access token through the Icon Map proxy service, whether or not Use CORS Proxy is on. That request contains the OAuth2 URL, client ID, client secret and scope you entered for the layer, together with the license key and the session details listed above. See Raster tiles, WMTS and WMS.

Tips and limits

• Prefer fixing CORS on your own server. It avoids the proxy, the license key requirement and the extra hop.
• A link that opens in a browser but not in the map is the usual sign of a CORS block. See Troubleshooting.
• The proxy does not make a private server public. It forwards the credentials your map already uses.
• If your network restricts outbound traffic, allow the provider and Icon Map addresses listed in Supported environments and limits.

Related

• Connect to ArcGIS
• Other basemap providers
• Raster tiles, WMTS and WMS
• Security and certification