Class SamlAuthenticationOptions
The SAML v2.0 SSO authentication options.
Inheritance
Inherited Members
Namespace: ComponentSpace.Saml2.Authentication
Assembly: ComponentSpace.Saml2.dll
Syntax
public class SamlAuthenticationOptions : AuthenticationSchemeOptions
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 suffix. |
AssertionConsumerServicePath
Gets or sets the assertion consumer service URL path.
The default value is /SAML/AssertionConsumerService.
Declaration
public string AssertionConsumerServicePath { get; set; }
Property Value
Type | Description |
---|---|
System.String | The assertion consumer 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. |
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. |
LoginCompletionUrl
Gets or sets the optional delegate called to return the URL to redirect to after completing login, if not otherwise specified.
Declaration
public Func<HttpContext, string, string, string> LoginCompletionUrl { get; set; }
Property Value
Type | Description |
---|---|
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String, System.String, System.String> | The delegate called to return the URL to redirect to after completing login, if not otherwise specified. |
LogoutCompletionUrl
Gets or sets the optional delegate called to return the URL to redirect to after completing logout, if not otherwise specified.
Declaration
public Func<HttpContext, string, string, string> LogoutCompletionUrl { get; set; }
Property Value
Type | Description |
---|---|
System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String, System.String, System.String> | The delegate called to return the URL to redirect to after completing logout, if not otherwise specified. |
PartnerName
Gets or sets the optional delegate called to return the partner identity 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 identity provider name. |
SignInScheme
Gets or sets the authentication scheme responsible for persisting user's identity after successful authentication.
Declaration
public string SignInScheme { get; set; }
Property Value
Type | Description |
---|---|
System.String | The authentication scheme responsible for persisting user's identity after successful authentication. |
SignOutScheme
Gets or sets the authentication scheme responsible for sign out.
Declaration
public string SignOutScheme { get; set; }
Property Value
Type | Description |
---|---|
System.String | The authentication scheme responsible for sign out. |
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 suffix. |