Authenticate with OAuth

View on GitHub
Sample viewer app

Authenticate with ArcGIS Online (or your own portal) using OAuth2 to access secured resources (such as private web maps or layers).

Login screen Map view after authentication

Use case

Your app may need to access items that are only shared with authorized users. For example, your organization may host private data layers or feature services that are only accessible by verified users. You may also need to take advantage of premium ArcGIS Online services, such as geocoding or routing, that require a named user login.

How to use the sample

When you run the sample, the app will load a web map which contains premium content. You will be challenged for an ArcGIS Online login to view the private layers. 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 traffic layer will display, otherwise the map will contain only the public basemap layer.

How it works

  1. Create an AGSOAuthConfiguration specifying the portal URL, client ID, and redirect URL.
  2. Add the OAuth configuration to the authentication manager.
  3. Load a map with premium content requiring authentication to automatically invoke the default authentication manager.

Relevant API

  • AGSAuthenticationManager
  • AGSOAuthConfiguration
  • AGSPortalItem

Additional information

The workflow presented in this sample works for all SAML based enterprise (IWA, PKI, Okta, etc.) & social (Facebook, Google, etc.) identity providers for ArcGIS Online or Portal. For more information, see the topic Set up enterprise logins.

For additional information on using OAuth in your app, see the topic Authenticate with the API in Mobile and Native Named User Login.

Tags

authentication, cloud, credential, OAuth, portal, security

Sample Code

AuthenticateWithOAuthViewController.swift
                                                                                      
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
//
// 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.
//

import UIKit
import ArcGIS

/// The URL of the portal with which to authenticate.
private let portalURL = URL(string: "https://www.arcgis.com")!
/// The Client ID for an app registered with the server. The provided ID is for
/// a public app created by the ArcGIS Runtime team.
private let portalItemID = "e5039444ef3c48b8a8fdc9227f9be7c1"

/// The identifier with which this application was registered with the portal.
private let clientID = "lgAdHkYZYlwwfAhC"
/// The URL for redirecting after a successful authorization (this must be
/// configured in the Info plist).
private let redirectURLString = "my-ags-app://auth"

/// A view controller that manages the interface of the Authenticate with OAuth
/// sample.
class AuthenticateWithOAuthViewController: UIViewController {
    /// The map view managed by the view controller.
    @IBOutlet weak var mapView: AGSMapView! {
        didSet {
            mapView.map = makeMap()
        }
    }

    /// Creates a map.
    ///
    /// - Returns: A new `AGSMap` object.
    func makeMap() -> AGSMap {
        let portal = AGSPortal(url: portalURL, loginRequired: true)
        let portalItem = AGSPortalItem(portal: portal, itemID: portalItemID)
        return AGSMap(item: portalItem)
    }

    /// The OAuth configuration provided to the authentication manager.
    let oAuthConfiguration = AGSOAuthConfiguration(portalURL: portalURL, clientID: clientID, redirectURL: redirectURLString)

    required init?(coder aDecoder: NSCoder) {
        super.init(coder: aDecoder)

        AGSAuthenticationManager.shared().delegate = self
        AGSAuthenticationManager.shared().oAuthConfigurations.add(oAuthConfiguration)
    }

    deinit {
        AGSAuthenticationManager.shared().oAuthConfigurations.remove(oAuthConfiguration)
        AGSAuthenticationManager.shared().credentialCache.removeAllCredentials()
    }

    // MARK: UIViewController

    override func viewDidLoad() {
        super.viewDidLoad()

        (navigationItem.rightBarButtonItem as? SourceCodeBarButtonItem)?.filenames = [
            "AuthenticateWithOAuthViewController"
        ]
    }
}

extension AuthenticateWithOAuthViewController: AGSAuthenticationManagerDelegate {
    func authenticationManager(_ authenticationManager: AGSAuthenticationManager, wantsToShow viewController: UIViewController) {
        viewController.modalPresentationStyle = .formSheet
        present(viewController, animated: true)
    }

    func authenticationManager(_ authenticationManager: AGSAuthenticationManager, wantsToDismiss viewController: UIViewController) {
        dismiss(animated: true)
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.