Class NameIDFormat
Represents a name ID format.
Inheritance
System.Object
NameIDFormat
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)
System.Object.ToString()
Namespace: ComponentSpace.Saml2.Metadata
Assembly: ComponentSpace.Saml2.dll
Syntax
public class NameIDFormat
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.
Declaration
public NameIDFormat()
NameIDFormat(XmlElement)
Initializes a new instance of the NameIDFormat
class from XML.
Declaration
public NameIDFormat(XmlElement xmlElement)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlElement | xmlElement | The name ID format XML. |
Exceptions
Type | Condition |
---|---|
SamlSerializationException | Thrown when the XML deserialization fails. |
Properties
Format
Gets or sets the name ID format URI.
Declaration
public string Format { get; set; }
Property Value
Type | Description |
---|---|
System.String | The name ID format URI. |
Methods
IsValid(XmlElement)
Indicates whether the XML is a name ID format.
Declaration
public static bool IsValid(XmlElement xmlElement)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlElement | xmlElement | The XML to test. |
Returns
Type | Description |
---|---|
System.Boolean |
|
ToXml(XmlDocument)
Serializes the name ID format 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 name ID format as XML. |
Exceptions
Type | Condition |
---|---|
SamlSerializationException | Thrown when the XML serialization fails. |