Class NameIDFormat

Namespace

ComponentSpace.Saml2.Metadata

Assembly

ComponentSpace.Saml2.dll

Represents a name ID format.

public class NameIDFormat

Inheritance

object

NameIDFormat

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

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

Constructors

NameIDFormat()

Initializes a new instance of the NameIDFormat class.

public NameIDFormat()

NameIDFormat(XmlElement)

Initializes a new instance of the NameIDFormat class from XML.

public NameIDFormat(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The name ID format XML.

Exceptions

SamlSerializationException

Thrown when the XML deserialization fails.

Properties

Format

Gets or sets the name ID format URI.

public string Format { get; set; }

Property Value

string

The name ID format URI.

Methods

IsValid(XmlElement)

Indicates whether the XML is a name ID format.

public static bool IsValid(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The XML to test.

Returns

bool

true if the XML is a name ID format; otherwise false.

ToXml(XmlDocument)

Serializes the name ID format to XML.

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

xmlDocument XmlDocument

The owning XML document.

Returns

XmlElement

The name ID format as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.