Show / Hide Table of Contents

Class SamlAuthenticationExtensions

Extension methods for adding SAML authentication in an AuthenticationBuilder.

Inheritance
System.Object
SamlAuthenticationExtensions
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: Microsoft.Extensions.DependencyInjection
Assembly: ComponentSpace.Saml2.dll
Syntax
public static class SamlAuthenticationExtensions

Methods

AddSaml(AuthenticationBuilder)

Adds the SAML authentication handler.

Declaration
public static AuthenticationBuilder AddSaml(this AuthenticationBuilder builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder

The authentication builder.

Returns
Type Description
Microsoft.AspNetCore.Authentication.AuthenticationBuilder

The authentication builder.

AddSaml(AuthenticationBuilder, Action<SamlAuthenticationOptions>)

Adds the SAML authentication handler.

Declaration
public static AuthenticationBuilder AddSaml(this AuthenticationBuilder builder, Action<SamlAuthenticationOptions> configureOptions)
Parameters
Type Name Description
Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder

The authentication builder.

System.Action<SamlAuthenticationOptions> configureOptions

The SAML options.

Returns
Type Description
Microsoft.AspNetCore.Authentication.AuthenticationBuilder

The authentication builder.

AddSaml(AuthenticationBuilder, String, Action<SamlAuthenticationOptions>)

Adds the SAML authentication handler.

Declaration
public static AuthenticationBuilder AddSaml(this AuthenticationBuilder builder, string authenticationScheme, Action<SamlAuthenticationOptions> configureOptions)
Parameters
Type Name Description
Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder

The authentication builder.

System.String authenticationScheme

The authentication scheme.

System.Action<SamlAuthenticationOptions> configureOptions

The SAML options.

Returns
Type Description
Microsoft.AspNetCore.Authentication.AuthenticationBuilder

The authentication builder.

AddSaml(AuthenticationBuilder, String, String, Action<SamlAuthenticationOptions>)

Adds the SAML authentication handler.

Declaration
public static AuthenticationBuilder AddSaml(this AuthenticationBuilder builder, string authenticationScheme, string displayName, Action<SamlAuthenticationOptions> configureOptions)
Parameters
Type Name Description
Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder

The authentication builder.

System.String authenticationScheme

The authentication scheme.

System.String displayName

The display name.

System.Action<SamlAuthenticationOptions> configureOptions

The SAML options.

Returns
Type Description
Microsoft.AspNetCore.Authentication.AuthenticationBuilder

The authentication builder.

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