Class DexConfig

Dex configuration model.

Inheritance

object

DexConfig

Namespace: Neon.Kube.Resources.Dex

Assembly: Neon.Kube.Resources.dll

Syntax

public class DexConfig

Constructors

DexConfig()

Constructor.

Declaration

public DexConfig()

Properties

Connectors

The storage configuration determines where dex stores its state. Supported options include SQL flavors and Kubernetes third party resources. See the documentation (https://dexidp.io/docs/storage/) for further information.

Declaration

[JsonProperty(PropertyName = "Connectors", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "connectors", ApplyNamingConventions = false)]
public List<IV1DexConnector> Connectors { get; set; }

Property Value

Type	Description
List<IV1DexConnector>

EnablePasswordDb

Let dex keep a list of passwords which can be used to login to dex.

Declaration

[JsonProperty(PropertyName = "EnablePasswordDb", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "enablePasswordDb", ApplyNamingConventions = false)]
public bool? EnablePasswordDb { get; set; }

Property Value

Type	Description
bool?

Grpc

This block to enable the gRPC API. This values MUST be different from the HTTP endpoints.

Declaration

[JsonProperty(PropertyName = "Grpc", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "grpc", ApplyNamingConventions = false)]
public DexGrpcConfig Grpc { get; set; }

Property Value

Type	Description
DexGrpcConfig

Issuer

The base path of dex and the external name of the OpenID Connect service. This is the canonical URL that all clients MUST use to refer to dex. If a path is provided, dex's HTTP service will listen at a non-root URL.

Declaration

[JsonProperty(PropertyName = "Issuer", Required = Required.Always)]
[YamlMember(Alias = "issuer", ApplyNamingConventions = false)]
public string Issuer { get; set; }

Property Value

Type	Description
string

Logger

Options for controlling the logger.

Declaration

[JsonProperty(PropertyName = "Logger", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "logger", ApplyNamingConventions = false)]
public DexLogConfig Logger { get; set; }

Property Value

Type	Description
DexLogConfig

Oauth2

Options for Oauth2 related settings.

Declaration

[JsonProperty(PropertyName = "Oauth2", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "oauth2", ApplyNamingConventions = false)]
public DexOauth2Config Oauth2 { get; set; }

Property Value

Type	Description
DexOauth2Config

StaticPasswords

A static list of passwords to login the end user. By identifying here, dex won't look in its underlying storage for passwords.

note

If this option isn't chosen users may be added through the gRPC API.

Declaration

[JsonProperty(PropertyName = "StaticPasswords", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "staticPasswords", ApplyNamingConventions = false)]
public List<DexStaticUser> StaticPasswords { get; set; }

Property Value

Type	Description
List<DexStaticUser>

Storage

The storage configuration determines where dex stores its state. Supported options include SQL flavors and Kubernetes third party resources. See the documentation (https://dexidp.io/docs/storage/) for further information.

Declaration

[JsonProperty(PropertyName = "Storage", Required = Required.Always)]
[YamlMember(Alias = "storage", ApplyNamingConventions = false)]
public DexStorage Storage { get; set; }

Property Value

Type	Description
DexStorage

Telemetry

Configuration for telemetry.

Declaration

[JsonProperty(PropertyName = "Telemetry", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "telemetry", ApplyNamingConventions = false)]
public DexTelemetryConfig Telemetry { get; set; }

Property Value

Type	Description
DexTelemetryConfig

Web

Configuration for the http server.

Declaration

[JsonProperty(PropertyName = "Web", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "web", ApplyNamingConventions = false)]
public DexWebConfig Web { get; set; }

Property Value

Type	Description
DexWebConfig