Skip to content

Authentication Namespace

Esri::ArcGISRuntime::Authentication

Contains classes related to authentication. More...

Header: #include <Authentication>

Classes

(since Esri::ArcGISRuntime 200.8) class ArcGISAuthenticationChallenge
(since Esri::ArcGISRuntime 200.8) class ArcGISAuthenticationChallengeHandler
(since Esri::ArcGISRuntime 200.8) class ArcGISCredential
(since Esri::ArcGISRuntime 200.8) class ArcGISCredentialStore
(since Esri::ArcGISRuntime 200.8) class AuthenticationManager
(since Esri::ArcGISRuntime 200.8) class CertificateCredential
(since Esri::ArcGISRuntime 200.8) class NetworkAuthenticationChallenge
(since Esri::ArcGISRuntime 200.8) class NetworkAuthenticationChallengeHandler
(since Esri::ArcGISRuntime 200.8) class NetworkCredential
(since Esri::ArcGISRuntime 200.8) class NetworkCredentialStore
(since Esri::ArcGISRuntime 200.8) class OAuthApplicationCredential
(since Esri::ArcGISRuntime 200.8) class OAuthApplicationTokenInfo
(since Esri::ArcGISRuntime 200.8) class OAuthRefreshTokenExpirationInterval
(since Esri::ArcGISRuntime 200.8) class OAuthUserConfiguration
(since Esri::ArcGISRuntime 200.8) class OAuthUserCredential
(since Esri::ArcGISRuntime 200.8) class OAuthUserTokenInfo
(since Esri::ArcGISRuntime 200.8) class PasswordCredential
(since Esri::ArcGISRuntime 200.8) class PregeneratedTokenCredential
(since Esri::ArcGISRuntime 200.8) class ServerTrustCredential
(since Esri::ArcGISRuntime 200.8) class TokenCredential
(since Esri::ArcGISRuntime 200.8) class TokenInfo

Types

(since Esri::ArcGISRuntime 200.8) enum class ArcGISAuthenticationChallengeType { Token, OAuthOrToken }
(since Esri::ArcGISRuntime 200.8) enum class ArcGISCredentialType { TokenCredential, PregeneratedTokenCredential, OAuthUserCredential, OAuthApplicationCredential }
(since Esri::ArcGISRuntime 200.8) enum class NetworkChallengeType { Basic, ClientCertificate, Digest, Negotiate, Ntlm, ServerTrust }
(since Esri::ArcGISRuntime 200.8) enum class NetworkCredentialType { ServerTrust, Password, Certificate }
(since Esri::ArcGISRuntime 200.8) enum class OAuthRefreshTokenExpirationIntervalType { Default, Maximum, Minutes }
(since Esri::ArcGISRuntime 200.8) enum class UserInterfaceStyle { Unspecified, Light, Dark }

Detailed Description

Classes

class ArcGISAuthenticationChallenge

An ArcGIS authentication challenge. More...

class ArcGISAuthenticationChallengeHandler

An interface for handling ArcGIS authentication challenges. More...

class ArcGISCredential

A base class for types of ArcGIS credentials used to access secured resources. More...

class ArcGISCredentialStore

A store for instances of the subclasses of ArcGISCredential. More...

class AuthenticationManager

Manages requests for ArcGIS secure resources made by an application. More...

class CertificateCredential

A certificate network credential, used for authenticating with services secured by Public Key Infrastucure (PKI).. More...

class NetworkAuthenticationChallenge

A network authentication challenge. More...

class NetworkAuthenticationChallengeHandler

An interface for handling network authentication challenges. More...

class NetworkCredential

A base class for credentials that can be used to authenticate network connections. More...

class NetworkCredentialStore

A store for instances of the subclasses of NetworkCredential. More...

class OAuthApplicationCredential

A credential to access OAuth token-secured ArcGIS resources using the application's credentials. More...

class OAuthApplicationTokenInfo

The OAuth application token information that can be used to access OAuth token-secured ArcGIS content and services. More...

class OAuthRefreshTokenExpirationInterval

A class that defines the possible options for requesting an OAuth refresh token expiration interval. More...

class OAuthUserConfiguration

The OAuth user configuration information used by an OAuthUserCredential. More...

class OAuthUserCredential

