Interface ISamlConfigurationResolver

Namespace

ComponentSpace.Saml2.Configuration.Resolver

Assembly

ComponentSpace.Saml2.dll

Resolves configuration.

public interface ISamlConfigurationResolver

Methods

GetLocalIdentityProviderConfigurationAsync(string)

Gets the LocalIdentityProviderConfiguration.

Task<LocalIdentityProviderConfiguration> GetLocalIdentityProviderConfigurationAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<LocalIdentityProviderConfiguration>

A task that represents the operation and returns the local identity provider configuration.

Exceptions

SamlException

Thrown when the local identity provider configuration cannot be found.

GetLocalServiceProviderConfigurationAsync(string)

Gets the LocalServiceProviderConfiguration.

Task<LocalServiceProviderConfiguration> GetLocalServiceProviderConfigurationAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<LocalServiceProviderConfiguration>

A task that represents the operation and returns the local service provider configuration.

Exceptions

SamlException

Thrown when the local service provider configuration cannot be found.

GetPartnerIdentityProviderConfigurationAsync(string, string)

Gets the PartnerIdentityProviderConfiguration given the partner name.

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

Parameters

configurationName string

The configuration name or null if none.

partnerName string

The partner name.

Returns

Task<PartnerIdentityProviderConfiguration>

A task that represents the operation and returns the partner identity provider configuration.

Exceptions

SamlException

Thrown when the partner identity provider configuration cannot be found.

GetPartnerIdentityProviderNamesAsync(string)

Gets the names of the partner identity providers.

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

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<IList<string>>

A task that represents the operation and returns the names of the partner identity providers.

Exceptions

SamlException

Thrown when the partner identity provider names cannot be retrieved.

GetPartnerServiceProviderConfigurationAsync(string, string)

Gets the PartnerServiceProviderConfiguration given the partner name.

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

Parameters

configurationName string

The configuration name or null if none.

partnerName string

The partner name.

Returns

Task<PartnerServiceProviderConfiguration>

A task that represents the operation and returns the partner service provider configuration.

Exceptions

SamlException

Thrown when the partner service provider configuration cannot be found.

GetPartnerServiceProviderNamesAsync(string)

Gets the names of the partner service providers.

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

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<IList<string>>

A task that represents the operation and returns the names of the partner service providers.

Exceptions

SamlException

Thrown when the partner service provider names cannot be retrieved.

IsLocalIdentityProviderAsync(string)

Indicates whether a local identity provider is configured.

Task<bool> IsLocalIdentityProviderAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<bool>

true if a local identity provider is configured; otherwise false.

IsLocalServiceProviderAsync(string)

Indicates whether a local service provider is configured.

Task<bool> IsLocalServiceProviderAsync(string configurationName = null)

Parameters

configurationName string

The configuration name or null if none.

Returns

Task<bool>

true if a local service provider is configured; otherwise false.