OAuth
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 the client ID and redirect URL by following the Create OAuth credentials for user authentication tutorial.
To configure the lifetime of the OAuthUserCredential set the refresh token expiration and exchange intervals.
You can configure the look and feel of the OAuth login page, displayed by an OAUth user credential, by setting OAuthUserConfiguration.showCancelButton or OAuthUserConfiguration.userInterfaceStyle, for example.
Since
200.1.0
Constructors
Creates an OAuth configuration with the specified parameters.
Properties
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.
The requested expiration interval (in minutes) for federated tokens generated using the OAuth credential.
A Boolean value indicating whether the OAuth login session should ask the browser for a private authentication session.
The URL that the OAuth login page will redirect to when authentication completes.
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.
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.
A Boolean value indicating whether to show the "Cancel" button on the OAuth login page.
Constants indicating the interface style for the OAuth login page. The default is OAuthUserConfiguration.UserInterfaceStyle.Unspecified.