Compartilhar via

ClaimsAuthenticationManager.Authenticate Method

  • Artigo

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

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

Namespace: Microsoft.IdentityModel.Claims
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As ClaimsAuthenticationManager
Dim resourceName As String
Dim incomingPrincipal As IClaimsPrincipal
Dim returnValue As IClaimsPrincipal

returnValue = instance.Authenticate(resourceName, incomingPrincipal)

Syntax

'Declaration
Public Overridable Function Authenticate ( _
    resourceName As String, _
    incomingPrincipal As IClaimsPrincipal _
) As IClaimsPrincipal

public virtual IClaimsPrincipal Authenticate (
    string resourceName,
    IClaimsPrincipal incomingPrincipal
)

public:
virtual IClaimsPrincipal^ Authenticate (
    String^ resourceName, 
    IClaimsPrincipal^ incomingPrincipal
)

public IClaimsPrincipal Authenticate (
    String resourceName, 
    IClaimsPrincipal incomingPrincipal
)

public function Authenticate (
    resourceName : String, 
    incomingPrincipal : IClaimsPrincipal
) : IClaimsPrincipal

Parameters

  • resourceName
    The address to which the request was sent.
  • incomingPrincipal
    An IClaimsPrincipal that represents the credentials presented by the client (in the form of a security token) to access the specified resource.

Return Value

An IClaimsPrincipal that contains any modifications necessary for the RP application. The default implementation returns the incoming IClaimsPrincipal unmodified.

Remarks

You can override this method in a derived class to filter, modify, or inject claims into the claims principal. Depending on the requirements of the RP application, you can even return a custom implementation of IClaimsPrincipal.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

See Also

Reference

ClaimsAuthenticationManager Class
ClaimsAuthenticationManager Members
Microsoft.IdentityModel.Claims Namespace

Other Resources

ClaimsAuthenticationManager, ClaimsAuthorizationManager, and OriginalIssuer

Copyright © 2008 by Microsoft Corporation. All rights reserved.