ArcGISOAuthUserConfiguration

Namespace: Esri::GameEngine::Authentication
Class: Esri/GameEngine/Authentication/ArcGISOAuthUserConfiguration
Since: 1.1.0
Implements: ArcGISJSONSerializable

Summary

The OAuth user configuration information used by an ArcGISOAuthUserCredential.

Constructors

ArcGISOAuthUserConfiguration(const FString&, const FString&, const FString&, const FString&, int32_t, int32_t, int32_t, bool, ArcGISUserInterfaceStyle, bool)

Creates an OAuth configuration with the specified parameters.

Since 1.1.0

Arguments

Name	Type	Const	Summary
`portalURL`	`FString`	`Yes`	The URL of the portal to authenticate with.
`clientId`	`FString`	`Yes`	A unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication.
`redirectURL`	`FString`	`Yes`	The URL that the OAuth login page redirects to when authentication completes.
`culture`	`FString`	`Yes`	The OAuth login page is displayed in the language specified by the given culture code.
`refreshTokenExpirationInterval`	`int32_t`	`Yes`	The requested expiration interval (in minutes) for the refresh token. The max interval can be overridden by the portal administrator. The value `-1` returns the maximum refresh token expiration interval supported by the portal, which is usually set to ninety days. The portal administrator has the ability to decrease this maximum value. The value `0` returns the default refresh token expiration interval configured on the portal, typically two weeks. This default value may be affected if the portal administrator sets the maximum refresh token value (ninety days) to less than two weeks.
`refreshTokenExchangeInterval`	`int32_t`	`Yes`	The requested exchange interval (in minutes) for the OAuth refresh token. Use this to exchange a refresh token before it expires. This will limit the number of times a user will have to login because of expiring tokens.
`federatedTokenExpirationInterval`	`int32_t`	`Yes`	The requested expiration interval (in minutes) for federated tokens generated using the OAuth credential.
`showCancelButton`	`bool`	`Yes`	A Boolean value indicating whether to show "Cancel" button on the OAuth login page.
`userInterfaceStyle`	`ArcGISUserInterfaceStyle`	`Yes`	Constants indicating the interface style for the OAuth login page.
`preferPrivateWebBrowserSession`	`bool`	`Yes`	A Boolean value indicating whether the OAuth login session should ask the browser for a private authentication session.

Properties

Property	Type	Nullable	Readonly	Summary
`ClientId`	`FString`	`No`	`Yes`	A unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication.
`Culture`	`FString`	`No`	`Yes`	The OAuth login page is displayed in the language specified by the given culture code.
`FederatedTokenExpirationInterval`	`int32_t`	`No`	`Yes`	The requested expiration interval (in minutes) for federated tokens generated using the OAuth credential.
`PortalURL`	`FString`	`No`	`Yes`	The URL of the portal to authenticate with.
`PreferPrivateWebBrowserSession`	`bool`	`No`	`Yes`	A Boolean value indicating whether the OAuth login session should ask the browser for a private authentication session.
`RedirectURL`	`FString`	`No`	`Yes`	The URL that the OAuth login page will redirect to when authentication completes.
`RefreshTokenExchangeInterval`	`int32_t`	`No`	`Yes`	The requested exchange interval (in minutes) for the OAuth refresh token. Use this to exchange a refresh token before it expires. This will limit the number of times a user will have to login because of expiring tokens.
`RefreshTokenExpirationInterval`	`int32_t`	`No`	`Yes`	The requested expiration interval (in minutes) for the refresh token. The maximum interval can be overridden by the portal administrator.
`ShowCancelButton`	`bool`	`No`	`Yes`	A Boolean value indicating whether to show the "Cancel" button on the OAuth login page.
`UserInterfaceStyle`	`ArcGISUserInterfaceStyle`	`No`	`Yes`	Constants indicating the interface style for the OAuth login page.

ClientId

FString GetClientId() const

A unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication.

Culture

FString GetCulture() const

The OAuth login page is displayed in the language specified by the given culture code.

If not explicitly set, the culture used by the device/machine is used. If the culture is not supported by the portal then OAuth login page will be displayed in the language corresponding to culture specified in the portal/organization settings. The format for culture code is based on a language code and a country code separated by a dash. Example: "en-US".

FederatedTokenExpirationInterval

int32_t GetFederatedTokenExpirationInterval() const

The requested expiration interval (in minutes) for federated tokens generated using the OAuth credential.

PortalURL

FString GetPortalURL() const

The URL of the portal to authenticate with.

PreferPrivateWebBrowserSession

bool GetPreferPrivateWebBrowserSession() const

A Boolean value indicating whether the OAuth login session should ask the browser for a private authentication session.

RedirectURL

FString GetRedirectURL() const

The URL that the OAuth login page will redirect to when authentication completes.

RefreshTokenExchangeInterval

int32_t GetRefreshTokenExchangeInterval() const

The requested exchange interval (in minutes) for the OAuth refresh token. Use this to exchange a refresh token before it expires. This will limit the number of times a user will have to login because of expiring tokens.

If the exchange interval is set to 0 or less than 0, then the refresh token will never be exchanged and will eventually expire, causing the user to have to log in again.

To have any affect, this should be set to a value less than the ArcGISOAuthUserConfiguration::RefreshTokenExpirationInterval. Setting it to a value greater than the ArcGISOAuthUserConfiguration::RefreshTokenExpirationInterval will have the same effect as setting this to 0.

It is recommended to keep this interval as low as possible because long lived refresh tokens may increase the security risk.

RefreshTokenExpirationInterval

int32_t GetRefreshTokenExpirationInterval() const

The requested expiration interval (in minutes) for the refresh token. The maximum interval can be overridden by the portal administrator.

The value -1 returns the maximum refresh token expiration interval supported by the portal, which is usually set to ninety days. The portal administrator has the ability to decrease this maximum value.
The value 0 returns the default refresh token expiration interval configured on the portal, typically two weeks. This default value may be affected if the portal administrator sets the maximum refresh token value (ninety days) to less than two weeks.

ShowCancelButton

bool GetShowCancelButton() const

A Boolean value indicating whether to show the "Cancel" button on the OAuth login page.

UserInterfaceStyle

ArcGISUserInterfaceStyle GetUserInterfaceStyle() const

Constants indicating the interface style for the OAuth login page.

The default is ArcGISUserInterfaceStyle::Unspecified.

Methods

Signature	Return Type	Summary
CanBeUsedForURL(const FString&)	bool	Checks if this configuration can be used for the given URL.
Equals(const ArcGISOAuthUserConfiguration&)	bool	Tests if the two ArcGISOAuthUserConfiguration objects are equal.

CanBeUsedForURL

bool CanBeUsedForURL(const FString& URL) const

Checks if this configuration can be used for the given URL.

Since 1.1.0

Arguments

Name	Type	Const	Summary
`URL`	`FString`	`Yes`	The URL to check.

Returns bool

True if this configuration can be used, otherwise false.

Equals

bool Equals(const ArcGISOAuthUserConfiguration& other) const

Tests if the two ArcGISOAuthUserConfiguration objects are equal.

Since 1.1.0

Arguments

Name	Type	Const	Summary
`other`	`ArcGISOAuthUserConfiguration`	`Yes`	The configuration to compare to.

Returns bool

True if the comparison succeeds and the objects are equal, false otherwise.