Access services with OAuth credentials

Learn how to implement user authentication to access a secure ArcGIS service with OAuth credentials.

You can use different types of authentication to access secured ArcGIS services. To implement OAuth credentials for user authentication, you can use your ArcGIS account to register an app with your portal and get a Client ID, and then configure your app to redirect users to login with their credentials when the service or content is accessed. This is known as user authentication. If the app uses premium ArcGIS Online services that consume credits, for example, the app user's account will be charged.

In this tutorial, you will build an app that implements user authentication using OAuth credentials so users can sign in and be authenticated through ArcGIS Online to access the ArcGIS World Traffic service.

Prerequisites

Before starting this tutorial:

You need an ArcGIS Location Platform or ArcGIS Online account.
Your system meets the system requirements.
The ArcGIS Runtime API for Qt is installed.

Steps

Download the ArcGIS Runtime Toolkit for Qt

The open-source ArcGIS Runtime Toolkit for Qt contains UI components and utilities to help simplify your Qt app development. For this OAuth tutorial app we will use the toolkit that provides the AuthenticationView class, which has a dialog that automatically displays the proper authentication view for any of the supported authentication types (OAuth, Token, HTTP Basic, HTTP Digest, SAML, PKI).

To configure the toolkit for use in this tutorial, you need to copy the ArcGIS Runtime Toolkit for Qt repository in GitHub onto your development machine.
You can do this by cloning the ArcGIS Runtime Toolkit for Qt repo (using the the URL: https://github.com/Esri/arcgis-runtime-toolkit-qt.git) or downloading the .zip version of the repo and unzipping it to your preferred location on your development machine.

IMPORTANT: Make a particular note for the path to the toolkitcpp.pri file that is in the directory structure of the toolkit on your development machine. You will need to reference the path to this file later in the tutorial (for example: C:/arcgis-runtime-toolkit-qt/toolkit/uitools/toolkitcpp.pri).

Create OAuth credentials

OAuth credentials are required to implement user authentication. These credentials are created as an Application item in your organization's portal.

Sign in to your portal.
Click Content > My content > New item and select Developer credentials.
In the Create developer credentials window, select OAuth 2.0 credentials radio button and click Next.
Add a Redirect URL to your OAuth credentials: urn:ietf:wg:oauth:2.0:oob. The remaining properties, Referrer URLs, Application environment and URL, can remain with their default values. Click Next.
For Privileges, click Next. Privileges are not required for this tutorial.
Click Skip to move past Grant item access as it is not required for this tutorial.
Provide a Title of your choice. Optionally, stipulate a Folder to store your Application item, add Tags, and add a Summary. Click Next.
Review your settings and go back to correct any errors. When you are ready, click Create. When the application item is created, Client ID, Client Secret, and Temporary Token values will also be generated. You will be redirected to the Application item's Overview page.

The Client ID uniquely identifies your app on the authenticating server. If the server cannot find an app with the provided Client ID, it will not proceed with authentication.

The Redirect URL is used to identify a response from the authenticating server when the system returns control back to your app after an OAuth sign in. You can configure several redirect URLs in your application definition and can remove or edit them. It's important to make sure the redirect URL used in your app's code matches a redirect URL configured for the application.

IMPORTANT: Make a particular note for the Client ID string that is generated. You will need to use this string later in the tutorial (for example: XYZ123).

Open the project in Qt Creator

To start this tutorial, complete the Display a map tutorial or download and unzip the solution.
Open the display_a_map project in Qt Creator.

Implement user authentication using OAuth credentials

The OAuth sign in web page is implemented using Qt WebEngine and the AuthenticationView class, which is part of the ArcGIS Toolkit.

Open display_a_map.pro and add webengine to the list of included modules. WebEngine is a Qt module that can display an OAuth sign in web page in your app.

display_a_map.pro
Expand
Use dark colors for code blocks
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
16
17
18
19
20
21
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
21
20
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
Change lineTEMPLATE = app

CONFIG += c++14

# additional modules are pulled in via arcgisruntime.pri

QT += opengl qml quick webengine
Expand

To utilize AuthenticationView , add the path to where the toolkitcpp.pri file is located on your development system (for example: C:/arcgis-runtime-toolkit-qt/toolkit/uitools/toolkitcpp.pri). Then save and close display_a_map.pro.

display_a_map.pro
Expand
Use dark colors for code blocks
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
34
35
36
37
38
39
40
41
42
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
43
Add line.Add line.equals(QT_MAJOR_VERSION, 6) {
  error("This version of the ArcGIS Runtime SDK for Qt is incompatible with Qt 6")
}

ARCGIS_RUNTIME_VERSION = 100.15.0
include($$PWD/arcgisruntime.pri)

# Set the path to the toolkit, absolute or relative to this app.
include(<path_to_toolkit_repo>/toolkit/uitools/toolkitcpp.pri) # example: C:/arcgis-runtime-toolkit-qt/toolkit/uitools/toolkitcpp.pri
Expand

In the project Sources folder, open main.cpp. Remove these #include statements. These Qt types are not needed for this tutorial.

main.cpp
Expand
Use dark colors for code blocks
16
16
16
16
16
16
16
16
16
16
16
16
16
16
16
16
17
18
19
20
21
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
22
Remove lineRemove lineRemove line#include "ArcGISRuntimeEnvironment.h"
#include "MapQuickView.h"

#include <QDir>
#include <QGuiApplication>
#include <QQmlApplicationEngine>
Expand

Include QtWebEngine, and register.h for the ArcGIS Runtime Toolkit.

main.cpp
Expand
Use dark colors for code blocks
16
16
16
16
16
16
16
16
16
16
16
16
16
16
16
16
17
18
19
20
21
21
21
21
21
21
21
21
21
21
21
21
20
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
19
18
17
16
16
16
16
16
16
16
16
16
16
16
Add line.Add line.#include "ArcGISRuntimeEnvironment.h"
#include "MapQuickView.h"

#include <QtWebEngine>
#include "Esri/ArcGISRuntime/Toolkit/register.h"
Expand

Add code to initialize QtWebEngine.

main.cpp
Expand
Use dark colors for code blocks
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
27
28
29
30
31
32
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
33
32
31
30
30
30
30
30
30
30
30
30
30
30
Add line.int main(int argc, char *argv[])
{
    QGuiApplication::setAttribute(Qt::AA_EnableHighDpiScaling);
    QGuiApplication app(argc, argv);

    QtWebEngine::initialize();
Expand

main.cpp
Expand
Use dark colors for code blocks
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
69
70
71
72
73
74
75
76
77
77
77
77
77
77
77
77
77
77
77
77
Add line.Add line.    // Register the Display_a_map (QQuickItem) for QML
    qmlRegisterType<Display_a_map>("Esri.display_a_map", 1, 0, "Display_a_map");

    // Initialize application view
    QQmlApplicationEngine engine;

    // Register the Toolkit
    Esri::ArcGISRuntime::Toolkit::registerComponents(engine);
Expand

Navigate to Resources > qml\qml.qrc > qml and open Display_a_mapForm.qml. Import the ArcGIS Runtime Toolkit. Be sure set the version to your installed ArcGIS Runtime version.
Display_a_mapForm.qml
Expand
Use dark colors for code blocks
14 14 14 14 14 14 14 14 14 14 14 14 14 14 15 16 17 18 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 18 17 16 15 14 13 13
Add line.
```
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
import QtQuick 2.6
import QtQuick.Controls 2.2
import Esri.display_a_map 1.0

import Esri.ArcGISRuntime.Toolkit 100.13
```
Expand
Now that the toolkit is available, declare an AuthenticationView component. Then save and close Display_a_mapForm.qml.

AuthenticationView is an ArcGIS Runtime Toolkit component that simplifies the authentication workflow by using AuthenticationManager to automatically display the correct login user interface for each security method (Token, OAuth, PKI, and so on). For more information, see AuthenticationView .
Display_a_mapForm.qml
Expand
Use dark colors for code blocks
30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 31 32 33 34 35 36 37 38 39 40 41 41 41
Add line.Add line.Add line.Add line.Add line.
```
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    // Declare the C++ instance that creates the map etc., and supply the view.
    Display_a_map {
        id: model
        mapView: view
    }

    // Declare an AuthenticationView to support login.
    AuthenticationView {
        id: authView
        anchors.fill: parent
    }
```
Expand

Add required class header files

Several additional classes are required to support the functionality your app needs. Specifically, for managing OAuth authentication, creating a credential, creating an image layer, and accessing the secured traffic layer portal item.

In the project Sources folder, open Display_a_map.cpp. Include the six required header files as shown.

Display_a_map.cpp
Expand
Use dark colors for code blocks
18
18
18
18
18
18
18
18
18
18
18
18
18
18
18
18
18
18
19
20
21
22
23
24
25
26
27
28
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
29
27
25
23
23
22
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
21
Add line.Add line.Add line.Add line.Add line.#include "Basemap.h"
#include "Map.h"

#include "MapQuickView.h"
#include <QUrl>

#include "Credential.h"
#include "OAuthClientInfo.h"
#include "Portal.h"
#include "PortalItem.h"
#include "ArcGISMapImageLayer.h"
Expand

Create a credential and portal to access secured services

You can use an instance of the Portal class to access secure services on your portal. In the constructor, you can either provide the portal URL or leave it out to use ArcGIS Online by default. You can also provide a Credential in the constructor to use when accessing secured services.

In the setupViewpoint function, add the following code to create Credential . Paste your Client ID (created earlier with Create OAuth credentials) to replace the "CLIENT_ID" placeholder. Also be sure that OAuthMode is set to User.

Display_a_map.cpp
Expand
Use dark colors for code blocks
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
49
50
51
52
53
54
55
56
57
57
57
56
55
55
54
53
52
51
50
49
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
48
Add line.Add line.void Display_a_map::setupViewpoint()
{

    const Point center(-118.80543, 34.02700, SpatialReference::wgs84());
    const Viewpoint viewpoint(center, 100000.0);
    m_mapView->setViewpoint(viewpoint);

    // Create a credential for this app and set the authentication mode.
    Credential* credential = new Credential(OAuthClientInfo("CLIENT_ID", OAuthMode::User), this); // Change the CLIENT_ID to your string, example "XYZ123"
Expand

Create a Portal that will use credential to gain access to the secured ArcGIS World Traffice service.

Display_a_map.cpp
Expand
Use dark colors for code blocks
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
51
52
53
54
55
56
57
58
59
60
60
60
59
58
57
56
55
54
53
53
53
53
53
53
53
53
53
53
53
53
53
53
53
53
Add line.    const Point center(-118.80543, 34.02700, SpatialReference::wgs84());
    const Viewpoint viewpoint(center, 100000.0);
    m_mapView->setViewpoint(viewpoint);

    // Create a credential for this app and set the authentication mode.
    Credential* credential = new Credential(OAuthClientInfo("CLIENT_ID", OAuthMode::User), this); // Change the CLIENT_ID to your string, example "XYZ123"


    Portal* portal = new Portal(credential, this);
Expand

Add the secured traffic layer

The ArcGIS World Traffic service is a dynamic map service that presents historical and near real-time traffic information for different regions of the world. This service requires an ArcGIS Online organizational subscription. You will add a portal item referencing this service and use the item to create a traffic layer.

ArcGIS World Traffic service data is updated every five minutes to provide traffic speed and traffic incident visualization and identification. Traffic speeds are displayed as a percentage of free-flow speeds, which is frequently the speed limit or how fast cars tend to travel when unencumbered by other vehicles. The streets are color coded as follows:

Green (fast): 85 - 100% of free flow speeds
Yellow (moderate): 65 - 85%
Orange (slow); 45 - 65%
Red (stop and go): 0 - 45%

Create a PortalItem using the traffic service's item ID. Then create an ArcGISMapImageLayer to display the traffic service. Finally, append the traffic layer to the map's collection of data layers (operational layers)

Display_a_map.cpp
Expand
Use dark colors for code blocks
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
55
56
57
58
59
60
61
62
63
64
65
66
67
68
68
68
68
68
68
68
68
68
68
68
68
68
68
68
68
68
Add line.Add line.Add line.Add line.Add line.Add line.    // Create a credential for this app and set the authentication mode.
    Credential* credential = new Credential(OAuthClientInfo("CLIENT_ID", OAuthMode::User), this); // Change the CLIENT_ID to your string, example "XYZ123"


    Portal* portal = new Portal(credential, this);


    // Create a layer to display the ArcGIS World Traffic service.
    // traffic layer https://www.arcgis.com/home/item.html?id=ff11eb5b930b4fabba15c47feb130de4
    PortalItem* item = new PortalItem(portal, "ff11eb5b930b4fabba15c47feb130de4", this);
    ArcGISMapImageLayer* imageLayer = new ArcGISMapImageLayer(item, this);
    // Append the traffic layer to the map's data layer collection.
    m_map->operationalLayers()->append(imageLayer);
Expand

Press Ctrl + R to run the app.

You should briefly see a map with the topographic basemap layer centered on the Santa Monica Mountains in California. The AuthenticationView will then prompt you with an OAuth sign in page to enter your ArcGIS Online username and password. After authenticating successfully with ArcGIS Online, the map will appear with the traffic layer also displayed.