Class ControllerOptions

Namespace

OpenSettings.AspNetCore

Assembly

OpenSettings.AspNetCore.Spa.dll

Configuration options for the settings controller, including route, authorization and Api visibility.

public class ControllerOptions

Inheritance

object

ControllerOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ControllerOptions()

Initializes a new instance of the ControllerOptions class.

public ControllerOptions()

Properties

AllowFromExploring

Specifies whether the open settings controller's endpoints should be exposed in Api documentation (e.g., for Swagger or other Api explorers).

The default value is 'false'.

public bool AllowFromExploring { get; set; }

Property Value

bool

Authorize

Indicates whether the controller requires authentication for access.

When set to true, authentication is enforced.

When set to false, the controller is accessible without authentication unless the service type is Consumer, in which case the provider's authorization settings take precedence, and authentication may still be required.

(In future releases, this may integrate with AppConfigurations or InstanceConfigurations to determine access based on priority or configuration rank).

The default value is 'false'.

public bool Authorize { get; set; }

Property Value

bool

OAuth2Options

Gets or sets OAuth2 options for the settings controller, allowing for more detailed configuration of authentication and authorization using OAuth2.

public OAuth2Options OAuth2Options { get; set; }

Property Value

OAuth2Options

Route

Gets or sets the base route for the service controller's endpoints. Default is "api/settings". Trailing and leading slashes are trimmed if present.

public string Route { get; set; }

Property Value

string