Class NameIDMappingRequest

Represents a name ID mapping request.

Inheritance

object

RequestAbstractType

NameIDMappingRequest

Inherited Members

RequestAbstractType.GetIssuer(XmlElement)

RequestAbstractType.GetIssuerName(XmlElement)

RequestAbstractType.ID

RequestAbstractType.Version

RequestAbstractType.IssueInstant

RequestAbstractType.Destination

RequestAbstractType.Consent

RequestAbstractType.Issuer

RequestAbstractType.Signature

RequestAbstractType.Extensions

RequestAbstractType.ToXml(XmlElement)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: ComponentSpace.SAML2.Protocols

Assembly: ComponentSpace.Saml2.dll

Syntax

public class NameIDMappingRequest : RequestAbstractType

Remarks

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

Constructors

NameIDMappingRequest()

Initializes a new instance of the NameIDMappingRequest class.

Declaration

public NameIDMappingRequest()

NameIDMappingRequest(XmlElement)

Initializes a new instance of the NameIDMappingRequest class from XML.

Declaration

public NameIDMappingRequest(XmlElement xmlElement)

Parameters

Type	Name	Description
XmlElement	xmlElement	The name ID mapping 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.

NameIDPolicy

Gets or sets the name ID policy.

Declaration

public NameIDPolicy NameIDPolicy { get; set; }

Property Value

Type	Description
NameIDPolicy	The name ID policy.

Methods

IsValid(XmlElement)

Indicates whether the XML is an artifact resolve request.

Declaration

public static bool IsValid(XmlElement xmlElement)

Parameters

Type	Name	Description
XmlElement	xmlElement	The XML to test.

Returns

Type	Description
bool	true if the XML is an artifact resolve request; otherwise false.

ToString()

Converts the name ID mapping request to a string.

Declaration

public override string ToString()

Returns

Type	Description
string	The name ID mapping request as a string.

Overrides

object.ToString()

ToXml()

Serializes the name ID mapping request to XML.

Declaration

public XmlElement ToXml()

Returns

Type	Description
XmlElement	The name ID mapping request as XML.

Remarks

An XML document is created.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the name ID mapping request to XML.

Declaration

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

Type	Name	Description
XmlDocument	xmlDocument	The owning XML document.

Returns

Type	Description
XmlElement	The name ID mapping request as XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.