Class AuthnQuery

Represents an authentication query.

Inheritance
System.Object
RequestAbstractType
SubjectQueryAbstractType
AuthnQuery
Inherited Members
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 AuthnQuery : SubjectQueryAbstractType
Remarks

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

Constructors

AuthnQuery()

Initializes a new instance of the AuthnQuery class.

Declaration
public AuthnQuery()

AuthnQuery(XmlElement)

Initializes a new instance of the AuthnQuery class from XML.

Declaration
public AuthnQuery(XmlElement xmlElement)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement

The authentication query XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML deserialization fails.

Properties

RequestedAuthnContext

Gets or sets the requested authentication context.

Declaration
public RequestedAuthnContext RequestedAuthnContext { get; set; }
Property Value
Type Description
RequestedAuthnContext

The session index.

SessionIndex

Gets or sets the session index.

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

The session index.

Methods

IsValid(XmlElement)

Indicates whether the XML is an authentication query.

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 an authentication query; otherwise false.

ToString()

Converts the authentication query to a string.

Declaration
public override string ToString()
Returns
Type Description
System.String

The authentication query as a string.
Overrides
System.Object.ToString()

ToXml()

Serializes the authentication query to XML.

Declaration
public XmlElement ToXml()
Returns
Type Description
System.Xml.XmlElement

The authentication query as XML.
Remarks

An XML document is created.

Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the authentication query to XML.

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

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

The authentication query as XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.