Class SPSSODescriptor

Represents an SP SSO descriptor.

Inheritance
System.Object
RoleDescriptorType
SSODescriptorType
SPSSODescriptor
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: ComponentSpace.SAML2.Metadata
Assembly: ComponentSpace.Saml2.dll
Syntax
public class SPSSODescriptor : SSODescriptorType
Remarks

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

Constructors

SPSSODescriptor()

Initializes a new instance of the SPSSODescriptor class.

Declaration
public SPSSODescriptor()

SPSSODescriptor(XmlElement)

Initializes a new instance of the SPSSODescriptor class from XML.

Declaration
public SPSSODescriptor(XmlElement xmlElement)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement

The SP SSO descriptor XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML deserialization fails.

Properties

AssertionConsumerServices

Gets or sets the list of assertion consumer services.

Declaration
public IList<IndexedEndpointType> AssertionConsumerServices { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<IndexedEndpointType>

The list of assertion consumer services.

AttributeConsumingServices

Gets or sets the list of attribute consuming services.

Declaration
public IList<AttributeConsumingService> AttributeConsumingServices { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<AttributeConsumingService>

The list of attribute consuming services.

AuthnRequestsSigned

Gets or sets the flag indicating authentication requests are signed.

Declaration
public bool AuthnRequestsSigned { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating authentication requests are signed.

WantAssertionsSigned

Gets or sets the flag indicating whether want assertions signed.

Declaration
public bool WantAssertionsSigned { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether want assertions signed.

Methods

IsValid(XmlElement)

Indicates whether the XML is an SP SSO descriptor.

Declaration
public static bool IsValid(XmlElement xmlElement)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement

The XML to test.
Returns
Type Description
System.Boolean

true if the XML is an SP SSO descriptor; otherwise false.

ToXml()

Serializes the SP SSO descriptor to XML.

Declaration
public XmlElement ToXml()
Returns
Type Description
System.Xml.XmlElement

The SP SSO descriptor as XML.
Remarks

An XML document is created.

Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the SP SSO descriptor to XML.

Declaration
public XmlElement ToXml(XmlDocument xmlDocument)
Parameters
Type Name Description
System.Xml.XmlDocument xmlDocument

The owning XML document.
Returns
Type Description
System.Xml.XmlElement

The SP SSO descriptor as XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.