Table of Contents

Class EntityDescriptor

Namespace
ComponentSpace.Saml2.Metadata
Assembly
ComponentSpace.Saml2.dll

Represents an entity descriptor.

public class EntityDescriptor
Inheritance
EntityDescriptor
Inherited Members

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.

public EntityDescriptor()

EntityDescriptor(XmlElement)

Initializes a new instance of the EntityDescriptor class from XML.

public EntityDescriptor(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The entity descriptor XML.

Exceptions

SamlSerializationException

Thrown when the XML deserialization fails.

Properties

AdditionalMetadataLocations

Gets or sets the list of additional metadata locations.

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

Property Value

IList<AdditionalMetadataLocation>

The list of additional metadata locations.

AffiliationDescriptor

Gets or sets the affiliation descriptor.

public AffiliationDescriptor AffiliationDescriptor { get; set; }

Property Value

AffiliationDescriptor

The affiliation descriptor.

AttributeAuthorityDescriptors

Gets or sets the list of attribute authority descriptors.

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

Property Value

IList<AttributeAuthorityDescriptor>

The list of attribute authority descriptors.

AuthnAuthorityDescriptors

Gets or sets the list of authentication authority descriptors.

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

Property Value

IList<AuthnAuthorityDescriptor>

The list of authentication authority descriptors.

CacheDuration

Gets or sets the cache duration.

public Duration CacheDuration { get; set; }

Property Value

Duration

The cache duration.

ContactPeople

Gets or sets the list of contact people.

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

Property Value

IList<ContactPerson>

The list of contact people.

EntityID

Gets or sets the entity ID.

public EntityIDType EntityID { get; set; }

Property Value

EntityIDType

The entity ID.

Extensions

Gets or sets the extensions.

public Extensions Extensions { get; set; }

Property Value

Extensions

The extensions.

ID

Gets or sets the ID.

public string ID { get; set; }

Property Value

string

The ID.

IdpSsoDescriptors

Gets or sets the list of IdP SSO descriptors.

public IList<IdpSsoDescriptor> IdpSsoDescriptors { get; set; }

Property Value

IList<IdpSsoDescriptor>

The list of IdP SSO descriptors.

Organization

Gets or sets the organization.

public Organization Organization { get; set; }

Property Value

Organization

The organization.

PdpDescriptors

Gets or sets the list of PDP descriptors.

public IList<PdpDescriptor> PdpDescriptors { get; set; }

Property Value

IList<PdpDescriptor>

The list of PDP descriptors.

RoleDescriptors

Gets or sets the list of role descriptors.

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

Property Value

IList<RoleDescriptor>

The list of role descriptors.

SpSsoDescriptors

Gets or sets the list of SP SSO descriptors.

public IList<SpSsoDescriptor> SpSsoDescriptors { get; set; }

Property Value

IList<SpSsoDescriptor>

The list of SP SSO descriptors.

ValidUntil

Gets or sets the valid until date/time.

public DateTime? ValidUntil { get; set; }

Property Value

DateTime?

The valid until date/time.

Methods

IsValid(XmlElement)

Indicates whether the XML is an entity descriptor.

public static bool IsValid(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The XML to test.

Returns

bool

true if the XML is an entity descriptor; otherwise false.

ToXml()

Serializes the entity descriptor to XML.

public XmlElement ToXml()

Returns

XmlElement

The entity descriptor as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the entity descriptor to XML.

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

xmlDocument XmlDocument

The owning XML document.

Returns

XmlElement

The entity descriptor as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.