Authenticate with OAuth

View inJavaKotlin
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).

Image of authenticate with OAuth

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 to verified users. You may also need to take advantage of premium ArcGIS Online services, such as geocoding or routing services, which 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. Set the AuthenticationManager's AuthenticationChallengeHandler to a DefaultAuthenticationChallengeHandler.
  2. Create an OAuthConfiguration specifying the portal URL, client ID, and redirect URL.
  3. Add the OAuth configuration to the authentication manager.
  4. Load a map with premium content requiring authentication to automatically invoke the default authentication handler.

Relevant API

  • AuthenticationManager
  • AuthenticationChallengeHandler
  • OAuthConfiguration
  • PortalItem

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].(https://doc.arcgis.com/en/arcgis-online/administer/enterprise-logins.htm).

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

MainActivity.kt
                                                                                                                    
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*
 * Copyright 2020 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.authenticatewithoauth

import android.os.Bundle
import android.util.Log
import android.widget.Toast
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.sample.authenticatewithoauth.databinding.ActivityMainBinding
import com.esri.arcgisruntime.security.AuthenticationManager
import com.esri.arcgisruntime.security.DefaultAuthenticationChallengeHandler
import com.esri.arcgisruntime.security.OAuthConfiguration
import java.net.MalformedURLException


class MainActivity : AppCompatActivity() {

  companion object {
    private val TAG: String = MainActivity::class.java.simpleName
  }

  private val activityMainBinding by lazy {
    ActivityMainBinding.inflate(layoutInflater)
  }

  private val mapView: MapView by lazy {
    activityMainBinding.mapView
  }

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(activityMainBinding.root)

    try {
      // set up an oauth config with url to portal, a client id and a re-direct url
      // a custom client id for your app can be set on the ArcGIS for Developers dashboard under
      // Authentication --> Redirect URIs
      val oAuthConfiguration = OAuthConfiguration(
        getString(R.string.portal_url),
        getString(R.string.oauth_client_id),
        getString(R.string.oauth_redirect_uri) + "://" + getString(R.string.oauth_redirect_host)
      )

      // setup AuthenticationManager to handle auth challenges
      val defaultAuthenticationChallengeHandler = DefaultAuthenticationChallengeHandler(this)

      // use the DefaultChallengeHandler to handle authentication challenges
      AuthenticationManager.setAuthenticationChallengeHandler(
        defaultAuthenticationChallengeHandler
      )

      // add an OAuth configuration
      // NOTE: you must add the DefaultOAuthIntentReceiver Activity to the app's manifest to handle starting a browser
      AuthenticationManager.addOAuthConfiguration(oAuthConfiguration)

      // load the portal and add the portal item as a map to the map view
      val portal = Portal(getString(R.string.portal_url))
      val portalItem = PortalItem(portal, getString(R.string.webmap_world_traffic_id))
      mapView.apply {
        map = ArcGISMap(portalItem)
      }
    } catch (e: MalformedURLException) {
      logError("Error in OAuthConfiguration URL: " + e.message)
    }
  }

  override fun onResume() {
    super.onResume()
    mapView.resume()
  }

  override fun onPause() {
    // normally, you won't want to clear credentials once a device has been verified. These calls are made to keep this
    // sample from interfering with other authentication samples
    AuthenticationManager.CredentialCache.clear()
    AuthenticationManager.clearOAuthConfigurations()

    mapView.pause()
    super.onPause()
  }

  override fun onDestroy() {
    mapView.dispose()
    super.onDestroy()
  }

  /**
   * Log an error to logcat and to the screen via Toast.
   * @param message the text to log.
   */
  private fun logError(message: String?) {
    message?.let {
      Log.e(TAG, message)
      Toast.makeText(this, message, Toast.LENGTH_LONG).show()
    }
  }
}

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