Interface ISamlConfigurationResolver

Resolves configuration.

Namespace: ComponentSpace.Saml2.Configuration.Resolver

Assembly: ComponentSpace.Saml2.dll

Syntax

public interface ISamlConfigurationResolver

Methods

GetLocalIdentityProviderConfigurationAsync(String)

Gets the LocalIdentityProviderConfiguration.

Declaration

Task<LocalIdentityProviderConfiguration> GetLocalIdentityProviderConfigurationAsync(string configurationName = null)

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<LocalIdentityProviderConfiguration>	A task that represents the operation and returns the local identity provider configuration.

Exceptions

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

GetLocalServiceProviderConfigurationAsync(String)

Gets the LocalServiceProviderConfiguration.

Declaration

Task<LocalServiceProviderConfiguration> GetLocalServiceProviderConfigurationAsync(string configurationName = null)

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<LocalServiceProviderConfiguration>	A task that represents the operation and returns the local service provider configuration.

Exceptions

Type	Condition
SamlException	Thrown when the local service provider configuration cannot be found.

GetPartnerIdentityProviderConfigurationAsync(String, String)

Gets the PartnerIdentityProviderConfiguration given the partner name.

Declaration

Task<PartnerIdentityProviderConfiguration> GetPartnerIdentityProviderConfigurationAsync(string configurationName = null, string partnerName = null)

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.
System.String	partnerName	The partner name.

Returns

Type	Description
System.Threading.Tasks.Task<PartnerIdentityProviderConfiguration>	A task that represents the operation and returns the partner identity provider configuration.

Exceptions

Type	Condition
SamlException	Thrown when the partner identity provider configuration cannot be found.

GetPartnerIdentityProviderNamesAsync(String)

Gets the names of the partner identity providers.

Declaration

Task<IList<string>> GetPartnerIdentityProviderNamesAsync(string configurationName = null)

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.String>>	A task that represents the operation and returns the names of the partner identity providers.

Exceptions

Type	Condition
SamlException	Thrown when the partner identity provider names cannot be retrieved.

GetPartnerServiceProviderConfigurationAsync(String, String)

Gets the PartnerServiceProviderConfiguration given the partner name.

Declaration

Task<PartnerServiceProviderConfiguration> GetPartnerServiceProviderConfigurationAsync(string configurationName = null, string partnerName = null)

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.
System.String	partnerName	The partner name.

Returns

Type	Description
System.Threading.Tasks.Task<PartnerServiceProviderConfiguration>	A task that represents the operation and returns the partner service provider configuration.

Exceptions

Type	Condition
SamlException	Thrown when the partner service provider configuration cannot be found.

GetPartnerServiceProviderNamesAsync(String)

Gets the names of the partner service providers.

Declaration

Task<IList<string>> GetPartnerServiceProviderNamesAsync(string configurationName = null)

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.String>>	A task that represents the operation and returns the names of the partner service providers.

Exceptions

Type	Condition
SamlException	Thrown when the partner service provider names cannot be retrieved.

IsLocalIdentityProviderAsync(String)

Indicates whether a local identity provider is configured.

Declaration

Task<bool> IsLocalIdentityProviderAsync(string configurationName = null)

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	true if a local identity provider is configured; otherwise false.

IsLocalServiceProviderAsync(String)

Indicates whether a local service provider is configured.

Declaration

Task<bool> IsLocalServiceProviderAsync(string configurationName = null)

Parameters

Type	Name	Description
System.String	configurationName	The configuration name or null if none.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	true if a local service provider is configured; otherwise false.