ClaimsIdentity.RemoveClaim(Claim) Method

Reference

Definition

Namespace:: System.Security.Claims

Assemblies:: mscorlib.dll, System.Security.Claims.dll

Assembly:: System.Security.Claims.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: ClaimsIdentity.cs

Source:: ClaimsIdentity.cs

Source:: ClaimsIdentity.cs

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.

Attempts to remove a claim from the claims identity.

public:
 virtual void RemoveClaim(System::Security::Claims::Claim ^ claim);

[System.Security.SecurityCritical]
public virtual void RemoveClaim (System.Security.Claims.Claim claim);

public virtual void RemoveClaim (System.Security.Claims.Claim? claim);

public virtual void RemoveClaim (System.Security.Claims.Claim claim);

[<System.Security.SecurityCritical>]
abstract member RemoveClaim : System.Security.Claims.Claim -> unit
override this.RemoveClaim : System.Security.Claims.Claim -> unit

abstract member RemoveClaim : System.Security.Claims.Claim -> unit
override this.RemoveClaim : System.Security.Claims.Claim -> unit

Public Overridable Sub RemoveClaim (claim As Claim)

Parameters

claim: Claim

The claim to remove.

Attributes: SecurityCriticalAttribute

Exceptions

InvalidOperationException

The claim cannot be removed.

Remarks

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.

Applies to