Table of Contents

Class SamlMiddlewareOptions

Namespace
ComponentSpace.Saml2.Middleware
Assembly
ComponentSpace.Saml2.dll

The SAML v2.0 SSO middleware options.

public class SamlMiddlewareOptions
Inheritance
SamlMiddlewareOptions
Inherited Members

Properties

ArtifactResolutionServicePath

Gets or sets the artifact resolution service URL path.

The default value is /SAML/ArtifactResolutionService.

public string ArtifactResolutionServicePath { get; set; }

Property Value

string

The artifact resolution service URL path.

ConfigurationName

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

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

Property Value

Func<HttpContext, 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.

public string ConfigurationNameParameter { get; set; }

Property Value

string

The configuration name query string parameter name.

CorrelationIDParameter

Gets or sets the correlation ID query string parameter name.

The default value is CorrelationID.

public string CorrelationIDParameter { get; set; }

Property Value

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.

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

Property Value

Func<HttpContext, 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.

public SamlMiddlewareEvents Events { get; set; }

Property Value

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.

public string InitiateSingleLogoutPath { get; set; }

Property Value

string

The initiate single logout URL path.

InitiateSingleSignOnPath

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

The default value is /SAML/InitiateSingleSignOn.

public string InitiateSingleSignOnPath { get; set; }

Property Value

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.

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

Property Value

Func<HttpContext, 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.

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

Property Value

Func<HttpContext, 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.

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

Property Value

Func<HttpContext, string>

The delegate called to return the logout URL.

PartnerName

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

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

Property Value

Func<HttpContext, 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.

public string PartnerNameParameter { get; set; }

Property Value

string

The partner name query string parameter name.

RelayState

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

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

Property Value

Func<HttpContext, 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.

public string RelayStateParameter { get; set; }

Property Value

string

The relay state query string parameter name.

ReturnUrlParameter

Gets or sets the return URL query string parameter name.

The default value is ReturnUrl.

public string ReturnUrlParameter { get; set; }

Property Value

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.

public string SingleLogoutServiceCompletionPath { get; set; }

Property Value

string

The single logout service completion URL path.

SingleLogoutServicePath

Gets or sets the single logout service URL path.

The default value is /SAML/SingleLogoutService.

public string SingleLogoutServicePath { get; set; }

Property Value

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.

public string SingleSignOnServiceCompletionPath { get; set; }

Property Value

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.

public string SingleSignOnServicePath { get; set; }

Property Value

string

The single sign-on service URL path.