Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

RequestClaim Class

.NET Framework 4.6 and 4.5

Represents a single requested claim in a security token request (RST).

System.Object
  System.IdentityModel.Protocols.WSTrust.RequestClaim

Namespace:  System.IdentityModel.Protocols.WSTrust
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

'Declaration
Public Class RequestClaim

The RequestClaim type exposes the following members.

  NameDescription
Public methodRequestClaim(String)Initializes a new instance of the RequestClaim class with the specified claim type.
Public methodRequestClaim(String, Boolean)Initializes a new instance of the RequestClaim class with the specified claim type and a value that indicates whether the claim is optional.
Public methodRequestClaim(String, Boolean, String)Initializes a new instance of the RequestClaim class with the specified claim type, claim value, and a value that indicates whether the claim is optional.
Top

  NameDescription
Public propertyClaimTypeGets the type of the requested claim.
Public propertyIsOptionalGets or sets a value that indicates whether the request claim is optional in the response.
Public propertyValueGets or sets the requested claim value.
Top

  NameDescription
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 the default hash function. (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.)
Top

Represents a single claim inside a wst:Claims element in a wst:RequestSecurityToken message. The entire contents of the wst:Claims element is represented by a RequestClaimCollection which is a collection of RequestClaim objects. The contents of the wst:Claims element is accessed through the RequestSecurityToken.Claims property.

A RequestClaim object represents a request for a claim, identified by its claim type (the ClaimType property), to be present in the security token issued by the STS. The IsOptional property indicates whether the claim is required in the in the issued token.

For more information about the element that this class represents, see the version of the WS-Trust specification that applies to your scenario.

.NET Framework

Supported in: 4.6, 4.5

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