OpenSearch User 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/$defs/user
Definitions for OpenSearch users.
| 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)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| name | string |
Optional | cannot be null | Welkin Apps Secrets |
| definition | object |
Optional | cannot be null | Welkin Apps Secrets |
| attributes | object |
Optional | cannot be null | Welkin Apps Secrets |
| groups | array |
Optional | cannot be null | Welkin Apps Secrets |
| securityRoles | array |
Optional | cannot be null | Welkin Apps Secrets |
| password | string |
Optional | cannot be null | Welkin Apps Secrets |
name¶
name
-
is optional
-
Type:
string(OpenSearch Username) -
cannot be null
-
defined in: Welkin Apps Secrets
TYPE:
string (OpenSearch Username)
definition¶
Configures the permissions the role will have.
This schema does not cover the entire upstream object.
definition
-
is optional
-
Type:
object(OpenSearch User Definition) -
cannot be null
-
defined in: Welkin Apps Secrets
TYPE:
object (OpenSearch User Definition)
attributes¶
Configures the attributes the user will have.
attributes
-
is optional
-
Type:
object(OpenSearch User Attributes) -
cannot be null
-
defined in: Welkin Apps Secrets
TYPE:
object (OpenSearch User Attributes)
groups¶
Configures the backend roles or groups the user will have.
groups
-
is optional
-
Type:
string[] -
cannot be null
-
defined in: Welkin Apps Secrets
TYPE:
string[]
securityRoles¶
Configures the security roles the user will have.
Note
These roles must exists or be created via extraRoles.
securityRoles
-
is optional
-
Type:
string[](OpenSearch Security Role) -
cannot be null
-
defined in: Welkin Apps Secrets
TYPE:
string[] (OpenSearch Security Role)
password¶
password
-
is optional
-
Type:
string(OpenSearch User Password) -
cannot be null
-
defined in: Welkin Apps Secrets
TYPE:
string (OpenSearch User Password)
Return to the root secrets schema
Generated Thu Dec 19 03:51:01 UTC 2024 from elastisys/compliantkubernetes-apps@main