OAuthUserConfiguration Class

<intent-filter android:autoVerify="true">
  <action android:name="android.intent.action.VIEW"/>
  <category android:name="android.intent.category.DEFAULT"/>
  <category android:name="android.intent.category.BROWSABLE"/>
  <data android:scheme="qt-maps-sdk-app"/>
</intent-filter>

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>qt-maps-sdk-app</string>
    </array>
  </dict>
</array>

Member Function Documentation

OAuthUserConfiguration::OAuthUserConfiguration(const QUrl &portalUrl, const QString &clientId, const QString &redirectUri, QObject *parent = nullptr)

Creates an OAuth configuration with the specified parameters.

• portalUrl - The URL of the portal to authenticate with.
• clientId - A unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication.
• redirectUri - The URI that the OAuth login page redirects to when authentication completes.
• parent - The optional parent QObject.

• culture - the current system locale/culture.
• refreshTokenExpirationInterval OAuthRefreshTokenExpirationInterval::Default().
• refreshTokenExchangeInterval 1440 minutes.
• federatedTokenExpirationInterval 0 minutes.
• showCancelButton true.
• userInterfaceStyle UserInterfaceStyle::Unspecified.

OAuthUserConfiguration::OAuthUserConfiguration(const QUrl &portalUrl, const QString &clientId, const QString &redirectUri, const QString &culture, const Esri::ArcGISRuntime::Authentication::OAuthRefreshTokenExpirationInterval &refreshTokenExpirationInterval, std::optional<int> refreshTokenExchangeInterval, int federatedTokenExpirationInterval, bool showCancelButton, Esri::ArcGISRuntime::Authentication::UserInterfaceStyle userInterfaceStyle, QObject *parent = nullptr)

Creates an OAuth configuration with the specified parameters.

• portalUrl - The URL of the portal to authenticate with.
• clientId - A unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication.
• redirectUri - The URI that the OAuth login page redirects to when authentication completes.
• culture - The OAuth login page is displayed in the language specified by the given culture code.
• refreshTokenExpirationInterval - 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 14 days. This default value may be affected if the portal administrator sets the maximum refresh token value (ninety days) to less than 14 days.
• refreshTokenExchangeInterval - 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 - The requested expiration interval (in minutes) for federated tokens generated using the OAuth credential.
• showCancelButton - A Boolean value indicating whether to show "Cancel" button on the OAuth login page.
• userInterfaceStyle - Constants indicating the interface style for the OAuth login page.
• parent - The optional parent QObject.

[override virtual noexcept] OAuthUserConfiguration::~OAuthUserConfiguration()

Destructor.

bool OAuthUserConfiguration::canBeUsedForUrl(const QUrl &url) const

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

• url - The URL to check.

QString OAuthUserConfiguration::clientId() const

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

QString OAuthUserConfiguration::culture() const

Returns 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".

int OAuthUserConfiguration::federatedTokenExpirationInterval() const

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

[static] Esri::ArcGISRuntime::Authentication::OAuthUserConfiguration *OAuthUserConfiguration::fromJson(const QString &json, QObject *parent)

Convert a JSON string to an object.

• json - The JSON string.
• parent - The optional parent QObject.

bool OAuthUserConfiguration::isShowCancelButton() const

Returns a boolean value indicating whether to show the "Cancel" button on the OAuth login page.

QUrl OAuthUserConfiguration::portalUrl() const

Returns the URL of the portal to authenticate with.

QString OAuthUserConfiguration::redirectUri() const

Returns the URI that the OAuth login page will redirect to when authentication completes.

std::optional<int> OAuthUserConfiguration::refreshTokenExchangeInterval() const

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

The default value is 1440 minutes (24 hours).

Refresh token exchange is supported for ArcGIS Online and ArcGIS Enterprise portal 10.6 and later.

If the exchange interval is set to std::nullopt, 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 refreshTokenExpirationInterval.

Setting it to a value greater than the refreshTokenExpirationInterval has the same effect as setting it to std::nullopt.

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

See also refreshTokenExpirationInterval.

Esri::ArcGISRuntime::Authentication::OAuthRefreshTokenExpirationInterval OAuthUserConfiguration::refreshTokenExpirationInterval() const

Returns 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 14 days. This default value may be affected if the portal administrator sets the maximum refresh token value (ninety days) to less than 14 days.

See also refreshTokenExchangeInterval and RefreshTokenExpirationInterval.

[override virtual] QString OAuthUserConfiguration::toJson() const

Reimplements: JsonSerializable::toJson() const.

Returns convert an object to JSON string.

Esri::ArcGISRuntime::Authentication::UserInterfaceStyle OAuthUserConfiguration::userInterfaceStyle() const

Returns constants indicating the interface style for the OAuth login page.

The default is UserInterfaceStyle::Unspecified.

bool OAuthUserConfiguration::operator!=(Esri::ArcGISRuntime::Authentication::OAuthUserConfiguration *other) const

Tests and returns true if the two OAuthUserConfiguration objects are not equal.

• other - The configuration to compare to.

bool OAuthUserConfiguration::operator==(Esri::ArcGISRuntime::Authentication::OAuthUserConfiguration *other) const

Tests and returns true if the two OAuthUserConfiguration objects are equal.

• other - The configuration to compare to.