arcgis-maps-kotlin/com.arcgismaps.httpcore.authentication/OAuthUserConfiguration

OAuthUserConfiguration

class OAuthUserConfiguration : JsonSerializable

The OAuth user configuration information used by an OAuthUserCredential. The portal URL, client ID, and redirect URL are required to create an OAuthUserCredential. You can get the client ID and redirect URL by following the Create OAuth credentials for user authentication tutorial.

To configure the lifetime of an OAuthUserCredential, set the desired refresh token expiration and exchange intervals.

Default behavior: The refresh token expires after 14 days and is exchanged every 24 hours, allowing users to remain logged in unless the app is unused for the entire two-week period.
Require re-authentication: Set the exchange interval to 0 to ensure users must log in again once the refresh token expires.

Creating an OAuthUserCredential displays an OAuth login page to the user. To customize the appearance of the login page, adjust parameters such as OAuthUserConfiguration.showCancelButton or OAuthUserConfiguration.userInterfaceStyle.

Since

200.1.0

Constructors

OAuthUserConfiguration

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

Creates an OAuth configuration with the specified parameters.

Types

Companion

object Companion

UserInterfaceStyle

sealed class UserInterfaceStyle

Constants indicating the interface style.

Properties

clientId

val clientId: String

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

culture

val culture: Locale

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.

federatedTokenExpirationInterval

val federatedTokenExpirationInterval: Int?

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

portalUrl

val portalUrl: String

The URL of the portal to authenticate with.

preferPrivateWebBrowserSession

val preferPrivateWebBrowserSession: Boolean

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

redirectUrl

val redirectUrl: String

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

refreshTokenExchangeInterval

val refreshTokenExchangeInterval: 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 log-in because of expiring tokens.

refreshTokenExpirationInterval

val refreshTokenExpirationInterval: RefreshTokenExpirationInterval

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

showCancelButton

val showCancelButton: Boolean

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

userInterfaceStyle

val userInterfaceStyle: OAuthUserConfiguration.UserInterfaceStyle

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