Class OAuthUserConfiguration

The OAuth user configuration information used by an .

Inheritance

System.Object

OAuthUserConfiguration

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Esri.ArcGISRuntime.Security

Assembly: Esri.ArcGISRuntime.dll

Syntax

public sealed class OAuthUserConfiguration

Remarks

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.

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.

Constructors

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

Properties

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 language to use for the OAuth login page.
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 requested exchange interval 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.
RefreshTokenExpirationInterval	Gets the requested expiration interval (in minutes) for the refreshToken generated by the OAuth request. Set this to System.TimeSpan.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 interface style for the OAuth login page.

Methods

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.

Applies to

Target	Versions
.NET Standard 2.0	200.5
.NET	200.5
.NET Windows	200.5
.NET Android	200.5
.NET iOS	200.5
.NET Framework	200.5
UWP	200.5