Class StatusResponseType

Represents the status response type.

Inheritance

System.Object

StatusResponseType

ArtifactResponse

LogoutResponse

ManageNameIDResponse

NameIDMappingResponse

SAMLResponse

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 class StatusResponseType

Remarks

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

Constructors

StatusResponseType()

Initializes a new instance of the StatusResponseType class.

Declaration

public StatusResponseType()

Remarks

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

StatusResponseType(XmlElement)

Initializes a new instance of the StatusResponseType class from XML.

Declaration

public StatusResponseType(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The response 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.

InResponseTo

Gets or sets the in response to.

Declaration

public string InResponseTo { get; set; }

Property Value

Type	Description
System.String	The in response to.

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

Status

Gets or sets the status.

Declaration

public Status Status { get; set; }

Property Value

Type	Description
Status	The status.

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.

IsSuccess()

Indicates whether the status indicates success or not.

Declaration

public bool IsSuccess()

Returns

Type	Description
System.Boolean	true if the status indicates success; otherwise false.

ToXml(XmlElement)

Serializes the status response to XML.

Declaration

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