The Authenticator widget handles authentication challenges.

Overview

A user interface is displayed when network and ArcGIS authentication challenges occur.

Features

The Authenticator will handle many different types of authentication, for example:

• ArcGIS authentication (token and OAuth)
• Integrated Windows Authentication (IWA)
• Client Certificate (PKI)
• Identity-Aware Proxy (IAP)
• If credentials were persisted to the keychain, the authenticator will use those instead of requiring the user to re-enter credentials.

Usage

An Authenticator can be placed anywhere in your widget tree, though it makes the most sense to use it as the parent of the ArcGISMapView or ArcGISSceneView widget. It will then handle authentication challenges from loading network resources.

To use OAuth, provide one or more OAuthUserConfigurations in the Authenticator.oAuthUserConfigurations parameter. Otherwise, the user will be prompted to sign in using a username and password to obtain a TokenCredential.

If a service is protected by an Identity-Aware Proxy (IAP), provide its IapConfiguration in the Authenticator.iapConfigurations parameter.

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Authenticator(
        oAuthUserConfigurations: [
          OAauthUserConfiguration(
            portalUri: Uri.parse('https://www.arcgis.com'),
            clientId: 'YOUR-CLIENT-ID',
            redirectUri: Uri.parse('YOUR-REDIRECT-URL'),
          ),
        ],
        iapConfigurations: [
          IapConfiguration.fromJsonString(yourConfigurationJson),
        ],
        child: ArcGISMapView(
          controllerProvider: () => _mapViewController,
        ),
      ),
    );
  }

During application sign-out, you should revoke all tokens and clear all credentials from the credential stores. Use Authenticator.revokeOAuthTokens and Authenticator.invalidateIapCredentials as required, then Authenticator.clearCredentials. In addition, consider also clearing the HTTP cache, using ArcGISEnvironment.httpClient.cache.evictAll(), to prevent cached responses from being accessed without the credentials that were used to originally fetch them.

More information

To learn more about using OAuth with ArcGIS accounts, see: https://developers.arcgis.com/documentation/security-and-authentication/user-authentication/

To configure OAuth for use in your ArcGIS Maps SDK for Flutter app, see: https://developers.arcgis.com/flutter/install-and-set-up/#enabling-user-authentication