Skip to content

Collection of Authentication enumerations. More...

Header: #include <Authentication/AuthenticationTypes.h>

Types

(since Esri::ArcGISRuntime 200.8) enum class ArcGISAuthenticationChallengeType { Token, OAuthOrToken }
(since Esri::ArcGISRuntime 200.8) enum class ArcGISCredentialType { TokenCredential, PregeneratedTokenCredential, OAuthUserCredential, OAuthApplicationCredential, IapCredential }
(since Esri::ArcGISRuntime 300.0) enum class IapAuthorizationPromptType { Unspecified, None, Login, Consent, SelectAccount }
(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

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.
ArcGISCredentialType::IapCredential5an Identity-Aware Proxy (IAP) credential type. (since 300.0)

This enum was introduced in Esri::ArcGISRuntime 200.8.

[since Esri::ArcGISRuntime 300.0] enum class IapAuthorizationPromptType

The type of user interaction required for authentication and consent while signing in to the Identity-Aware Proxy (IAP).

The IapAuthorizationPromptType can be one of:

ConstantValueDescription
IapAuthorizationPromptType::Unspecified0The default user interaction behavior for the Identity-Aware Proxy (IAP). This optimizes the user experience by minimizing unnecessary credential prompts. The single sign-on (SSO) experience is determined by the authenticated Identity-Aware Proxy (IAP) session within the web session. - User will not be prompted to enter credential unless necessary. - If multiple user accounts are signed in, a select account interface will be displayed to allow users to choose their desired account.
IapAuthorizationPromptType::None1User interface is not displayed for authentication and consent while signing in to the Identity-Aware Proxy (IAP). If no authenticated Identity-Aware Proxy (IAP) session is found, an error is returned. This can be used as a method to check for existing authentication and/or consent.
IapAuthorizationPromptType::Login2Disables single sign-on (SSO) functionality, requiring users to enter their credentials for every login attempt. It enhances security by requiring authentication for every session, rather than relying on a previously authenticated Identity-Aware Proxy (IAP) session.
IapAuthorizationPromptType::Consent3Displays a consent dialog after user signs in, prompting them to grant necessary permissions to the application. If consent cannot be obtained, an error is returned.
IapAuthorizationPromptType::SelectAccount4Interrupts the single sign-on (SSO) experience when one or more authenticated Identity-Aware Proxy (IAP) sessions are detected, presenting users with an account selection interface to choose their preferred account.

This enum was introduced in Esri::ArcGISRuntime 300.0.

[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.