This documentation is archived and is not being maintained.

ClaimTypeRequirement Class

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


Namespace:  System.ServiceModel.Security.Tokens
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public class ClaimTypeRequirement

The ClaimTypeRequirement type exposes the following members.

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

Public propertyClaimTypeGets the claim type that was specified in the constructor.
Public propertyIsOptionalGets a value that indicates whether the claim is optional.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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, ), it puts the requirements into a token request so that the security token service can issue the security token that satisfies the requirements accordingly.

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

WSFederationHttpBinding binding = new WSFederationHttpBinding();
   (new ClaimTypeRequirement
   (new ClaimTypeRequirement
   ("", true));

The following config file is used with the preceding code.

    <binding name="myFederatedBinding">
      <security mode="Message">
        <message issuedTokenType="urn:oasis:names:tc:SAML:1.0:assertion">
            <add claimType=""
              isOptional="false" />
            <add claimType=""
              isOptional="true" />

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.