ClaimsIdentity.RemoveClaim Method (Claim)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Attempts to remove a claim from the claims identity.

Namespace:   System.Security.Claims
Assembly:  mscorlib (in mscorlib.dll)

<SecurityCriticalAttribute>
Public Overridable Sub RemoveClaim (
	claim As Claim
)

Parameters

claim
Type: System.Security.Claims.Claim

The claim to remove.

Exception Condition
InvalidOperationException

The claim cannot be removed.

It is possible that the claim cannot be removed because it is not owned by the identity. For example, this would be the case for role claims that are owned by the principal. Unlike the TryRemoveClaim method, which returns a Boolean value that indicates whether the claim has been removed, RemoveClaim throws an exception if the claim could not be removed

The specified claim is matched by object reference (ReferenceEquals).

This method has the SecurityCritical attribute applied to control which entities can remove claims from the identity. Further down the pipe, authorization decisions are made based on the claims that are present in the Claims collection.

SecurityCriticalAttribute

requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Universal Windows Platform
Available since 10
.NET Framework
Available since 4.5
Return to top
Show: