OpenSearch Single Sign On 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/v0.39.2/config/schemas/config.yaml#/properties/opensearch/properties/sso
Configures Single Sign On to OpenSearch 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 (OpenSearch Single Sign On)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| enabled | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| scope | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| subjectKey | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| rolesKey | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
enabled¶
enabled
-
is optional
-
Type:
boolean(OpenSearch Single Sign On) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (OpenSearch Single Sign On)
scope¶
scope
-
is optional
-
Type:
string(OpenSearch Single Sign On Scopes) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenSearch Single Sign On Scopes)
DEFAULTS:
The default value is:
"openid profile email groups"
subjectKey¶
subjectKey
-
is optional
-
Type:
string(OpenSearch Single Sign On Subject Key) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenSearch Single Sign On Subject Key)
DEFAULTS:
The default value is:
"email"
rolesKey¶
rolesKey
-
is optional
-
Type:
string(OpenSearch Single Sign On Roles Key) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenSearch Single Sign On Roles Key)
DEFAULTS:
The default value is:
"groups"
Return to the root config schema
Generated Thu Nov 14 16:14:40 UTC 2024 from elastisys/compliantkubernetes-apps@v0.39.2