OpenSearch User Definition 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/opensearch/properties/extraUsers/items/properties/definition
Configures the permissions the role will have.
This schema does not cover the entire upstream object.
| 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 (OpenSearch User Definition)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| attributes | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| backend_role | array |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| opendistro_security_roles | array |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| password | string |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
attributes¶
Configures the attributes the user will have.
attributes
-
is optional
-
Type:
object(OpenSearch User Attributes) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (OpenSearch User Attributes)
backend_role¶
Configures the backend roles or groups the user will have.
backend_role
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string[]
opendistro_security_roles¶
Configures the security roles the user will have.
Note
These roles must exists or be created via extraRoles.
opendistro_security_roles
-
is optional
-
Type:
string[](OpenSearch Security Role) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string[] (OpenSearch Security Role)
password¶
password
-
is optional
-
Type:
string(OpenSearch User Password) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string (OpenSearch User Password)
Return to the root secrets schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main