CustomClaim Class

Article
10/10/2016

A custom claim on a trusting or trusted realm.

Namespace: System.Web.Security.SingleSignOn
Assembly: System.Web.Security.SingleSignOn (in System.Web.Security.SingleSignOn.dll)

Inheritance Hierarchy

System.Object
System.Web.Security.SingleSignOn.TrustPolicyEntryBase
System.Web.Security.SingleSignOn.CustomClaim

Syntax

[ComVisibleAttribute(true)]
public class CustomClaim : TrustPolicyEntryBase

[ComVisibleAttribute(true)]
public ref class CustomClaim : TrustPolicyEntryBase

[<ComVisibleAttribute(true)>]
type CustomClaim = 
    class
        inherit TrustPolicyEntryBase
    end

<ComVisibleAttribute(True)>
Public Class CustomClaim
    Inherits TrustPolicyEntryBase

Constructors

	Name	Description
	CustomClaim()	Initializes a new instance of the CustomClaim class. Do no use this default constructor; it is provided only for XML Serialization. Instead use CustomClaim(String).
	CustomClaim(String)	Initializes a new instance of the CustomClaim class.

Properties

	Name	Description
	CustomClaimName	Gets or sets the name for this CustomClaim.
	Disabled	Gets or sets whether the trust with this realm is currently active. If this is set, no tokens will be accepted from this partner.(Inherited from TrustPolicyEntryBase.)
	IsSensitive	Gets or sets a Boolean to indicate if there is sensitive information in this CustomClaim.
	uuid	Gets or sets the universal unique identifier (UUID) for this TrustPolicyEntryBase object.(Inherited from TrustPolicyEntryBase.)

Methods

	Name	Description
	Equals(Object)	Determines whether the specified CustomClaim is equal to the current CustomClaim.(Overrides Object.Equals(Object).)
	Finalize()	(Inherited from Object.)
	GetHashCode()	Gets the hash code for this instance.(Overrides Object.GetHashCode().)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	Returns a String that represents the current CustomClaim object.(Overrides Object.ToString().)

Remarks

A claim set defines the language that can be used within a corporation or between two agreeing corporations. When used between two corporations it is the incarnation of a business level agreement to exchange the defined authorization data.

The following are the supported claim producers and consumers for custom claims:

Active Directory Account Store. When the Active Directory store is configured, the Federation Service administrator can specify what LDAP user attributes contain claim values and then assign each attribute name to an Organization custom claim.
ADAM Account Store. When the ADAM account store is configured, the Federation Service administrator can specify the LDAP user attributes containing claim values. The administrator will assign each attribute name to an Organization Custom claim.
Account Partner. When the account partner is configured, the Federation Service administrator will specify a set of incoming names of custom claims that will be accepted from the partner and map each possible incoming name to an Organization custom claim (note that this creates a name transform). If an incoming custom claim is encountered that has no transform, it will be discarded.
Resource Partner. When the resource partner is configured, the Federation Service administrator can specify a set of outgoing custom claims that will be accepted by the resource partner and map each possible outgoing custom claim to an Organization custom claim (note that this creates a set of name transforms). Organization custom claims that match no Outgoing custom claim will be discarded.
Claims-Aware Application. When the application is configured, the Federation Service administrator will specify the Organization custom claims that will be sent to the application. Organization custom claims that are not designated to be sent to the application will be discarded.

Thread Safety

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