Show / Hide Table of Contents

Class SamlAttribute

Represents an attribute.

Inheritance
System.Object
AttributeType
SamlAttribute
Inherited Members
AttributeType.Name
AttributeType.NameFormat
AttributeType.FriendlyName
AttributeType.AttributeValues
AttributeType.ToXml(XmlElement)
AttributeType.ToString()
AttributeType.ToString(String)
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)
Namespace: ComponentSpace.Saml2.Assertions
Assembly: ComponentSpace.Saml2.dll
Syntax
public class SamlAttribute : AttributeType
Remarks

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

Constructors

SamlAttribute()

Initializes a new instance of the SamlAttribute class.

Declaration
public SamlAttribute()

SamlAttribute(String, String)

Initializes a new instance of the SamlAttribute class.

Declaration
public SamlAttribute(string name, string value)
Parameters
Type Name Description
System.String name

The attribute name.

System.String value

The attribute value.

See Also
SamlConstants.AttributeNameFormats

SamlAttribute(String, String, String, String)

Initializes a new instance of the SamlAttribute class.

Declaration
public SamlAttribute(string name, string nameFormat, string friendlyName, string value)
Parameters
Type Name Description
System.String name

The attribute name.

System.String nameFormat

The name format or null if none.

System.String friendlyName

The friendly name or null if none.

System.String value

The attribute value.

See Also
SamlConstants.AttributeNameFormats

SamlAttribute(XmlElement)

Initializes a new instance of the SamlAttribute class from XML.

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

The attribute XML.

Exceptions
Type Condition
SamlSerializationException

Thrown when the XML deserialization fails.

Methods

IsValid(XmlElement)

Indicates whether the XML is an attribute.

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 attribute; otherwise false.

ToXml(XmlDocument)

Serializes the attribute 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 attribute as XML.

Exceptions
Type Condition
SamlSerializationException

Thrown when the XML serialization fails.

In This Article
Back to top Copyright © ComponentSpace Pty Ltd 2017-2022. All rights reserved.