Share via

IClaimsTransformation.TransformAsync(ClaimsPrincipal) Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Authentication
Assembly:
Microsoft.AspNetCore.Authentication.Abstractions.dll
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
IClaimsTransformation.cs

Provides a central transformation point to change the specified principal. Note: this will be run on each AuthenticateAsync call, so its safer to return a new ClaimsPrincipal if your transformation is not idempotent.

public:
 System::Threading::Tasks::Task<System::Security::Claims::ClaimsPrincipal ^> ^ TransformAsync(System::Security::Claims::ClaimsPrincipal ^ principal);
public System.Threading.Tasks.Task<System.Security.Claims.ClaimsPrincipal> TransformAsync (System.Security.Claims.ClaimsPrincipal principal);
abstract member TransformAsync : System.Security.Claims.ClaimsPrincipal -> System.Threading.Tasks.Task<System.Security.Claims.ClaimsPrincipal>
Public Function TransformAsync (principal As ClaimsPrincipal) As Task(Of ClaimsPrincipal)

Parameters

principal
ClaimsPrincipal

The ClaimsPrincipal to transform.

Returns

Task<ClaimsPrincipal>

The transformed principal.

Applies to