Class OAuthTokenCredential
A credential used to access ArcGIS resources secured with OAuth.
Implements
System.ComponentModel.INotifyPropertyChanged
System.Runtime.Serialization.ISerializable
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
[Serializable]
[Obsolete("Use OAuthUserCredential or OAuthApplicationCredential instead.")]
public sealed class OAuthTokenCredential : TokenCredential, INotifyPropertyChanged, ISerializable
Remarks
OAuthTokenCredential is deprecated in favor of ArcGISCredential. Depending on TokenAuthenticationType, you should use:
- OAuthUserCredential for user authentication (OAuth 2.0 authorization code flow).
- OAuthApplicationCredential for app authentication (OAuth 2.0 client credentials flow).
- PregeneratedTokenCredential when your app handles token generation manually or externally.
You will generally get an instance of this class by calling GetCredentialAsync(CredentialRequestInfo, Boolean). To accommodate specific uses cases, this object can also be created manually.
Constructors
| Name | Description |
|---|---|
| OAuthTokenCredential(Uri, String, GenerateTokenOptions) | Initializes a new instance of the OAuthTokenCredential class. |
Properties
| Name | Description |
|---|---|
| OAuthRefreshToken | Gets or sets the OAuth refresh token useful for getting a new access token once the old one expired. |
| RefreshTokenExchangeInterval | Gets or sets the exchange interval for the OAuth refresh token. The default is 24 hours. |
| RefreshTokenExpirationDate | Gets the date that the OAuthRefreshToken expires on, if known and applicable. |
Methods
| Name | Description |
|---|---|
| ToJson() | Convert this Credential to a JSON string. |
See Also
Esri.ArcGISRuntime.Security.ServerInfo.OAuthServerInfo
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.8 |
| .NET | 100.13 - 200.8 |
| .NET Windows | 100.13 - 200.8 |
| .NET Android | 200.0 - 200.8 |
| .NET iOS | 200.0 - 200.8 |
| .NET Framework | 100.0 - 200.8 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.8 |