Token authentication

View on GitHub

Sample viewer app

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

screenshot

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 a Portal.
Create a PortalItem for the protected web map using the Portal and Item ID of the protected map service.
Create a Map using the PortalItem.
Set the map to display in the MapView.

Relevant API

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

TokenAuthentication.cpp

TokenAuthentication.h

TokenAuthentication.qml

Use dark colors for code blocksCopy
// [WriteFile Name=TokenAuthentication, Category=CloudAndPortal]
// [Legal]
// Copyright 2016 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.
// [Legal]

#ifdef PCH_BUILD
#include "pch.hpp"
#endif // PCH_BUILD

#include "TokenAuthentication.h"

#include "Map.h"
#include "MapQuickView.h"
#include "Portal.h"
#include "PortalItem.h"
#include "MapViewTypes.h"

#include <QUrl>

namespace
{
  QUrl portalURL = QUrl("https://www.arcgis.com/");
  QString itemID = "e5039444ef3c48b8a8fdc9227f9be7c1";
}

using namespace Esri::ArcGISRuntime;

TokenAuthentication::TokenAuthentication(QQuickItem* parent /* = nullptr */):
  QQuickItem(parent)
{
  // Create local portal and portalItem objects using constants defined for portalURL and itemID.
  Portal* portal = new Portal(portalURL, this);
  PortalItem* portalItem = new PortalItem(portal, itemID, this);

  // Create a map object using the local portalItem variable
  m_map = new Map(portalItem, this);
}

TokenAuthentication::~TokenAuthentication() = default;

void TokenAuthentication::init()
{
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<TokenAuthentication>("Esri.Samples", 1, 0, "TokenAuthenticationSample");
}

void TokenAuthentication::componentComplete()
{
  QQuickItem::componentComplete();

  // find QML MapView component
  m_mapView = findChild<MapQuickView*>("mapView");
  if (!m_mapView)
    return;

  m_mapView->setWrapAroundMode(WrapAroundMode::Disabled);

  // Set map to map view
  m_mapView->setMap(m_map);
}