Class MetadataExporter

Exports the SAML configuration as SAML metadata.

Inheritance

object

MetadataExporter

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: ComponentSpace.SAML2.Configuration

Assembly: ComponentSpace.Saml2.dll

Syntax

public static class MetadataExporter

Methods

Export(SAMLConfiguration, string)

Exports the SAML configuration as SAML metadata.

Declaration

public static EntityDescriptor Export(SAMLConfiguration samlConfiguration, string partnerName = null)

Parameters

Type	Name	Description
SAMLConfiguration	samlConfiguration	The SAML configuration.
string	partnerName	The SAML configuration partner name or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

Exceptions

Type	Condition
SAMLException	Thrown when the SAML configuration cannot be exported as SAML metadata.

ExportIdentityProvider(LocalIdentityProviderConfiguration, IList<X509Certificate2>, IList<X509Certificate2>, string, string, PartnerServiceProviderConfiguration)

Exports the identity provider SAML configuration as SAML metadata.

Declaration

public static EntityDescriptor ExportIdentityProvider(LocalIdentityProviderConfiguration localIdentityProviderConfiguration, IList<X509Certificate2> signatureCertificates, IList<X509Certificate2> encryptionCertificates, string singleSignOnServiceURL, string singleLogoutServiceURL, PartnerServiceProviderConfiguration partnerServiceProviderConfiguration)

Parameters

Type	Name	Description
LocalIdentityProviderConfiguration	localIdentityProviderConfiguration	The local identity provider configuration.
IList<X509Certificate2>	signatureCertificates	The signature X.509 certificates or `null` if none.
IList<X509Certificate2>	encryptionCertificates	The encryption X.509 certificates or `null` if none.
string	singleSignOnServiceURL	The SSO service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
PartnerServiceProviderConfiguration	partnerServiceProviderConfiguration	The partner service provider configuration or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

Exceptions

Type	Condition
SAMLException	Thrown when the local identity provider configuration cannot be found.

ExportIdentityProvider(LocalIdentityProviderConfiguration, X509Certificate2, X509Certificate2, string, string, PartnerServiceProviderConfiguration)

Exports the identity provider SAML configuration as SAML metadata.

Declaration

public static EntityDescriptor ExportIdentityProvider(LocalIdentityProviderConfiguration localIdentityProviderConfiguration, X509Certificate2 signatureCertificate, X509Certificate2 encryptionCertificate, string singleSignOnServiceURL, string singleLogoutServiceURL, PartnerServiceProviderConfiguration partnerServiceProviderConfiguration)

Parameters

Type	Name	Description
LocalIdentityProviderConfiguration	localIdentityProviderConfiguration	The local identity provider configuration.
X509Certificate2	signatureCertificate	The signature X.509 certificate or `null` if none.
X509Certificate2	encryptionCertificate	The encryption X.509 certificate or `null` if none.
string	singleSignOnServiceURL	The SSO service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
PartnerServiceProviderConfiguration	partnerServiceProviderConfiguration	The partner service provider configuration or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

Exceptions

Type	Condition
SAMLException	Thrown when the local identity provider configuration cannot be found.

ExportIdentityProvider(SAMLConfiguration, IList<X509Certificate2>, IList<X509Certificate2>, string, string, string)

Exports the identity provider SAML configuration as SAML metadata.

Declaration

public static EntityDescriptor ExportIdentityProvider(SAMLConfiguration samlConfiguration, IList<X509Certificate2> signatureCertificates, IList<X509Certificate2> encryptionCertificates, string singleSignOnServiceURL, string singleLogoutServiceURL, string partnerName)

Parameters

Type	Name	Description
SAMLConfiguration	samlConfiguration	The SAML configuration.
IList<X509Certificate2>	signatureCertificates	The signature X.509 certificates or `null` if none.
IList<X509Certificate2>	encryptionCertificates	The encryption X.509 certificates or `null` if none.
string	singleSignOnServiceURL	The SSO service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
string	partnerName	The SAML configuration partner name or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

Exceptions

Type	Condition
SAMLException	Thrown when the local identity provider configuration cannot be found.

ExportIdentityProvider(SAMLConfiguration, X509Certificate2, X509Certificate2, string, string, string)

