Interface IUrlRedirectionAuthenticator

An interface for manual login and logout operations using redirection flows.

Inherited Members

IAuthenticator.HasValidPreconditionsAsync()

IAuthenticator.InitializeAsync()

IAccessTokenProvider.GetAccessTokenAsync()

IAuthenticationStateProvider.AuthenticationState

IAuthenticationStateProvider.AuthenticationStateChanged

Namespace: Unity.Cloud.Identity

Syntax

public interface IUrlRedirectionAuthenticator : IAuthenticator, IAccessTokenProvider, IAuthenticationStateProvider

Methods

CancelLogin()

Cancels the awaiting login operation.

Declaration

void CancelLogin()

Exceptions

Type	Condition
InvalidOperationException

LoginAsync()

Performs a login operation.

Declaration

Task LoginAsync()

Returns

Type	Description
Task	A task.

Exceptions

Type	Condition
InvalidOperationException
AuthenticationFailedException

LogoutAsync(Boolean)

Performs a logout operation.

Declaration

Task LogoutAsync(bool clearBrowserCache = false)

Parameters

Type	Name	Description
Boolean	clearBrowserCache	An optional boolean value that, if set to true, triggers a navigation to the OS default browser to clear any cached session.

Returns

Type	Description
Task	A task.

Remarks

A logout operation clears the user session in the application only. Unless the user manually clears the session in the browser that is used for authentication, a user can get automatically logged in again from cached values, without entering any credentials. Use the clearBrowserCache boolean to also clear the session in the browser to prevent automatic login from a cached session.

Exceptions

Type	Condition
InvalidOperationException