Token authentication

View in

Java

Kotlin

View on GitHub

Sample viewer app

Access a web map that is secured with ArcGIS token-based authentication.

Image of token authentication

Use case

Allows you to access a secure service with the convenience and security of ArcGIS token-based authentication. For example, rather than providing a user name and password every time you want to access a secure service, you only provide those creditials initially to obtain a token which then can be used to access secured resources.

How to use the sample

Once you launch the app, you will be challenged for an ArcGIS Online login to view the protected map service. Enter a user name and password for an ArcGIS Online named user account (such as your ArcGIS for Developers account). If you authenticate successfully, the protected map service will display in the map.

How it works

Create an AuthenticationChallengeHandler using the DefaultAuthenticationChallengeHandler to handle the challenges sent by the protected map service.
Set the AuthenticationChallengeHandler to the AuthenticationManager.
Create a Portal.
Create a PortalItem for the protected web map using the Portal and Item ID of the protected map service.
Create a map to display in the MapView using the PortalItem.
Set the map to display in the MapView.

Relevant API

AuthenticationChallengeHandler
AuthenticationManager
DefaultAuthenticationChallengeHandler
Map
MapView
Portal
PortalItem

About the data

The Traffic web map uses public layers as well as the world traffic (premium content) layer. The world traffic service presents historical and near real-time traffic information for different regions in the world. The data is updated every 5 minutes. This map service requires an ArcGIS Online organizational subscription.

Additional information

Please note: the username and password are case sensitive for token-based authentication. If the user doesn't have permission to access all the content within the portal item, partial or no content will be returned.

Sample Code

MainActivity.java
Use dark colors for code blocksCopy
/*
 * Copyright 2019 Esri
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.esri.arcgisruntime.sample.tokenauthentication;

import android.os.Bundle;
import androidx.annotation.Nullable;
import androidx.appcompat.app.AppCompatActivity;

import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.portal.Portal;
import com.esri.arcgisruntime.portal.PortalItem;
import com.esri.arcgisruntime.security.AuthenticationChallengeHandler;
import com.esri.arcgisruntime.security.AuthenticationManager;
import com.esri.arcgisruntime.security.DefaultAuthenticationChallengeHandler;

public class MainActivity extends AppCompatActivity {

  private MapView mMapView;

  @Override protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    mMapView = findViewById(R.id.mapView);

    // set up an authentication handler to take credentials for access to the protected map service
    AuthenticationChallengeHandler handler = new DefaultAuthenticationChallengeHandler(this);
    AuthenticationManager.setAuthenticationChallengeHandler(handler);

    // create a portal to ArcGIS Online
    Portal portal = new Portal(getString(R.string.arcgis_online_portal_url));

    // create a portal item using the portal and the item id of a protected map service
    PortalItem portalItem = new PortalItem(portal, getString(R.string.map_service_world_traffic_id));

    // create a map with the portal item
    ArcGISMap map = new ArcGISMap(portalItem);

    // set the map to be displayed in the map view
    mMapView.setMap(map);
  }

  @Override protected void onResume() {
    super.onResume();
    mMapView.resume();
  }

  @Override protected void onPause() {
    mMapView.pause();
    super.onPause();
  }

  @Override protected void onDestroy() {
    mMapView.dispose();
    super.onDestroy();
  }
}