Interface IConfigurationToMetadata

Exports SAML configuration to SAML metadata.

Namespace: ComponentSpace.Saml2.Metadata.Export

Assembly: ComponentSpace.Saml2.dll

Syntax

public interface IConfigurationToMetadata

Methods

ExportAsync(SamlConfiguration, string, string)

Exports the SAML configuration.

Declaration

Task<EntityDescriptor> ExportAsync(SamlConfiguration samlConfiguration, string partnerName = null, string workingDirectory = null)

Parameters

Type	Name	Description
SamlConfiguration	samlConfiguration	The SAML configuration.
string	partnerName	The partner name or null if none.
string	workingDirectory	The working directory for any relative paths in the SAML configuration or null if none.

Returns

Type	Description
Task<EntityDescriptor>	The SAML metadata.

Exceptions

Type	Condition
SamlException	Thrown when the SAML configuration cannot be exported.

ExportAsync(string, string, string)

Exports the SAML configuration.

Declaration

Task<EntityDescriptor> ExportAsync(string configurationName = null, string partnerName = null, string workingDirectory = null)

Parameters

Type	Name	Description
string	configurationName	The configuration name or null if none.
string	partnerName	The partner name or null if none.
string	workingDirectory	The working directory for any relative paths in the SAML configuration or null if none.

Returns

Type	Description
Task<EntityDescriptor>	The SAML metadata.

Exceptions

Type	Condition
SamlException	Thrown when the SAML configuration cannot be exported.