Class AuthenticationManager
The manager of requests for secure resources made by the application.
Namespace: Esri.ArcGISRuntime.Security
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class AuthenticationManagerRemarks
The authentication manager provides:
- ArcGIS and network challenge handlers for authentication challenges. For example, you can write code in an authentication challenge handler to prompt the user for credential information, create a credential, and use it to continue with the challenge.
- The credential stores are available for storing the ArcGIS and network credentials that are automatically checked when your application attempts to connect to secured resources.
Properties
| Name | Description |
|---|---|
| ChallengeHandler | Gets or sets the component that handles the authorization errors in order to get a valid credential object. |
| Credentials | Gets the credentials registered by the Authentication Manager. |
| Current | Gets the single AuthenticationManager instance. This is the only way to get an instance of AuthenticationManager. |
| IapConfigurations | Gets an editable list of IapConfiguration object, which contain necessary information for creating Identity-aware proxy credentials. |
| OAuthAuthorizeHandler | Gets or sets the component sets the component that handles authorization by a resource owner in an oauth workflow. |
| OAuthHandler | Gets or sets the component sets the component that handles authorization by a resource owner in an oauth workflow. |
| OAuthUserConfigurations | Gets an editable list of OAuthUserConfiguration object, which contain necessary information for creating OAuth user credentials. |
| Persistence | Gets or sets the credential persistence. |
| RemoteCertificateValidationCallback | Gets or sets the delegate that validates the server certificate during SSL/TLS handshake. |
Methods
| Name | Description |
|---|---|
| AddCredential(Credential) | Adds a new Credential that the AuthenticationManager will use for accessing the resources. |
| AddCredentials(IEnumerable<Credential>) | Adds a set of new Credentials that the AuthenticationManager will use for accessing resources. |
| FindCredential(Uri, AuthenticationType) | Returns the credential that supports the specified authentication type for the resource identified by the specified url. |
| GetCredentialAsync(CredentialRequestInfo, bool) | Returns a Credential object of the specified type (credentialRequestInfo.AuthenticationType) that can be used to access the secured resource identified by the input url (credentialRequestInfo.Url). If required, the challenge method will be called and should return the expected credential object. If case of Token AuthenticationType, the user is typically challenged for a username and password which are used to generate a token. This method is typically called internally when a request fails due to an "invalid credentials" error. |
| RemoveAllCredentials() | Removes all stored credentials so the challenge handler will be called the next time access to a secured resource is needed. |
| RemoveAndRevokeAllCredentialsAsync() | Removes all credentials from the cache and revokes tokens if appropriate. |
| RemoveAndRevokeCredentialAsync(Credential) | Removes the given credential from the cache and revokes its token if appropriate. |
| RemoveCredential(Credential) | Removes an existing credential so the challenge handler will be called the next time an access to the resources is needed. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.8 |
| .NET | 100.13 - 300.0 |
| .NET Windows | 100.13 - 300.0 |
| .NET Android | 200.0 - 300.0 |
| .NET iOS | 200.0 - 300.0 |
| .NET Framework | 100.0 - 200.8 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.8 |