Class SamlServiceCollectionExtensions

Extension methods for setting up SAML related services in an IServiceCollection.

Inheritance

object

SamlServiceCollectionExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Microsoft.Extensions.DependencyInjection

Assembly: ComponentSpace.Saml2.dll

Syntax

public static class SamlServiceCollectionExtensions

Methods

AddSaml(IServiceCollection)

Adds the services required to enable SAML support.

Declaration

public static IServiceCollection AddSaml(this IServiceCollection services)

Parameters

Type	Name	Description
IServiceCollection	services	The services collection.

Returns

Type	Description
IServiceCollection	The services collection.

AddSaml(IServiceCollection, IConfiguration)

Adds the services required to enable SAML support.

Declaration

public static IServiceCollection AddSaml(this IServiceCollection services, IConfiguration samlConfigurations)

Parameters

Type	Name	Description
IServiceCollection	services	The services collection.
IConfiguration	samlConfigurations	The SAML configurations.

Returns

Type	Description
IServiceCollection	The services collection.

AddSaml(IServiceCollection, Action<SamlConfigurations>)

Adds the services required to enable SAML support.

Declaration

public static IServiceCollection AddSaml(this IServiceCollection services, Action<SamlConfigurations> configureSaml)

Parameters

Type	Name	Description
IServiceCollection	services	The services collection.
Action<SamlConfigurations>	configureSaml	The action used to configure SAML.

Returns

Type	Description
IServiceCollection	The services collection.

AddSamlCachedConfigurationResolver<TSamlConfigurationResolver>(IServiceCollection, Action<string, object, MemoryCacheEntryOptions>)

Adds the cached configuration resolver.

Declaration

public static IServiceCollection AddSamlCachedConfigurationResolver<TSamlConfigurationResolver>(this IServiceCollection services, Action<string, object, MemoryCacheEntryOptions> memoryCacheEntryOptions = null) where TSamlConfigurationResolver : class, ISamlConfigurationResolver

Parameters

Type	Name	Description
IServiceCollection	services	The services collection.
Action<string, object, MemoryCacheEntryOptions>	memoryCacheEntryOptions	The optional delegate called when the memory cache entry options are being set.

Returns

Type	Description
IServiceCollection	The services collection.

Type Parameters

Name	Description
TSamlConfigurationResolver

AddSamlConfigurationResolver<TSamlConfigurationResolver>(IServiceCollection)

Adds the SAML configuration resolver.

Declaration

public static IServiceCollection AddSamlConfigurationResolver<TSamlConfigurationResolver>(this IServiceCollection services) where TSamlConfigurationResolver : class, ISamlConfigurationResolver

Parameters

Type	Name	Description
IServiceCollection	services	The services collection.

Returns

Type	Description
IServiceCollection	The services collection.

Type Parameters

Name	Description
TSamlConfigurationResolver

SetSamlLicenseKey(IServiceCollection, string)

Sets the license key.

Declaration

public static IServiceCollection SetSamlLicenseKey(this IServiceCollection services, string licenseKey)

Parameters

Type	Name	Description
IServiceCollection	services	The services collection.
string	licenseKey	The license key.

Returns

Type	Description
IServiceCollection	The services collection.

SetSamlLicenseKeyFileName(IServiceCollection, string)

Sets the license key file name.

Declaration

public static IServiceCollection SetSamlLicenseKeyFileName(this IServiceCollection services, string licenseKeyFileName)

Parameters

Type	Name	Description
IServiceCollection	services	The services collection.
string	licenseKeyFileName	The license key file name.

Returns

Type	Description
IServiceCollection	The services collection.