Namespace: Esri::GameEngine::Authentication
Class: Esri/GameEngine/Authentication/ArcGISOAuthUserConfiguration
Since: 1.1.0
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 |
|---|---|---|---|
portal | Yes | The URL of the portal to authenticate with. | |
client | Yes | A unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication. | |
redirect | Yes | The URL that the OAuth login page redirects to when authentication completes. | |
culture | Yes | The OAuth login page is displayed in the language specified by the given culture code. | |
refresh | Yes | The requested expiration interval (in minutes) for the refreshToken generated by the OAuth request. The max interval can be overridden by the portal administrator. | |
refresh | 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. | |
federated | Yes | The requested expiration interval (in minutes) for federated tokens generated using the OAuth credential. | |
show | Yes | A Boolean value indicating whether to show "Cancel" button on the OAuth login page. | |
user | Yes | Constants indicating the interface style for the OAuth login page. | |
prefer | 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 |
|---|---|---|---|---|
No | Yes | A unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication. | ||
No | Yes | The OAuth login page is displayed in the language specified by the given culture code. | ||
No | Yes | The requested expiration interval (in minutes) for federated tokens generated using the OAuth credential. | ||
No | Yes | The URL of the portal to authenticate with. | ||
No | Yes | A Boolean value indicating whether the OAuth login session should ask the browser for a private authentication session. | ||
No | Yes | The URL that the OAuth login page will redirect to when authentication completes. | ||
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. | ||
No | Yes | The requested expiration interval (in minutes) for the refreshToken generated by the OAuth request.
Set this to | ||
No | Yes | A Boolean value indicating whether to show the "Cancel" button on the OAuth login page. | ||
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.
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 refreshToken generated by the OAuth request.
Set this to -1 for getting the maximum refresh token supported by the portal (ninety days).
The max interval can be overridden by the portal administrator.
If this is not set, then the refresh token is valid for 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&) | Checks if this configuration can be used for the given URL. | |
Equals(const ArcGISOAuthUserConfiguration&) | Tests if the two ArcGISOAuthUserConfiguration objects are equal. |
CanBeUsedForURL
Checks if this configuration can be used for the given URL.
Since 1.1.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
URL | 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 | Yes | The configuration to compare to. |
Returns bool
True if the comparison succeeds and the objects are equal, false otherwise.