ClaimsAuthorizationManager.CheckAccess Method

  • Article

[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 implemented in a derived class, returns a value that indicates whether the subject specified in the authorization context is authorized to perform the specified action on the specified resource.

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

Usage

'Usage
Dim instance As ClaimsAuthorizationManager
Dim context As AuthorizationContext
Dim returnValue As Boolean

returnValue = instance.CheckAccess(context)

Syntax

'Declaration
Public Overridable Function CheckAccess ( _
    context As AuthorizationContext _
) As Boolean

public virtual bool CheckAccess (
    AuthorizationContext context
)

public:
virtual bool CheckAccess (
    AuthorizationContext^ context
)

public boolean CheckAccess (
    AuthorizationContext context
)

public function CheckAccess (
    context : AuthorizationContext
) : boolean

Parameters

  • context
    A AuthorizationContext that encapsulates the subject, resource, and action for which to determine authorization.

Return Value

true if the subject is authorized; otherwise, false.

Remarks

The base implementation always returns true, authorizing access. You can override this method in a derived class to authorize access based on the requirements of your RP application. If this method returns false, Windows® Identity Foundation (WIF) returns an unauthorized error to the caller; otherwise, execution is passed to the RP application.

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

ClaimsAuthorizationManager Class
ClaimsAuthorizationManager Members
Microsoft.IdentityModel.Claims Namespace

Other Resources

ClaimsAuthenticationManager, ClaimsAuthorizationManager, and OriginalIssuer
Building Relying Party Applications
WCF Application Compatibility
Configuration

Copyright © 2008 by Microsoft Corporation. All rights reserved.