Language

HttpConnectionDispatcherOptions.OnAuthenticationRefresh Property

Definition

An optional callback invoked when the /refresh endpoint has successfully re-authenticated the request but before the connection's user is replaced. Return true to accept the new principal, or false to reject the refresh. When rejected, the endpoint responds with HTTP 403 and the connection's current user remains in place.

public Func<Microsoft.AspNetCore.Connections.Features.AuthenticationRefreshContext,System.Threading.Tasks.Task<bool>>? OnAuthenticationRefresh { get; set; }
member this.OnAuthenticationRefresh : Func<Microsoft.AspNetCore.Connections.Features.AuthenticationRefreshContext, System.Threading.Tasks.Task<bool>> with get, set
Public Property OnAuthenticationRefresh As Func(Of AuthenticationRefreshContext, Task(Of Boolean))

Property Value

Remarks

This callback is an additional policy applied on top of the connection's default identity association check (or an application-provided OnAuthenticationRefresh override): both must accept the refresh for it to be applied. It cannot be used to bypass that underlying identity check.

Applies to