Class EntityDescriptor

Represents an entity descriptor.

Inheritance

System.Object

EntityDescriptor

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: ComponentSpace.SAML2.Metadata

Assembly: ComponentSpace.Saml2.dll

Syntax

public class EntityDescriptor

Remarks

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

Constructors

EntityDescriptor()

Initializes a new instance of the EntityDescriptor class.

Declaration

public EntityDescriptor()

EntityDescriptor(XmlElement)

Initializes a new instance of the EntityDescriptor class from XML.

Declaration

public EntityDescriptor(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The entity descriptor XML.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML deserialization fails.

Properties

AdditionalMetadataLocations

Gets or sets the list of additional metadata locations.

Declaration

public IList<AdditionalMetadataLocation> AdditionalMetadataLocations { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<AdditionalMetadataLocation>	The list of additional metadata locations.

AffiliationDescriptor

Gets or sets the affiliation descriptor.

Declaration

public AffiliationDescriptor AffiliationDescriptor { get; set; }

Property Value

Type	Description
AffiliationDescriptor	The affiliation descriptor.

AttributeAuthorityDescriptors

Gets or sets the list of attribute authority descriptors.

Declaration

public IList<AttributeAuthorityDescriptor> AttributeAuthorityDescriptors { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<AttributeAuthorityDescriptor>	The list of attribute authority descriptors.

AuthnAuthorityDescriptors

Gets or sets the list of authentication authority descriptors.

Declaration

public IList<AuthnAuthorityDescriptor> AuthnAuthorityDescriptors { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<AuthnAuthorityDescriptor>	The list of authentication authority descriptors.

CacheDuration

Gets or sets the cache duration.

Declaration

public Duration CacheDuration { get; set; }

Property Value

Type	Description
Duration	The cache duration.

ContactPeople

Gets or sets the list of contact people.

Declaration

public IList<ContactPerson> ContactPeople { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<ContactPerson>	The list of contact people.

EntityID

Gets or sets the entity ID.

Declaration

public EntityIDType EntityID { get; set; }

Property Value

Type	Description
EntityIDType	The entity ID.

Extensions

Gets or sets the extensions.

Declaration

public Extensions Extensions { get; set; }

Property Value

Type	Description
Extensions	The extensions.

ID

Gets or sets the ID.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	The ID.

IDPSSODescriptors

Gets or sets the list of IdP SSO descriptors.

Declaration

public IList<IDPSSODescriptor> IDPSSODescriptors { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<IDPSSODescriptor>	The list of IdP SSO descriptors.

Organization

Gets or sets the organization.

Declaration

public Organization Organization { get; set; }

Property Value

Type	Description
Organization	The organization.

PDPDescriptors

Gets or sets the list of PDP descriptors.

Declaration

public IList<PDPDescriptor> PDPDescriptors { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<PDPDescriptor>	The list of PDP descriptors.

RoleDescriptors

Gets or sets the list of role descriptors.

Declaration

public IList<RoleDescriptor> RoleDescriptors { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<RoleDescriptor>	The list of role descriptors.

Signature

Gets or sets the digital signature.

Declaration

public XmlElement Signature { get; set; }

Property Value

Type	Description
System.Xml.XmlElement	The digital signature.

Remarks

To generate or verify signatures, use SAMLMetadataSignature.

See Also

SAMLMetadataSignature

SPSSODescriptors

Gets or sets the list of SP SSO descriptors.

Declaration

public IList<SPSSODescriptor> SPSSODescriptors { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<SPSSODescriptor>	The list of SP SSO descriptors.

ValidUntil

Gets or sets the valid until date/time.

Declaration

public DateTime ValidUntil { get; set; }

Property Value

Type	Description
System.DateTime	The valid until date/time.

Methods

IsValid(XmlElement)

Indicates whether the XML is an entity descriptor.

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

ToXml()

Serializes the entities descriptor to XML.

Declaration

public XmlElement ToXml()

Returns

Type	Description
System.Xml.XmlElement	The entities descriptor as XML.

Remarks

An XML document is created.

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.

ToXml(XmlDocument)

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

Exceptions

Type	Condition
SAMLSerializationException	Thrown when the XML serialization fails.