Export (0) Print
Expand All

SamlAdvice Class

Represents the <saml:Advice> element within a SAML assertion that contains additional information provided by the SAML authority.


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

public class SamlAdvice

The SamlAdvice type exposes the following members.

Public methodSamlAdvice()Initializes a new instance of the SamlAdvice class.
Public methodSamlAdvice(IEnumerable<SamlAssertion>)Initializes a new instance of the SamlAdvice class using the specified collection of SAML assertions.
Public methodSamlAdvice(IEnumerable<String>)Initializes a new instance of the SamlAdvice class.
Public methodSamlAdvice(IEnumerable<String>, IEnumerable<SamlAssertion>)Initializes a new instance of the SamlAdvice class using the specified collections of SAML assertions and SAML assertion references.

Public propertyAssertionIdReferencesGets a collection of references to SAML assertions.
Public propertyAssertionsGets a collection of SAML assertions.
Public propertyIsReadOnlyGets a value indicating whether the properties of this instance are read-only.

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.)
Public methodMakeReadOnlyCauses this instance to be read-only.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadXmlReads the <saml:Advice> XML element using the specified XML reader.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteXmlWrites this SamlAdvice into the specified XML writer as an <saml:Advice> element.

The <saml:Advice> element within a SAML assertion is an extension point for SAML tokens. One example of how to use the SamlAdvice class is to provide supporting information about the SAML authority issuing the SAML assertion. This supporting information can be in the form of a SAML assertion or a reference to a SAML assertion, which are represented by the Assertions and AssertionIdReferences properties, respectively.

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

Community Additions

© 2015 Microsoft