ArcGISOAuthAuthenticationConfiguration

Namespace: Esri::GameEngine::Security
Class: Esri/GameEngine/Security/ArcGISOAuthAuthenticationConfiguration
Since: 1.0.0
Inheritance: ArcGISAuthenticationConfiguration->ArcGISOAuthAuthenticationConfiguration

Summary

A class that contains authentication information for OAuth2

Constructors

ArcGISOAuthAuthenticationConfiguration(const FString&, const FString&, const FString&)

Creates a authentication information object for OAuth 2

Since 1.0.0

Arguments
NameTypeConstSummary
clientId
Yes

The client identifier.

clientSecret
Yes

The client secret. Mandatory for App Login.

redirectURI
Yes

The redirect URI. Mandatory for Named User Login.

ArcGISOAuthAuthenticationConfiguration(const FString&, const FString&, const FString&, const ArcGISOAuthAuthorizationCredential&)

Creates an authentication information object for OAuth 2 including credentials

Since 1.0.0

Arguments
NameTypeConstSummary
clientId
Yes

The client identifier.

clientSecret
Yes

The client secret. Mandatory for App Login.

redirectURI
Yes

The redirect URI. Mandatory for Named User Login.

authenticationCredential
Yes

The authentication credential.

Properties

PropertyTypeNullableReadonlySummary
Yes
Yes

The current authorization credential

No
Yes

The current client id

No
Yes

The current client secret

No
Yes

The current redirect uri

AuthorizationCredential

ArcGISOAuthAuthorizationCredential GetAuthorizationCredential() const

The current authorization credential

ClientId

FString GetClientId() const

The current client id

ClientSecret

FString GetClientSecret() const

The current client secret

RedirectURI

FString GetRedirectURI() const

The current redirect uri

Events

NameTypeSummary
AuthorizationCredentialIssuedEvent

Sets the callback invoked when a new OAuth2 authorization credential is issued

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