OpenSearch Role Mapping 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.41.0/config/schemas/config.yaml#/properties/opensearch/$defs/roleMapping
Definitions for OpenSearch role mappings.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config/schemas/config.yaml* |
TYPE:
object (OpenSearch Role Mapping)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| name | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| definition | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| groups | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| users | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
name¶
name
-
is optional
-
Type:
string(OpenSearch Role Mapping Name) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenSearch Role Mapping Name)
definition¶
Configures the backend roles or groups and users the role mapping applies to.
This schema does not cover the entire upstream object.
definition
-
is optional
-
Type:
object(OpenSearch Role Mapping Definition) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (OpenSearch Role Mapping Definition)
groups¶
Configures the backend roles or groups that this role mapping applies to.
groups
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[]
users¶
Configures the user that this role mapping applies to.
users
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[]
Return to the root config schema
Generated Thu Nov 14 16:21:55 UTC 2024 from elastisys/compliantkubernetes-apps@v0.41.0