This documentation is archived and is not being maintained.

SamlAttribute Class

Represents an attribute that is associated with the subject of a SamlAttributeStatement.


Namespace:  System.IdentityModel.Tokens
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

public class SamlAttribute

The SamlAttribute type exposes the following members.

Public methodSamlAttribute()Initializes a new instance of the SamlAttribute class.
Public methodSamlAttribute(Claim)Initializes a new instance of the SamlAttribute class using the specified claim.
Public methodSamlAttribute(String, String, IEnumerable<String>)Initializes a new instance of the SamlAttribute class using the specified attribute name, XML namespace, and attribute values.

Public propertyAttributeValuesGets a collection of attribute values for the SAML attribute.
Public propertyIsReadOnlyGets a value that indicates whether the properties of this instance are read-only.
Public propertyNameGets or sets the name of the SAML attribute.
Public propertyNamespaceGets or sets the XML namespace in which the name of the SAML attribute is defined.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExtractClaimsGets a collection of claims that this SAML attribute represents.
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.)
Public methodMakeReadOnlyCauses this instance to be read-only.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadXmlReads the SAML attribute from the specified XML reader.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteXmlWrites the SAML attribute into the specified XML serializer.

The SamlAttribute class corresponds to the <saml:Attribute> XML element that is defined in the OASIS SAML 1.1 specification.

A SamlAttribute instance contains PossessProperty claims for the subject of a SamlAttributeStatement. For example, a SamlAttribute might contain an Over21 claim, whose type would be specified in the Namespace property and whose resource would be specified as a member of the collection in the AttributeValues property. When the CreatePolicy method is called, this Over21 claim is added to the authorization policy that is returned by returned from by the SamlAttributeStatement. When the AttributeValues property contains multiple elements then one claim is returned for each element.

SamlAttribute position in the SAML object hierarchy is:





protected override Collection<SamlAttribute> GetIssuedClaims(RequestSecurityToken RST)
    EndpointAddress rstAppliesTo = RST.AppliesTo;

    if (rstAppliesTo == null)
        throw new InvalidOperationException("No AppliesTo EndpointAddress in RequestSecurityToken");

    string bookName = rstAppliesTo.Headers.FindHeader(Constants.BookNameHeaderName, Constants.BookNameHeaderNamespace).GetValue<string>();
    if (string.IsNullOrEmpty(bookName))
        throw new FaultException("The book name was not specified in the RequestSecurityToken");


    Collection<SamlAttribute> samlAttributes = new Collection<SamlAttribute>();

    foreach (ClaimSet claimSet in ServiceSecurityContext.Current.AuthorizationContext.ClaimSets)
        // Copy Name claims from the incoming credentials into the set of claims to be issued.
        IEnumerable<Claim> nameClaims = claimSet.FindClaims(ClaimTypes.Name, Rights.PossessProperty);
        if (nameClaims != null)
            foreach (Claim nameClaim in nameClaims)
                samlAttributes.Add(new SamlAttribute(nameClaim));
    // Add a purchase authorized claim.
    samlAttributes.Add(new SamlAttribute(new Claim(Constants.PurchaseAuthorizedClaim, bookName, Rights.PossessProperty)));
    return samlAttributes;

.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.