Class OAuthUserConfiguration

The OAuth user configuration information used by an OAuthUserCredential.

OAuthUserConfiguration

public sealed class OAuthUserConfiguration : IOAuthConfiguration

The portal URL, client ID, and redirect URL are required to create an OAuth user credential. See register your application and add a redirect URI for getting the client ID and redirect URL.
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 a negative value 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 ShowCancelButton or UserInterfaceStyle.

Name	Description
OAuthUserConfiguration(Uri, string, Uri, CultureInfo?, TimeSpan, TimeSpan, TimeSpan, bool, UserInterfaceStyle, bool)	Initializes a new instance of the OAuthUserConfiguration class with the specified parameters.

Name	Description
ClientId	Gets a unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication.
Culture	Gets the OAuth login page is displayed in the language specified by the given culture code.
FederatedTokenExpirationInterval	Gets the requested expiration interval for federated tokens generated using the OAuth credential.
PortalUrl	Gets the URL of the portal to authenticate with.
PreferPrivateWebBrowserSession	Gets a value indicating whether the OAuth login session should ask the browser for a private authentication session.
RedirectUrl	Gets the URL that the OAuth login page will redirect to when authentication completes.
RefreshTokenExchangeInterval	Gets the interval at which the OAuth refresh token is exchanged (rotated) before expiration.
RefreshTokenExpirationInterval	Gets the requested expiration interval (in minutes) for the refreshToken generated by the OAuth request. Set this to MaxValue for getting the maximum refresh token supported by the portal (ninety days). The max interval can be overridden by the portal administrator.
ShowCancelButton	Gets a value indicating whether to show the "Cancel" button on the OAuth login page.
UserInterfaceStyle	Gets the constants indicating the interface style for the OAuth login page.

Name	Description
CanBeUsedForUrl(Uri)	Checks if this configuration can be used for the given URL.
FromJson(string)	Convert a JSON string to an object.
ToJson()	Convert an object to JSON string.