Class RequestAbstractType

Namespace

ComponentSpace.Saml2.Protocols

Assembly

ComponentSpace.Saml2.dll

Represents the request abstract type.

public abstract class RequestAbstractType

Inheritance

object

RequestAbstractType

Derived

ArtifactResolve

AssertionIDRequest

AuthnRequest

LogoutRequest

ManageNameIDRequest

NameIDMappingRequest

SubjectQueryAbstractType

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

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

Constructors

RequestAbstractType()

Initializes a new instance of the RequestAbstractType class.

public RequestAbstractType()

Remarks

The request is initialized with a version number of 2.0, a random identifier, and the issue instant of now.

RequestAbstractType(XmlElement)

Initializes a new instance of the RequestAbstractType class from XML.

public RequestAbstractType(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The request XML.

Exceptions

SamlSerializationException

Thrown when the XML deserialization fails.

Properties

Consent

Gets or sets the consent.

public string Consent { get; set; }

Property Value

string

The consent.

See Also

SamlConstants.ConsentIdentifiers

Destination

Gets or sets the destination.

public string Destination { get; set; }

Property Value

string

The destination.

Extensions

Gets or sets the extensions.

public Extensions Extensions { get; set; }

Property Value

Extensions

The extensions.

ID

Gets or sets the ID.

public string ID { get; set; }

Property Value

string

The ID.

IssueInstant

Gets or sets the issue instant.

public DateTime? IssueInstant { get; set; }

Property Value

DateTime?

The issue instant as coordinated universal time (UTC).

Issuer

Gets or sets the issuer.

public Issuer Issuer { get; set; }

Property Value

Issuer

The issuer.

Version

Gets or sets the version.

public string Version { get; set; }

Property Value

string

The version. The default is 2.0.

Methods

GetIssuer(XmlElement)

Gets the issuer.

public static Issuer GetIssuer(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The XML element containing the issuer as a child element.

Returns

Issuer

The issuer or null if none.

GetIssuerName(XmlElement)

Gets the issuer name.

public static string GetIssuerName(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The XML element containing the issuer as a child element.

Returns

string

The issuer name or null if none.

ToString()

Converts the SAML request to a string.

public override string ToString()

Returns

string

The SAML request as a string.

ToXml()

Serializes the request to XML.

public virtual XmlElement ToXml()

Returns

XmlElement

The request as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the request to XML.

public abstract XmlElement ToXml(XmlDocument xmlDocument)

Parameters

xmlDocument XmlDocument

The owning XML document.

Returns

XmlElement

The request as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.

ToXml(XmlElement)

Serializes the request to XML.

public virtual void ToXml(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The owning XML element.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.