ClaimsAuthenticationManager.Authenticate(String, ClaimsPrincipal) Method

Reference

Definition

Namespace:: System.Security.Claims

Assembly:: System.IdentityModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

When overridden in a derived class, returns a ClaimsPrincipal object consistent with the requirements of the RP application. The default implementation does not modify the incoming ClaimsPrincipal.

public:
 virtual System::Security::Claims::ClaimsPrincipal ^ Authenticate(System::String ^ resourceName, System::Security::Claims::ClaimsPrincipal ^ incomingPrincipal);

public virtual System.Security.Claims.ClaimsPrincipal Authenticate(string resourceName, System.Security.Claims.ClaimsPrincipal incomingPrincipal);

abstract member Authenticate : string * System.Security.Claims.ClaimsPrincipal -> System.Security.Claims.ClaimsPrincipal
override this.Authenticate : string * System.Security.Claims.ClaimsPrincipal -> System.Security.Claims.ClaimsPrincipal

Public Overridable Function Authenticate (resourceName As String, incomingPrincipal As ClaimsPrincipal) As ClaimsPrincipal

Parameters

resourceName: String

The address of the resource that is being requested.

incomingPrincipal: ClaimsPrincipal

The claims principal that represents the authenticated user that is attempting to access the resource.

Returns

ClaimsPrincipal

A claims principal that contains any modifications necessary for the RP application. The default implementation returns the incoming claims principal unmodified.

Remarks

The Authenticate method is called from the request processing pipeline You can override this method in a derived class to filter, modify, or inject claims into the claims principal according to the policy of your RP application. Depending on the requirements of the RP application, you can even return a custom implementation of ClaimsPrincipal.

Applies to

Product	Versions
.NET Framework	4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via