Class Oauth2ProxyProvider

Oauth2Proxy providers model.

Inheritance

object

Oauth2ProxyProvider

Namespace: Neon.Kube.Oauth2Proxy

Assembly: Neon.Kube.dll

Syntax

public class Oauth2ProxyProvider

Constructors

Oauth2ProxyProvider()

Constructor.

Declaration

public Oauth2ProxyProvider()

Properties

AllowedGroups

A list of restrict logins to members of this group.

Declaration

[JsonProperty(PropertyName = "AllowedGroups", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "allowedGroups", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public List<string> AllowedGroups { get; set; }

Property Value

Type	Description
List<string>

CaFiles

A list of paths to CA certificates that should be used when connecting to the provider.

Declaration

[JsonProperty(PropertyName = "CaFiles", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "caFiles", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public List<string> CaFiles { get; set; }

Property Value

Type	Description
List<string>

Remarks

If not specified, the default Go trust sources are used instead

ClientId

The OAuth Client ID that is defined in the provider This value is required for all providers.

Declaration

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

Property Value

Type	Description
string

ClientSecret

The OAuth Client Secret that is defined in the provider This value is required for all providers.

Declaration

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

Property Value

Type	Description
string

ClientSecretFile

The name of the file containing the OAuth Client Secret, it will be used if ClientSecret is not set. This value is required for all providers.

Declaration

[JsonProperty(PropertyName = "ClientSecretFile", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "clientSecretFile", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string ClientSecretFile { get; set; }

Property Value

Type	Description
string

CodeChallengeMethod

The access token validation endpoint.

Declaration

[JsonProperty(PropertyName = "CodeChallengeMethod", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "code_challenge_method", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string CodeChallengeMethod { get; set; }

Property Value

Type	Description
string

Id

ID should be a unique identifier for the provider.

Declaration

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

Property Value

Type	Description
string

LoginUrl

The authentication endpoint

Declaration

[JsonProperty(PropertyName = "LoginUrl", Required = Required.Always, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "loginURL", ApplyNamingConventions = false)]
public string LoginUrl { get; set; }

Property Value

Type	Description
string

LoginUrlParameters

Defines the parameters that can be passed from the start URL to the IdP login URL

Declaration

[JsonProperty(PropertyName = "LoginUrlParameters", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "loginURLParameters", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public List<Oauth2ProxyLoginUrlParameters> LoginUrlParameters { get; set; }

Property Value

Type	Description
List<Oauth2ProxyLoginUrlParameters>

Name

The providers display name if set, it will be shown to the users in the login page.

Declaration

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

Property Value

Type	Description
string

OidcConfig

Holds all configurations for OIDC provider or providers utilize OIDC configurations.

Declaration

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

Property Value

Type	Description
Oauth2ProxyOidcOptions

ProfileUrl

The profile access endpoint.

Declaration

[JsonProperty(PropertyName = "ProfileUrl", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "profileURL", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string ProfileUrl { get; set; }

Property Value

Type	Description
string

Provider

The OAuth provider type. Oauth2ProxyProviderType

Declaration

[JsonProperty(PropertyName = "Provider", Required = Required.Always)]
[YamlMember(Alias = "provider", ApplyNamingConventions = false)]
public Oauth2ProxyProviderType Provider { get; set; }

Property Value

Type	Description
Oauth2ProxyProviderType

RedeemUrl

The token redemption endpoint.

Declaration

[JsonProperty(PropertyName = "RedeemUrl", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "redeemURL", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string RedeemUrl { get; set; }

Property Value

Type	Description
string

Resource

The profile access endpoint.

Declaration

[JsonProperty(PropertyName = "Resource", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "resource", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string Resource { get; set; }

Property Value

Type	Description
string

Scope

The access token validation endpoint.

Declaration

[JsonProperty(PropertyName = "Scope", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "scope", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string Scope { get; set; }

Property Value

Type	Description
string

ValidateUrl

The access token validation endpoint.

Declaration

[JsonProperty(PropertyName = "ValidateUrl", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.Ignore)]
[YamlMember(Alias = "validateURL", ApplyNamingConventions = false, DefaultValuesHandling = DefaultValuesHandling.OmitNull)]
public string ValidateUrl { get; set; }

Property Value

Type	Description
string