A credential for accessing OAuth token secured ArcGIS resources. More...

class OAuthUserTokenInfo

The OAuth user token information that can be used by clients, in exchange for user credentials, to access OAuth token-secured ArcGIS content and services. More...

class PasswordCredential

A credential that uses a username and password for authentication with a network secured resource. More...

class PregeneratedTokenCredential

A credential that accesses token-secured ArcGIS content and services using a token generated outside of your application. More...

class ServerTrustCredential

A credential that can be used to authenticate network connections using server trust. More...

class TokenCredential

A credential that accesses token-secured ArcGIS content and services. More...

class TokenInfo

The access token information that can be used by clients in exchange for user credentials. The access token represents the authenticated user for a certain amount of time to access API functionality. More...

Type Documentation

[since Esri::ArcGISRuntime 200.8] enum class ArcGISAuthenticationChallengeType

The types of ArcGIS authentication challenges.

The ArcGISAuthenticationChallengeType can be one of:

ConstantValueDescription
ArcGISAuthenticationChallengeType::Token0The type of challenge issued while accessing token secured ArcGIS resources. This type of challenge can be handled using TokenCredential or PregeneratedTokenCredential.
ArcGISAuthenticationChallengeType::OAuthOrToken1The type of challenge issued while accessing OAuth secured ArcGIS resources. This type of challenge can be handled using OAuthUserCredential or OAuthApplicationCredential. If the OAuth information is not available, this challenge can also be handled using TokenCredential or PregeneratedTokenCredential.

This enum was introduced in Esri::ArcGISRuntime 200.8.

[since Esri::ArcGISRuntime 200.8] enum class ArcGISCredentialType

Types of ArcGISCredential.

ConstantValueDescription
ArcGISCredentialType::TokenCredential1a Token credential type.
ArcGISCredentialType::PregeneratedTokenCredential2a Pregenerated Token credential type.
ArcGISCredentialType::OAuthUserCredential3an OAuth User credential type.
ArcGISCredentialType::OAuthApplicationCredential4an OAuth App credential type.

This enum was introduced in Esri::ArcGISRuntime 200.8.

[since Esri::ArcGISRuntime 200.8] enum class NetworkChallengeType

Types of Network authentication challenges.

ConstantValueDescription
NetworkChallengeType::Basic1Use HTTP basic authentication for the challenge.
NetworkChallengeType::ClientCertificate2Use client certificate authentication for the challenge.
NetworkChallengeType::Digest3Use HTTP digest authentication for the challenge.
NetworkChallengeType::Negotiate4whether to use Kerberos or NTLM authentication for the challenge.
NetworkChallengeType::Ntlm5Use NTLM authentication for the challenge.
NetworkChallengeType::ServerTrust6Perform server trust authentication (certificate validation) for the challenge.

This enum was introduced in Esri::ArcGISRuntime 200.8.

[since Esri::ArcGISRuntime 200.8] enum class NetworkCredentialType

Types of NetworkCredential.

ConstantValueDescription
NetworkCredentialType::ServerTrust1a ServerTrust credential.
NetworkCredentialType::Password2a network credential for username and password authentication.
NetworkCredentialType::Certificate3a network credential for PKI certificate authentication.

This enum was introduced in Esri::ArcGISRuntime 200.8.

[since Esri::ArcGISRuntime 200.8] enum class OAuthRefreshTokenExpirationIntervalType

Types of OAuth refresh token expiration intervals that can be specified

ConstantValueDescription
OAuthRefreshTokenExpirationIntervalType::Default0the default value supported on the portal (two weeks).
OAuthRefreshTokenExpirationIntervalType::Maximum1the maximum value supported on the portal (90 days).
OAuthRefreshTokenExpirationIntervalType::Minutes2a value specified in minutes.

This enum was introduced in Esri::ArcGISRuntime 200.8.

[since Esri::ArcGISRuntime 200.8] enum class UserInterfaceStyle

Constants indicating the interface style.

The UserInterfaceStyle can be one of:

ConstantValueDescription
UserInterfaceStyle::Unspecified0Choose this option when you want to follow the system's interface style.
UserInterfaceStyle::Light1The light interface style.
UserInterfaceStyle::Dark2The dark interface style.

This enum was introduced in Esri::ArcGISRuntime 200.8.

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