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.

Since

200.1.0

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

redirectUrl

the URL that the OAuth login page redirects to when authentication completes

culture

the OAuth login page is displayed in the language specified by the given locale, set by the device by default

refreshTokenExpirationInterval

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

  • RefreshTokenExpirationInterval.Maximum 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.

  • RefreshTokenExpirationInterval.Default 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 log-in because of expiring tokens.

federatedTokenExpirationInterval

the requested expiration interval (in minutes) for federated tokens generated using the OAuth credential. Setting this to null means that the default interval will be used

showCancelButton

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

userInterfaceStyle

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

preferPrivateWebBrowserSession

a Boolean value indicating whether the OAuth log-in session should ask the browser for a private authentication session

See also