Dex Connector Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root secrets schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/v0.39.2/config/schemas/secrets.yaml#/properties/dex/properties/connectors/items
Configure an upstream Identity Provider.
Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config/schemas/secrets.yaml* |
TYPE:
object
(Dex Connector)
PROPERTIES:
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
id | string |
Required | cannot be null | Compliant Kubernetes Apps Secrets |
name | string |
Required | cannot be null | Compliant Kubernetes Apps Secrets |
type | Merged | Required | cannot be null | Compliant Kubernetes Apps Secrets |
config | object |
Required | cannot be null | Compliant Kubernetes Apps Secrets |
id¶
Configure a unique ID to use for this connector in Dex.
id
-
is required
-
Type:
string
(Connector ID) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string
(Connector ID)
EXAMPLES:
google
name¶
Configure a display name to use for this connector in Dex.
name
-
is required
-
Type:
string
(Connector Name) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string
(Connector Name)
EXAMPLES:
Google
type¶
type
-
is required
-
Type:
string
(Connector Type) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string
(Connector Type)
one (and only one) of
config¶
Configure parameters specific for this connector.
TODO:
- Fields are dependent on type of parent and needs to be specified.
- Fields are divergent with type
ldap
compared tooauth
variants.
config
-
is required
-
Type:
object
(Connector Config) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object
(Connector Config)
Return to the root secrets schema
Generated Thu Nov 14 16:14:40 UTC 2024 from elastisys/compliantkubernetes-apps@v0.39.2