ClaimsIdentity.TryRemoveClaim(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 bool TryRemoveClaim(System::Security::Claims::Claim ^ claim);

[System.Security.SecurityCritical]
public virtual bool TryRemoveClaim (System.Security.Claims.Claim claim);

public virtual bool TryRemoveClaim (System.Security.Claims.Claim? claim);

public virtual bool TryRemoveClaim (System.Security.Claims.Claim claim);

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

abstract member TryRemoveClaim : System.Security.Claims.Claim -> bool
override this.TryRemoveClaim : System.Security.Claims.Claim -> bool

Public Overridable Function TryRemoveClaim (claim As Claim) As Boolean

Parameters

claim: Claim

The claim to remove.

Returns

Boolean

true if the claim was successfully removed; otherwise, false.

Attributes: SecurityCriticalAttribute

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.

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