Class SamlMiddlewareOptions

The SAML v2.0 SSO middleware options.

Inheritance

System.Object

SamlMiddlewareOptions

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.Middleware

Assembly: ComponentSpace.Saml2.dll

Syntax

public class SamlMiddlewareOptions

Properties

ArtifactResolutionServicePath

Gets or sets the artifact resolution service URL path.

The default value is /SAML/ArtifactResolutionService.

Declaration

public string ArtifactResolutionServicePath { get; set; }

Property Value

Type	Description
System.String	The artifact resolution service URL path.

ConfigurationName

Gets or sets the optional delegate called to return the SAML configuration name.

Declaration

public Func<HttpContext, string> ConfigurationName { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String>	The delegate called to return the SAML configuration name.

ConfigurationNameParameter

Gets or sets the configuration name query string parameter name.

The default value is ConfigurationName.

Declaration

public string ConfigurationNameParameter { get; set; }

Property Value

Type	Description
System.String	The configuration name query string parameter name.

CorrelationIDParameter

Gets or sets the correlation ID query string parameter name.

The default value is CorrelationID.

Declaration

public string CorrelationIDParameter { get; set; }

Property Value

Type	Description
System.String	The correlation ID query string parameter name.

ErrorUrl

Gets or sets the optional delegate called to return the URL to redirect to after login or logout fails, if not otherwise specified.

Declaration

public Func<HttpContext, string> ErrorUrl { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String>	The delegate called to return the URL to redirect to if login or logout fails, if not otherwise specified.

Events

Gets or sets the optional events associated with SAML SSO and SLO.

Declaration

public SamlMiddlewareEvents Events { get; set; }

Property Value

Type	Description
SamlMiddlewareEvents	The optional events associated with SAML SSO and SLO.

InitiateSingleLogoutPath

Gets or sets the initiate single logout URL path.

The default value is /SAML/InitiateSingleLogout.

Declaration

public string InitiateSingleLogoutPath { get; set; }

Property Value

Type	Description
System.String	The initiate single logout URL path.

InitiateSingleSignOnPath

Gets or sets the initiate single sign-on URL path.

The default value is /SAML/InitiateSingleSignOn.

Declaration

public string InitiateSingleSignOnPath { get; set; }

Property Value

Type	Description
System.String	The initiate single sign-on URL path.

LoginUrl

Gets or sets the optional delegate called to return the login URL.

The default value is /Identity/Account/Login.

Declaration

public Func<HttpContext, string> LoginUrl { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String>	The delegate called to return the login URL.

LogoutCompletionUrl

Gets or sets the optional delegate called to return the URL to redirect to after completing single logout.

Declaration

public Func<HttpContext, string> LogoutCompletionUrl { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String>	The delegate called to return the URL to redirect to after completing single logout.

LogoutUrl

Gets or sets the optional delegate called to return the logout URL.

The default value is /Identity/Account/Logout.

Declaration

public Func<HttpContext, string> LogoutUrl { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String>	The delegate called to return the logout URL.

PartnerName

Gets or sets the optional delegate called to return the partner service provider name.

Declaration

public Func<HttpContext, string> PartnerName { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String>	The delegate called to return the partner service provider name.

PartnerNameParameter

Gets or sets the partner name query string parameter name.

The default value is PartnerName.

Declaration

public string PartnerNameParameter { get; set; }

Property Value

Type	Description
System.String	The partner name query string parameter name.

RelayState

Gets or sets the optional delegate called to return the relay state.

Declaration

public Func<HttpContext, string> RelayState { get; set; }

Property Value

Type	Description
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String>	The delegate called to return the relay state.

RelayStateParameter

Gets or sets the relay state query string parameter name.

The default value is RelayState.

Declaration

public string RelayStateParameter { get; set; }

Property Value

Type	Description
System.String	The relay state query string parameter name.

ReturnUrlParameter

Gets or sets the return URL query string parameter name.

The default value is ReturnUrl.

Declaration

public string ReturnUrlParameter { get; set; }

Property Value

Type	Description
System.String	The return URL query string parameter name.

SingleLogoutServiceCompletionPath

Gets or sets the single logout service completion URL path.

The default value is /SAML/SingleLogoutServiceCompletion.

Declaration

public string SingleLogoutServiceCompletionPath { get; set; }

Property Value

Type	Description
System.String	The single logout service completion URL path.

SingleLogoutServicePath

Gets or sets the single logout service URL path.

The default value is /SAML/SingleLogoutService.

Declaration

public string SingleLogoutServicePath { get; set; }

Property Value

Type	Description
System.String	The single logout service URL path.

SingleSignOnServiceCompletionPath

Gets or sets the single sign-on service completion URL path.

The default value is /SAML/SingleSignOnServiceCompletion.

Declaration

public string SingleSignOnServiceCompletionPath { get; set; }

Property Value

Type	Description
System.String	The single sign-on service completion URL path.

SingleSignOnServicePath

Gets or sets the single sign-on service URL path.

The default value is /SAML/SingleSignOnService.

Declaration

public string SingleSignOnServicePath { get; set; }

Property Value

Type	Description
System.String	The single sign-on service URL path.