Class LogoutRequest

Represents a logout request.

Inheritance

object

RequestAbstractType

LogoutRequest

Inherited Members

RequestAbstractType.GetIssuer(XmlElement)

RequestAbstractType.GetIssuerName(XmlElement)

RequestAbstractType.ID

RequestAbstractType.Version

RequestAbstractType.IssueInstant

RequestAbstractType.Destination

RequestAbstractType.Consent

RequestAbstractType.Issuer

RequestAbstractType.Signature

RequestAbstractType.Extensions

RequestAbstractType.ToXml(XmlElement)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: ComponentSpace.SAML2.Protocols

Assembly: ComponentSpace.Saml2.dll

Syntax

public class LogoutRequest : RequestAbstractType

Remarks

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

Constructors

LogoutRequest()

Initializes a new instance of the LogoutRequest class.

Declaration

public LogoutRequest()

LogoutRequest(XmlElement)

Initializes a new instance of the LogoutRequest class from XML.

Declaration

public LogoutRequest(XmlElement xmlElement)

Parameters

Type	Name	Description
XmlElement	xmlElement	The logout request XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML deserialization fails.

Properties

BaseID

Gets or sets the base ID.

Declaration

public BaseID BaseID { get; set; }

Property Value

Type	Description
BaseID	The base ID.

EncryptedID

Gets or sets the encrypted ID.

Declaration

public EncryptedID EncryptedID { get; set; }

Property Value

Type	Description
EncryptedID	The encrypted ID.

NameID

Gets or sets the name ID.

Declaration

public NameID NameID { get; set; }

Property Value

Type	Description
NameID	The name ID.

NotOnOrAfter

Gets or sets the not on or after time.

Declaration

public DateTime NotOnOrAfter { get; set; }

Property Value

Type	Description
DateTime	The not on or after time as coordinated universal time (UTC). A value of DateTime.MaxValue indicates the value has not been set.

Reason

Gets or sets the reason.

Declaration

public string Reason { get; set; }

Property Value

Type	Description
string	The reason.

SessionIndexes

Gets or sets the session indexes.

Declaration

public IList<SessionIndex> SessionIndexes { get; set; }

Property Value

Type	Description
IList<SessionIndex>	The session indexes.

Methods

IsValid(XmlElement)

Indicates whether the XML is a logout request.

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 logout request; otherwise false.

ToString()

Converts the logout request to a string.

Declaration

public override string ToString()

Returns

Type	Description
string	The logout request as a string.

Overrides

object.ToString()

ToXml()

Serializes the logout request to XML.

Declaration

public XmlElement ToXml()

Returns

Type	Description
XmlElement	The logout request as XML.

Remarks

An XML document is created.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the logout request to XML.

Declaration

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

Type	Name	Description
XmlDocument	xmlDocument	The owning XML document.

Returns

Type	Description
XmlElement	The logout request as XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.