Interface ISignOutTokenProvider

Namespace

Arc4u.OAuth2.Token

Assembly

Arc4u.OAuth2.dll

An ITokenProvider that holds tokens for a user session and removes them when the user signs out. Providers without a user session (machine to machine, a secret given by the settings, the token of the incoming request...) only implement ITokenProvider.

public interface ISignOutTokenProvider : ITokenProvider

Inherited Members

ITokenProvider.GetTokenAsync(IKeyValueSettings, object)

Methods

SignOutAsync(IKeyValueSettings, CancellationToken)

Signs the user out and removes the tokens this provider holds for the user. It is called for every user sign-out (see SignOutTokenProvidersAsync<T>(IServiceProvider, IKeyValueSettings, ILogger<T>, CancellationToken)), with the same settings for every provider: the settings can be empty or belong to another provider. In that case, remove what can be identified without them, or do nothing, but do not throw.

ValueTask SignOutAsync(IKeyValueSettings settings, CancellationToken cancellationToken)

Parameters

settings IKeyValueSettings

The settings given to the sign-out, which may not be the settings of this provider.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

ValueTask

A task that completes when the sign-out is done.