Class SamlResponse

Represents a SAML response.

Inheritance

object

StatusResponseType

SamlResponse

Inherited Members

StatusResponseType.GetIssuer(XmlElement)

StatusResponseType.GetIssuerName(XmlElement)

StatusResponseType.ID

StatusResponseType.InResponseTo

StatusResponseType.Version

StatusResponseType.IssueInstant

StatusResponseType.Destination

StatusResponseType.Consent

StatusResponseType.Issuer

StatusResponseType.Extensions

StatusResponseType.Status

StatusResponseType.IsSuccess()

StatusResponseType.ToXml()

StatusResponseType.ToXml(XmlElement)

StatusResponseType.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: ComponentSpace.Saml2.Protocols

Assembly: ComponentSpace.Saml2.dll

Syntax

public class SamlResponse : StatusResponseType

Remarks

Refer to the Assertions and Protocol for the OASIS Security Assertion Markup Language (SAML) V2.0 specification for further details.

Constructors

SamlResponse()

Initializes a new instance of the SAMLResponse class.

Declaration

public SamlResponse()

SamlResponse(XmlElement)

Initializes a new instance of the SAMLResponse class from XML.

Declaration

public SamlResponse(XmlElement xmlElement)

Parameters

Type	Name	Description
XmlElement	xmlElement	The SAML response XML.

Exceptions

Type	Condition
SamlSerializationException	Thrown when the XML deserialization fails.

Properties

Assertions

Gets or sets the assertions.

This includes all unsigned, signed and encrypted assertions.

The list may contain unencrypted and unsigned SAML assertions as SAMLAssertion objects, signed SAML assertions as XmlElement objects, and encrypted SAML assertions as EncryptedAssertion objects.

To get just the unencrypted, unsigned assertions use GetUnsignedAssertions. To get just the signed assertions use GetSignedAssertions. To get just the encrypted assertions use GetEncryptedAssertions.

Declaration

public IList<AssertionListItem> Assertions { get; set; }

Property Value

Type	Description
IList<AssertionListItem>	The assertions.

See Also

SamlAssertion

EncryptedAssertion

GetUnsignedAssertion()

GetUnsignedAssertions()

GetSignedAssertion()

GetSignedAssertions()

GetEncryptedAssertion()

GetEncryptedAssertions()

Methods

GetEncryptedAssertion()

Returns the encrypted SAML assertion.

It's assumed the SAML response contains a single encrypted SAML assertion.

To get the unencrypted, unsigned assertion use GetUnsignedAssertion. To get the signed assertion use GetSignedAssertion.

Declaration

public EncryptedAssertion GetEncryptedAssertion()

Returns

Type	Description
EncryptedAssertion	The encrypted assertion or null if none.

See Also

Assertions

EncryptedAssertion

GetEncryptedAssertions()

Returns all encrypted assertions.

To get the unencrypted, unsigned assertions use GetUnsignedAssertions. To get the signed assertions use GetSignedAssertions.

Declaration

public IList<EncryptedAssertion> GetEncryptedAssertions()

Returns

Type	Description
IList<EncryptedAssertion>	The encrypted assertions.

See Also

Assertions

EncryptedAssertion

GetSignedAssertion()

Returns the SAML assertion.

It's assumed the SAML response contains a single signed SAML assertion.

To get the unencrypted, unsigned assertion use GetUnsignedAssertion. To get the encrypted assertion use GetEncryptedAssertion.

Declaration

public XmlElement GetSignedAssertion()

Returns

Type	Description
XmlElement	The SAML assertion or null if none.

Exceptions

Type	Condition
SamlSignatureException	Thrown when the signature verification fails.

See Also

Assertions

GetSignedAssertions()

Returns all signed assertions.

To get the unencrypted, unsigned assertions use GetUnsignedAssertions. To get the encrypted assertions use GetEncryptedAssertions.

Declaration

public IList<XmlElement> GetSignedAssertions()

Returns

Type	Description
IList<XmlElement>	The signed assertions.

See Also

Assertions

GetUnsignedAssertion()

Returns the SAML assertion.

It's assumed the SAML response contains a single unencrypted, unsigned SAML assertion.

To get the signed assertion use GetSignedAssertion. To get the encrypted assertion use GetEncryptedAssertion.

Declaration

public SamlAssertion GetUnsignedAssertion()

Returns

Type	Description
SamlAssertion	The SAML assertion or null if none.

See Also

Assertions

SamlAssertion

GetUnsignedAssertions()

Returns all unencrypted, unsigned assertions.

To get the signed assertions use GetSignedAssertions. To get the encrypted assertions use GetEncryptedAssertions.

Declaration

public IList<SamlAssertion> GetUnsignedAssertions()

Returns

Type	Description
IList<SamlAssertion>	The assertions.

See Also

Assertions

SamlAssertion

IsValid(XmlElement)

Indicates whether the XML is a SAML response.

Declaration

public static bool IsValid(XmlElement xmlElement)

Parameters

Type	Name	Description
XmlElement	xmlElement	The XML to test.

Returns

Type	Description
bool	true if the XML is a SAML response; otherwise false.

ToXml(XmlDocument)

Serializes the SAML response to XML.

Declaration

public override XmlElement ToXml(XmlDocument xmlDocument)

Parameters

Type	Name	Description
XmlDocument	xmlDocument	The owning XML document.

Returns

Type	Description
XmlElement	The SAML response as XML.

Overrides

StatusResponseType.ToXml(XmlDocument)

Exceptions

Type	Condition
SamlSerializationException	Thrown when the XML serialization fails.