ClaimTypeRequirement.IsOptional Property

Reference

Definition

Namespace:: System.ServiceModel.Security.Tokens

Assembly:: System.ServiceModel.Primitives.dll

Assembly:: System.ServiceModel.dll

Package:: System.ServiceModel.Primitives v6.0.0

Package:: System.ServiceModel.Primitives v6.2.0

Source:: ClaimTypeRequirement.cs

Source:: ClaimTypeRequirement.cs

Source:: ClaimTypeRequirement.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.

Gets a value that indicates whether the claim is optional.

public:
 property bool IsOptional { bool get(); };

public bool IsOptional { get; }

member this.IsOptional : bool

Public ReadOnly Property IsOptional As Boolean

Property Value

Boolean

true if this instance of the class is for an optional claim; false if it specifies a required claim.

Examples

The following code shows how to get this property.

WSFederationHttpBinding binding = new WSFederationHttpBinding();
binding.Security.Message.ClaimTypeRequirements.Add
   (new ClaimTypeRequirement
   ("http://schemas.microsoft.com/ws/2005/05/identity/claims/EmailAddress"));
binding.Security.Message.ClaimTypeRequirements.Add
   (new ClaimTypeRequirement
   ("http://schemas.microsoft.com/ws/2005/05/identity/claims/UserName", true));
ClaimTypeRequirement cr = new ClaimTypeRequirement
   ("http://schemas.microsoft.com/ws/2005/05/identity/claims/UserName", true);
Console.WriteLine(cr.ClaimType);
Console.WriteLine(cr.IsOptional);

Remarks

An example of how to use this property is the scenario in which the service asks for some information but does not require it. For instance, you are required to enter your first name, last name, and address, but your phone number is optional.

Applies to