Exports the identity provider SAML configuration as SAML metadata.

Declaration

public static EntityDescriptor ExportIdentityProvider(SAMLConfiguration samlConfiguration, X509Certificate2 signatureCertificate, X509Certificate2 encryptionCertificate, string singleSignOnServiceURL, string singleLogoutServiceURL, string partnerName)

Parameters

Type	Name	Description
SAMLConfiguration	samlConfiguration	The SAML configuration.
X509Certificate2	signatureCertificate	The signature X.509 certificate or `null` if none.
X509Certificate2	encryptionCertificate	The encryption X.509 certificate or `null` if none.
string	singleSignOnServiceURL	The SSO service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
string	partnerName	The SAML configuration partner name or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

Exceptions

Type	Condition
SAMLException	Thrown when the local identity provider configuration cannot be found.

ExportIdentityProvider(string, IList<X509Certificate2>, IList<X509Certificate2>, string, string, string)

Exports the identity provider SAML configuration as SAML metadata.

Declaration

public static EntityDescriptor ExportIdentityProvider(string configurationName, IList<X509Certificate2> signatureCertificates, IList<X509Certificate2> encryptionCertificates, string singleSignOnServiceURL, string singleLogoutServiceURL, string partnerName)

Parameters

Type	Name	Description
string	configurationName	The configuration name or `null` if none.
IList<X509Certificate2>	signatureCertificates	The signature X.509 certificates or `null` if none.
IList<X509Certificate2>	encryptionCertificates	The encryption X.509 certificates or `null` if none.
string	singleSignOnServiceURL	The SSO service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
string	partnerName	The SAML configuration partner name or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

Exceptions

Type	Condition
SAMLException	Thrown when the local identity provider configuration cannot be found.

ExportIdentityProvider(string, X509Certificate2, X509Certificate2, string, string, string)

Exports the identity provider SAML configuration as SAML metadata.

Declaration

public static EntityDescriptor ExportIdentityProvider(string configurationName, X509Certificate2 signatureCertificate, X509Certificate2 encryptionCertificate, string singleSignOnServiceURL, string singleLogoutServiceURL, string partnerName)

Parameters

Type	Name	Description
string	configurationName	The configuration name or `null` if none.
X509Certificate2	signatureCertificate	The signature X.509 certificate or `null` if none.
X509Certificate2	encryptionCertificate	The encryption X.509 certificate or `null` if none.
string	singleSignOnServiceURL	The SSO service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
string	partnerName	The SAML configuration partner name or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

Exceptions

Type	Condition
SAMLException	Thrown when the local identity provider configuration cannot be found.

ExportServiceProvider(LocalServiceProviderConfiguration, IList<X509Certificate2>, IList<X509Certificate2>, string, string, PartnerIdentityProviderConfiguration)

Exports the service provider SAML configuration and X.509 certificate as SAML metadata.

Declaration

public static EntityDescriptor ExportServiceProvider(LocalServiceProviderConfiguration localServiceProviderConfiguration, IList<X509Certificate2> signatureCertificates, IList<X509Certificate2> encryptionCertificates, string assertionConsumerServiceURL, string singleLogoutServiceURL, PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration)

Parameters

Type	Name	Description
LocalServiceProviderConfiguration	localServiceProviderConfiguration	The local service provider configuration.
IList<X509Certificate2>	signatureCertificates	The signature X.509 certificates or `null` if none.
IList<X509Certificate2>	encryptionCertificates	The encryption X.509 certificates or `null` if none.
string	assertionConsumerServiceURL	The assertion consumer service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
PartnerIdentityProviderConfiguration	partnerIdentityProviderConfiguration	The partner identity provider configuration or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

ExportServiceProvider(LocalServiceProviderConfiguration, X509Certificate2, X509Certificate2, string, string, PartnerIdentityProviderConfiguration)

Exports the service provider SAML configuration and X.509 certificate as SAML metadata.

Declaration

public static EntityDescriptor ExportServiceProvider(LocalServiceProviderConfiguration localServiceProviderConfiguration, X509Certificate2 signatureCertificate, X509Certificate2 encryptionCertificate, string assertionConsumerServiceURL, string singleLogoutServiceURL, PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration)

