Edit

ClaimTypeRequirement Class

  • 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
Package:
System.ServiceModel.Primitives v8.0.0
Source:
ClaimTypeRequirement.cs
Source:
ClaimTypeRequirement.cs
Source:
ClaimTypeRequirement.cs

Specifies the types of required and optional claims expected to appear in the federated credential.

public ref class ClaimTypeRequirement
public class ClaimTypeRequirement
type ClaimTypeRequirement = class
Public Class ClaimTypeRequirement
Inheritance
Object
ClaimTypeRequirement

Examples

The following code adds two claim type requirements to a security binding.

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));

The following config file is used with the preceding code.

<bindings>
  <wsFederationHttpBinding>
    <binding name="myFederatedBinding">
      <security mode="Message">
        <message issuedTokenType="urn:oasis:names:tc:SAML:1.0:assertion">
          <claimTypeRequirements>
            <add claimType="http://schemas.microsoft.com/ws/2005/05/identity/claims/EmailAddress"
              isOptional="false" />
            <add claimType="http://schemas.microsoft.com/ws/2005/05/identity/claims/UserName"
              isOptional="true" />
          </claimTypeRequirements>
        </message>
      </security>
    </binding>
  </wsFederationHttpBinding>
</bindings>

Remarks

In a federated scenario, services state the requirements on incoming credentials. For example, the incoming credentials must possess a certain set of claim types. This requirement is manifested in a security policy. When a client requests a security token from a security token service (for example, CardSpace), it puts the requirements into a token request so that the security token service can issue the security token that satisfies the requirements accordingly.

Constructors

ClaimTypeRequirement(String)

Initializes a new instance of the ClaimTypeRequirement class for a required claim of the specified type.
ClaimTypeRequirement(String, Boolean)

Initializes a new instance of the ClaimTypeRequirement class for a claim of the specified type.

Properties

ClaimType

Gets the claim type that was specified in the constructor.
IsOptional

Gets a value that indicates whether the claim is optional.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to