Class LogoutRequest

Represents a logout request.

Inheritance
System.Object
RequestAbstractType
LogoutRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
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
System.Xml.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
System.Nullable<System.DateTime>

The not on or after time as coordinated universal time (UTC).

Reason

Gets or sets the reason.

Declaration
public string Reason { get; set; }
Property Value
Type Description
System.String

The reason.

SessionIndexes

Gets or sets the session indexes.

Declaration
public IList<SessionIndex> SessionIndexes { get; set; }
Property Value
Type Description
System.Collections.Generic.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
System.Xml.XmlElement xmlElement

The XML to test.
Returns
Type Description
System.Boolean

true if the XML is a logout request; otherwise false.

IsWithinTimePeriod()

Indicates whether the current UTC time is within the not on or after period, if specified.

Declaration
public bool IsWithinTimePeriod()
Returns
Type Description
System.Boolean

true if within the time period; otherwise false.
Remarks

To be within the time period, UTC now <= not on or after

IsWithinTimePeriod(TimeSpan)

Indicates whether the current UTC time is within the not on or after period, if specified. The supplied time span is to allow for clock skew.

Declaration
public bool IsWithinTimePeriod(TimeSpan clockSkew)
Parameters
Type Name Description
System.TimeSpan clockSkew

The time span to allow for clock skew.
Returns
Type Description
System.Boolean

true if within the time period; otherwise false.
Remarks

To be within the time period, UTC now <= not on or after + clock skew

ToXml(XmlDocument)

Serializes the logout request to XML.

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

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

The logout request as XML.
Overrides
Exceptions
Type Condition
SamlSerializationException

Thrown when the XML serialization fails.