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

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

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

refreshTokenExpirationInterval

val refreshTokenExpirationInterval: RefreshTokenExpirationInterval

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.

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.