OAuthUserConfiguration

The OAuth user configuration information used by an OAuthUserCredential.

  • The portal URL, client ID, and redirect URL are required to create an OAuth user credential. See register your application[https://developers.arcgis.com/documentation/mapping-apis-and-services/security/tutorials/register-your-application/] and add a redirect URI[https://developers.arcgis.com/documentation/mapping-apis-and-services/security/tutorials/add-redirect-uri/] for getting the client ID and redirect URL.

  • Use refresh token expiration and exchange intervals to configure the lifetime of an OAuth user credential.

  • Use show cancel button, user interface style, etc. to configure the look and feel of the OAuth login page displayed by an OAuth user credential.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(portalUrl: String, clientId: String, redirectUrl: String, culture: Locale = Locale.getDefault(), refreshTokenExpirationInterval: RefreshTokenExpirationInterval = RefreshTokenExpirationInterval.Default, refreshTokenExchangeInterval: RefreshTokenExchangeInterval = RefreshTokenExchangeInterval.Never, federatedTokenExpirationInterval: Int? = null, showCancelButton: Boolean = true, userInterfaceStyle: OAuthUserConfiguration.UserInterfaceStyle = UserInterfaceStyle.Unspecified, preferPrivateWebBrowserSession: Boolean = false)

Creates an OAuth configuration with the specified parameters.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
sealed class UserInterfaceStyle

Constants indicating the interface style.

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The URL of the portal to authenticate with.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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 RefreshTokenExchangeInterval.Never, then the refresh token will never be exchanged and will eventually expire, causing the user to have to log in again. Use RefreshTokenExchangeInterval.Minutes to set a specific exchange interval. To have any affect, this should be set to a value less than the OAuthUserConfiguration.refreshTokenExpirationInterval. Setting it to a value greater than the OAuthUserConfiguration.refreshTokenExpirationInterval will have the same effect as setting this to RefreshTokenExchangeInterval.Never.

Link copied to clipboard

The requested expiration interval (in minutes) for the refreshToken generated by the OAuth request. Set this to RefreshTokenExpirationInterval.Maximum for getting the maximum refresh token supported by the portal (ninety days). The max interval can be overridden by the portal administrator. To set a specific time in minutes use RefreshTokenExpirationInterval.Minutes If this is not set, RefreshTokenExpirationInterval.Default will be used and then the refresh token will be valid for two weeks.

Link copied to clipboard

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

Link copied to clipboard

Constants indicating the interface style for the OAuth login page. The default is OAuthUserConfiguration.UserInterfaceStyle.Unspecified.

Functions

Link copied to clipboard

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

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int

Inherited functions

Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.