Grafana OIDC Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/grafana/properties/ops/properties/oidc
Configure authentication to Grafana via Dex.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (Grafana OIDC)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| enabled | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| allowedDomains | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| scopes | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| skipRoleSync | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| userGroups | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
enabled¶
enabled
-
is optional
-
Type:
boolean(Grafana OIDC Enabled) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Grafana OIDC Enabled)
DEFAULTS:
The default value is:
true
allowedDomains¶
Configure the domains of the users allowed to authenticate to Grafana.
allowedDomains
-
is optional
-
Type:
string[](Grafana OIDC Allowed Domain) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[] (Grafana OIDC Allowed Domain)
scopes¶
scopes
-
is optional
-
Type:
string(Grafana OIDC Scopes) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Grafana OIDC Scopes)
DEFAULTS:
The default value is:
"openid profile email groups"
skipRoleSync¶
When enabled the roles for user can be managed within Grafana.
skipRoleSync
-
is optional
-
Type:
boolean(Grafana Skip Role Sync) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Grafana Skip Role Sync)
userGroups¶
Configure the roles for groups.
userGroups
-
is optional
-
Type:
object(Grafana OIDC Groups) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Grafana OIDC Groups)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main