Class Oauth2ProxyConfig

Oauth2Proxy configuration model.

Inheritance

object

Oauth2ProxyConfig

Namespace: Neon.Kube.Oauth2Proxy

Assembly: Neon.Kube.dll

Syntax

public class Oauth2ProxyConfig

Constructors

Oauth2ProxyConfig()

Constructor.

Declaration

public Oauth2ProxyConfig()

Properties

InjectRequestHeaders

Used to configure headers that should be added to requests to upstream servers. Headers may source values from either the authenticated user's session or from a static secret value.

Declaration

[JsonProperty(PropertyName = "InjectRequestHeaders", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "injectRequestHeaders", ApplyNamingConventions = false)]
public List<Oauth2ProxyHeader> InjectRequestHeaders { get; set; }

Property Value

Type	Description
List<Oauth2ProxyHeader>

InjectResponseHeaders

Used to configure headers that should be added to responses from the proxy. This is typically used when using the proxy as an external authentication provider in conjunction with another proxy such as NGINX and its auth_request module. Headers may source values from either the authenticated user's session or from a static secret value.

Declaration

[JsonProperty(PropertyName = "InjectResponseHeaders", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "injectResponseHeaders", ApplyNamingConventions = false)]
public List<Oauth2ProxyHeader> InjectResponseHeaders { get; set; }

Property Value

Type	Description
List<Oauth2ProxyHeader>

MetricsServer

Used to configure the HTTP(S) server for metrics. You may choose to run both HTTP and HTTPS servers simultaneously. This can be done by setting the BindAddress and the SecureBindAddress simultaneously. To use the secure server you must configure a TLS certificate and key.

Declaration

[JsonProperty(PropertyName = "MetricsServer", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "metricsServer", ApplyNamingConventions = false)]
public Oauth2ProxyServer MetricsServer { get; set; }

Property Value

Type	Description
Oauth2ProxyServer

Providers

Used to configure multiple providers.

Declaration

[JsonProperty(PropertyName = "Providers", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "providers", ApplyNamingConventions = false)]
public List<Oauth2ProxyProvider> Providers { get; set; }

Property Value

Type	Description
List<Oauth2ProxyProvider>

Server

Used to configure headers that should be added to responses from the proxy. This is typically used when using the proxy as an external authentication provider in conjunction with another proxy such as NGINX and its auth_request module. Headers may source values from either the authenticated user's session or from a static secret value.

Declaration

[JsonProperty(PropertyName = "Server", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "server", ApplyNamingConventions = false)]
public Oauth2ProxyServer Server { get; set; }

Property Value

Type	Description
Oauth2ProxyServer

UpstreamConfig

Used to configure upstream servers. Once a user is authenticated, requests to the server will be proxied to these upstream servers based on the path mappings defined in this list.

Declaration

[JsonProperty(PropertyName = "UpstreamConfig", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "upstreamConfig", ApplyNamingConventions = false)]
public Oauth2ProxyUpstreamConfig UpstreamConfig { get; set; }

Property Value

Type	Description
Oauth2ProxyUpstreamConfig