Parameters

Type	Name	Description
LocalServiceProviderConfiguration	localServiceProviderConfiguration	The local service provider configuration.
X509Certificate2	signatureCertificate	The signature X.509 certificate or `null` if none.
X509Certificate2	encryptionCertificate	The encryption X.509 certificate or `null` if none.
string	assertionConsumerServiceURL	The assertion consumer service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
PartnerIdentityProviderConfiguration	partnerIdentityProviderConfiguration	The partner identity provider configuration or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

ExportServiceProvider(SAMLConfiguration, IList<X509Certificate2>, IList<X509Certificate2>, string, string, string)

Exports the service provider SAML configuration and X.509 certificate as SAML metadata.

Declaration

public static EntityDescriptor ExportServiceProvider(SAMLConfiguration samlConfiguration, IList<X509Certificate2> signatureCertificates, IList<X509Certificate2> encryptionCertificates, string assertionConsumerServiceURL, string singleLogoutServiceURL, string partnerName)

Parameters

Type	Name	Description
SAMLConfiguration	samlConfiguration	The SAML configuration.
IList<X509Certificate2>	signatureCertificates	The signature X.509 certificates or `null` if none.
IList<X509Certificate2>	encryptionCertificates	The encryption X.509 certificates or `null` if none.
string	assertionConsumerServiceURL	The assertion consumer service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
string	partnerName	The SAML configuration partner name or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

ExportServiceProvider(SAMLConfiguration, X509Certificate2, X509Certificate2, string, string, string)

Exports the service provider SAML configuration and X.509 certificate as SAML metadata.

Declaration

public static EntityDescriptor ExportServiceProvider(SAMLConfiguration samlConfiguration, X509Certificate2 signatureCertificate, X509Certificate2 encryptionCertificate, string assertionConsumerServiceURL, string singleLogoutServiceURL, string partnerName)

Parameters

Type	Name	Description
SAMLConfiguration	samlConfiguration	The SAML configuration.
X509Certificate2	signatureCertificate	The signature X.509 certificate or `null` if none.
X509Certificate2	encryptionCertificate	The encryption X.509 certificate or `null` if none.
string	assertionConsumerServiceURL	The assertion consumer service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
string	partnerName	The SAML configuration partner name or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

ExportServiceProvider(string, IList<X509Certificate2>, IList<X509Certificate2>, string, string, string)

Exports the service provider SAML configuration and X.509 certificate as SAML metadata.

Declaration

public static EntityDescriptor ExportServiceProvider(string configurationName, IList<X509Certificate2> signatureCertificates, IList<X509Certificate2> encryptionCertificates, string assertionConsumerServiceURL, string singleLogoutServiceURL, string partnerName)

Parameters

Type	Name	Description
string	configurationName	The configuration name or `null` if none.
IList<X509Certificate2>	signatureCertificates	The signature X.509 certificates or `null` if none.
IList<X509Certificate2>	encryptionCertificates	The encryption X.509 certificates or `null` if none.
string	assertionConsumerServiceURL	The assertion consumer service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
string	partnerName	The SAML configuration partner name or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.

ExportServiceProvider(string, X509Certificate2, X509Certificate2, string, string, string)

Exports the service provider SAML configuration and X.509 certificate as SAML metadata.

Declaration

public static EntityDescriptor ExportServiceProvider(string configurationName, X509Certificate2 signatureCertificate, X509Certificate2 encryptionCertificate, string assertionConsumerServiceURL, string singleLogoutServiceURL, string partnerName)

Parameters

Type	Name	Description
string	configurationName	The configuration name or `null` if none.
X509Certificate2	signatureCertificate	The signature X.509 certificate or `null` if none.
X509Certificate2	encryptionCertificate	The encryption X.509 certificate or `null` if none.
string	assertionConsumerServiceURL	The assertion consumer service URL or `null` if none.
string	singleLogoutServiceURL	The SLO service URL or `null` if none.
string	partnerName	The SAML configuration partner name or `null` if none.

Returns

Type	Description
EntityDescriptor	The SAML metadata entity descriptor.