Class NameID
Represents a name identifier.
Inherited Members
Namespace: ComponentSpace.SAML2.Assertions
Assembly: ComponentSpace.Saml2.dll
Syntax
public class NameID : NameIDType
Remarks
Refer to the Assertions and Protocol for the OASIS Security Assertion Markup Language (SAML) V2.0 specification for further details.
Constructors
NameID()
Initializes a new instance of the NameID
class.
Declaration
public NameID()
NameID(String)
Initializes a new instance of the NameID
class.
Declaration
public NameID(string nameID)
Parameters
Type | Name | Description |
---|---|---|
System.String | nameID | The name ID. |
NameID(String, String, String, String, String)
Initializes a new instance of the NameID
class.
Declaration
public NameID(string nameID, string nameQualifier, string spNameQualifier, string format, string spProvidedID)
Parameters
Type | Name | Description |
---|---|---|
System.String | nameID | The name ID. |
System.String | nameQualifier | The name qualifier. |
System.String | spNameQualifier | The SP name qualifier. |
System.String | format | The format. |
System.String | spProvidedID | The SP provided ID. |
See Also
NameID(XmlElement)
Initializes a new instance of the NameID
class from XML.
Declaration
public NameID(XmlElement xmlElement)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlElement | xmlElement | The name identifier XML. |
Exceptions
Type | Condition |
---|---|
SAMLSerializationException | Thrown when the XML deserialization fails. |
Methods
IsValid(XmlElement)
Indicates whether the XML is a name identifier.
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 identifier 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 identifier as XML. |
Exceptions
Type | Condition |
---|---|
SAMLSerializationException | Thrown when the XML serialization fails. |