Connector Config 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/main/config/schemas/secrets.yaml#/properties/dex/properties/connectors/items/properties/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
ldapcompared tooauthvariants.
| 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 (Connector Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| clientID | string |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| clientSecret | string |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| issuer | Merged | Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| adminEmail | Merged | Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| hostedDomains | array |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| redirectURI | Merged | Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| serviceAccountFilePath | string |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
clientID¶
clientID
-
is optional
-
Type:
string(Connector Client ID) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string (Connector Client ID)
clientSecret¶
clientSecret
-
is optional
-
Type:
string(Connector Client Secret) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string (Connector Client Secret)
issuer¶
Used in type: oidc.
issuer
-
is optional
-
Type:
string(Connector Issuer) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string (Connector Issuer)
one (and only one) of
adminEmail¶
Used in type: google.
adminEmail
-
is optional
-
Type:
string(Connector Admin Email) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string (Connector Admin Email)
one (and only one) of
hostedDomains¶
Configure the hosted domains for this connector.
Used in type: google.
hostedDomains
-
is optional
-
Type:
string[](Connector Hosted Domain) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string[] (Connector Hosted Domain)
redirectURI¶
Configure the redirect URI for this connector.
redirectURI
-
is optional
-
Type:
string(Connector Redirect URI) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string (Connector Redirect URI)
one (and only one) of
EXAMPLES:
https://dex.${BASE_DOMAIN}/callback
serviceAccountFilePath¶
Used in type: google.
serviceAccountFilePath
-
is optional
-
Type:
string(Connector Service Account Path) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string (Connector Service Account Path)
EXAMPLES:
/etc/dex/google/sa.json
Return to the root secrets schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main