SamlAudienceRestrictionCondition Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Specifies that a SAML assertion is addressed to a particular audience.

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

System.Object
  System.IdentityModel.Tokens.SamlCondition
    System.IdentityModel.Tokens.SamlAudienceRestrictionCondition

public class SamlAudienceRestrictionCondition : SamlCondition

NameDescription
System_CAPS_pubmethodSamlAudienceRestrictionCondition()

Initializes a new instance of the SamlAudienceRestrictionCondition class.

System_CAPS_pubmethodSamlAudienceRestrictionCondition(IEnumerable<Uri>)

Initializes a new instance of the SamlAudienceRestrictionCondition class with the specified set of audiences a SAML assertion is intended for.

NameDescription
System_CAPS_pubpropertyAudiences

Gets the set of audiences a SAML assertion is intended for.

System_CAPS_pubpropertyIsReadOnly

Gets a value that indicates whether the properties of this instance are read-only.(Overrides SamlCondition.IsReadOnly.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodMakeReadOnly()

Causes this instance to be read-only.(Overrides SamlCondition.MakeReadOnly().)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodReadXml(XmlDictionaryReader, SamlSerializer, SecurityTokenSerializer, SecurityTokenResolver)

Reads the <AudienceRestrictionCondition> element from the specified XML reader.(Overrides SamlCondition.ReadXml(XmlDictionaryReader, SamlSerializer, SecurityTokenSerializer, SecurityTokenResolver).)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWriteXml(XmlDictionaryWriter, SamlSerializer, SecurityTokenSerializer)

Writes the <AudienceRestrictionCondition> element into the specified XML serializer.(Overrides SamlCondition.WriteXml(XmlDictionaryWriter, SamlSerializer, SecurityTokenSerializer).)

The SamlAudienceRestrictionCondition class corresponds to the <saml:AudienceRestrictionCondition> XML element, which is defined in the OASIS SAML 1.1 specification. The SamlAudienceRestrictionCondition is one of several SamlConditions that can be used to scope a SAML assertion

Use the SamlAudienceRestrictionCondition class to specify a SamlAssertion is intended for a specific audience and that the issuing SAML authority does not warrant the SAML assertion for other audiences that receive the security token. The claims for SamlSecurityToken security tokens are expressed as part of a SamlAssertion, which can optionally have a set of conditions affect the validity of the assertion. One of those conditions is a SamlAudienceRestrictionCondition, which specifies that the assertion is addressed to one or more specific audiences. The issuing SAML authority cannot prevent an unintended recipient from taking action on the basis of the information provided in the SAML assertion. However, the SamlAudienceRestrictionCondition class allows the SAML authority to state explicitly that no warranty is provided to such a party in a machine- and human-readable form.

To specify the set of intended audiences, use the SamlAudienceRestrictionCondition(IEnumerable<Uri>) constructor that accepts a set of audiences. To get the set of intended audiences, access the Audiences property.

.NET Framework
Available since 3.0

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

Return to top
Show: