Class RequestAbstractType

Represents the request abstract type.

Inheritance

System.Object

RequestAbstractType

ArtifactResolve

AssertionIDRequest

AuthnRequest

LogoutRequest

ManageNameIDRequest

NameIDMappingRequest

SubjectQueryAbstractType

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

Assembly: ComponentSpace.Saml2.dll

Syntax

public abstract class RequestAbstractType

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.

Declaration

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.

Declaration

public RequestAbstractType(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The request XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML deserialization fails.

Properties

Consent

Gets or sets the consent.

Declaration

public string Consent { get; set; }

Property Value

Type	Description
System.String	The consent.

See Also

SAMLIdentifiers.ConsentIdentifiers

Destination

Gets or sets the destination.

Declaration

public string Destination { get; set; }

Property Value

Type	Description
System.String	The destination.

Extensions

Gets or sets the extensions.

Declaration

public Extensions Extensions { get; set; }

Property Value

Type	Description
Extensions	The extensions.

ID

Gets or sets the ID.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	The ID.

IssueInstant

Gets or sets the issue instant.

Declaration

public DateTime IssueInstant { get; set; }

Property Value

Type	Description
System.DateTime	The issue instant as coordinated universal time (UTC).

Issuer

Gets or sets the issuer.

Declaration

public Issuer Issuer { get; set; }

Property Value

Type	Description
Issuer	The issuer.

Signature

Gets or sets the digital signature.

Declaration

public XmlElement Signature { get; set; }

Property Value

Type	Description
System.Xml.XmlElement	The digital signature.

Remarks

To generate or verify signatures, use SAMLMessageSignature.

See Also

SAMLMessageSignature

Version

Gets or sets the version.

Declaration

public string Version { get; set; }

Property Value

Type	Description
System.String	The version. The default is 2.0.

Methods

GetIssuer(XmlElement)

Gets the issuer.

Declaration

public static Issuer GetIssuer(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The XML element containing the issuer as an offspring element.

Returns

Type	Description
Issuer	The issuer or null if none.

GetIssuerName(XmlElement)

Gets the issuer name.

Declaration

public static string GetIssuerName(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The XML element containing the issuer as an offspring element.

Returns

Type	Description
System.String	The issuer name or null if none.

ToXml(XmlElement)

Serializes the request to XML.

Declaration

public virtual void ToXml(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The owning XML element.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.