This documentation is archived and is not being maintained.

SamlAssertion Class

Represents a Security Assertion Markup Language 1.1 (SAML 1.1) assertion.


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

public class SamlAssertion

The SamlAssertion type exposes the following members.

Public methodSamlAssertion()Initializes a new instance of the SamlAssertion class.
Public methodSamlAssertion(String, String, DateTime, SamlConditions, SamlAdvice, IEnumerable<SamlStatement>)Initializes a new instance of the SamlAssertion class using the specified SAML assertion identifier, issuer of the assertion, the date and time when the assertion was issued, a set of processing conditions, additional information, and a collection of SAML statements.

Public propertyAdviceGets or sets additional information related to the SamlSecurityToken that is supplied by the SAML authority that can aide in the processing of the SAML assertion.
Public propertyAssertionIdGets or sets the identifier for this assertion.
Public propertyConditionsGets or sets a set of conditions that may be taken into account when assessing the validity of the SAML assertion.
Public propertyIsReadOnlyGets a value indicating whether the properties of this instance are read-only.
Public propertyIssueInstantGets or sets the date and time when the SAML assertion was issued.
Public propertyIssuerGets or sets the name of the SAML authority that issued this SAML assertion.
Public propertyMajorVersionGets the major version of the SAML specification to which this SAML assertion conforms.
Public propertyMinorVersionGets the minor version of the SAML specification to which this SAML assertion conforms.
Public propertySigningCredentialsGets or sets the security credentials that are used to digitally sign the SAML assertion.
Public propertySigningTokenGets the security token contained in or referenced by a digitally signed SAML assertion.
Public propertyStatementsGets the set of SAML statements associated with the SAML assertion.

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.)
Protected methodReadSignatureReads the digital signature for a SAML assertion from an XML reader.
Public methodReadXmlReads a SAML assertion from the specified XML reader.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteXmlWrites the SAML assertion into the specified XML writer as a <saml:Assertion> element.

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

The claims for SamlSecurityToken security tokens are contained within a SamlAssertion. A SamlAssertion has an extensible set of claims known as SAML statements that are represented by the Statements property. The SAML authority that issued the SAML assertion is specified in the Issuer property.

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