Class Saml2AuthenticationOptions

Namespace

ProjectTemplate.Web.Authentication.Providers.Saml2

Assembly

ProjectTemplate.Web.dll

Represents SAML2 authentication provider configuration.

public sealed class Saml2AuthenticationOptions

Inheritance

object

Saml2AuthenticationOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DisplayName

Gets or sets the display name associated with the SAML2 entity.

public string DisplayName { get; set; }

Property Value

string

Enabled

Gets or sets a value indicating whether the feature is enabled.

public bool Enabled { get; set; }

Property Value

bool

EntityId

Gets or sets the unique identifier for the entity.

public string EntityId { get; set; }

Property Value

string

LoadMetadata

Gets or sets a value indicating whether metadata should be loaded.

public bool LoadMetadata { get; set; }

Property Value

bool

MetadataUrl

Gets or sets the URL of the metadata endpoint associated with this instance.

public string MetadataUrl { get; set; }

Property Value

string

ModulePath

Gets or sets the relative request path that the application listens on for SAML2 authentication callbacks.

public string ModulePath { get; set; }

Property Value

string

Remarks

This path is used by the authentication middleware to receive SAML2 assertions from the identity provider. It should match the Assertion Consumer Service (ACS) endpoint configured with the identity provider.

RequireSignedAssertions

Gets or sets a value indicating whether assertions must be signed.

public bool RequireSignedAssertions { get; set; }

Property Value

bool

Remarks

Set this property to true to require that all assertions are cryptographically signed for validation. This enhances security by ensuring the authenticity and integrity of assertions. If set to false, unsigned assertions will be accepted, which may reduce security.

Scheme

Gets or sets the authentication scheme used for the current operation.

public string Scheme { get; set; }

Property Value

string

ValidateCertificates

Gets or sets a value indicating whether to validate SSL certificates during secure connections.

public bool ValidateCertificates { get; set; }

Property Value

bool

Remarks

Set this property to false to disable certificate validation, which may expose the connection to security risks. It is recommended to leave this property set to true in production environments.