Show / Hide Table of Contents

Class ConfigurationToMetadata

Exports SAML configuration to SAML metadata.

Inheritance
System.Object
ConfigurationToMetadata
Implements
IConfigurationToMetadata
Inherited Members
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)
System.Object.ToString()
Namespace: ComponentSpace.Saml2.Metadata.Export
Assembly: ComponentSpace.Saml2.dll
Syntax
public class ConfigurationToMetadata : IConfigurationToMetadata

Constructors

ConfigurationToMetadata(ISamlConfigurationResolver, ICertificateManager)

Initializes a new instance of the ConfigurationToMetadata class.

Declaration
public ConfigurationToMetadata(ISamlConfigurationResolver samlConfigurationResolver, ICertificateManager certificateManager)
Parameters
Type Name Description
ISamlConfigurationResolver samlConfigurationResolver

The SAML configuration resolver.

ICertificateManager certificateManager

The certificate manager.

Methods

ExportAsync(SamlConfiguration, String, String)

Exports the SAML configuration.

Declaration
public async Task<EntityDescriptor> ExportAsync(SamlConfiguration samlConfiguration, string partnerName = null, string workingDirectory = null)
Parameters
Type Name Description
SamlConfiguration samlConfiguration

The SAML configuration.

System.String partnerName

The partner name or null if none.

System.String workingDirectory

The working directory for any relative paths in the SAML configuration or null if none.

Returns
Type Description
System.Threading.Tasks.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
public async Task<EntityDescriptor> ExportAsync(string configurationName = null, string partnerName = null, string workingDirectory = null)
Parameters
Type Name Description
System.String configurationName

The configuration name or null if none.

System.String partnerName

The partner name or null if none.

System.String workingDirectory

The working directory for any relative paths in the SAML configuration or null if none.

Returns
Type Description
System.Threading.Tasks.Task<EntityDescriptor>

The SAML metadata.

Exceptions
Type Condition
SamlException

Thrown when the SAML configuration cannot be exported.

Implements

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