ClaimsPrincipalPermission.CheckAccess Method

Article
10/05/2012

[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.]

Checks if the current principal 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 resource As String
Dim action As String

ClaimsPrincipalPermission.CheckAccess(resource, action)

Syntax

'Declaration
Public Shared Sub CheckAccess ( _
    resource As String, _
    action As String _
)

public static void CheckAccess (
    string resource,
    string action
)

public:
static void CheckAccess (
    String^ resource, 
    String^ action
)

public static void CheckAccess (
    String resource, 
    String action
)

public static function CheckAccess (
    resource : String, 
    action : String
)

Parameters

resource
The resource requested by the principal.

action
The action requested by the principal.

Exceptions

Exception type	Condition
InvalidOperationException	The current principal does not implement IClaimsPrincipal.
SecurityException	The authorization check failed.

Remarks

The principal must be authorized for the specified action on the specified resource or the SecurityException exception is thrown.

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)