|
Name
|
Required
|
Type
|
Description
|
|
backend
|
No
|
[backend](configuration-parameters-1830bca.md#loio1830bca1b060484e9cfabc0e62472e8e__table_xyd_p3x_jzb)
|
Configures the OpenSearch backend.
|
|
dashboards
|
No
|
[dashboards](configuration-parameters-1830bca.md#loio1830bca1b060484e9cfabc0e62472e8e__table_gqx_w3x_jzb)
|
Configures the dashboards UI.
|
|
ingest
|
No
|
[ingest](configuration-parameters-1830bca.md#loio1830bca1b060484e9cfabc0e62472e8e__table_brp_bjx_jzb)
|
Configures the ingest endpoint.
|
|
ingest\_otlp
|
No
|
[ingest\_otlp](configuration-parameters-1830bca.md#loio1830bca1b060484e9cfabc0e62472e8e__table_zcy_jjx_jzb)
|
Configures the data ingestion over the ingest-otlp endpoint \(OpenTelemetry Protocol\).
|
|
feature\_flags
|
No
|
String Array
|
Used for enabling specific/experimental features specified as array:
`"feature_flags": [ "feature-1", "feature 2" ]`. Please omit or keep empty by default.
Currently, there are no available feature flags.
|
|
retention\_period
|
No
|
Integer
|
The time in days until data \(see [Ingest Observability Data](ingest-observability-data-ba16ff7.md)\) is deleted. The range is between `1` and `90` and it defaults to `7`. Data can also be deleted if the file grows too large, due to size-based curation. Changing this parameter will only affect newly-created indices.
|
|
saml
|
No
|
[saml](configuration-parameters-1830bca.md#loio1830bca1b060484e9cfabc0e62472e8e__table_nrv_sjx_jzb)
|
Configures the SAML Integration to authenticate in dashboards.
|
|
rotate\_root\_ca
|
No
|
Boolean
|
> ### Note:
> Updating this parameter can invalidate bindings permanently
Controls the rotation of the ingestion root Certificate Authority \(CA\) certificate. Defaults to `false`.
Refer to [Rotate the Ingestion Root CA Certificate](rotate-the-ingestion-root-ca-certificate-bbcb3e7.md) for more details.
|
|
Name
|
Required
|
Type
|
Description
|
|
enabled
|
Yes
|
Boolean
|
Enables SAML authentication. We strongly recommend SAML authentication for production use cases, because of improved security and login flow. Basic authentication is configured if this parameter is set to `false`.
|
|
admin\_group
|
Conditionally
|
String
|
The SAML group to grant administrative access and permissions to modify the security module. Required if `enabled` is set to `true`.
|
|
initiated
|
Conditionally
|
Boolean
|
Enables IdP-initiated SSO. Required if *enabled* is set to `true`.
|
|
roles\_key
|
Conditionally
|
String
|
The list of backend\_roles will be read from this attribute during user login.
This field must be set to the corresponding attribute for IdP groups,usually `groups`. Required if *enabled* is set to `true`.
|
|
idp.metadata\_url
|
Conditionally
|
URL
|
The URL to get the SAML IdP metadata from. Required if *enabled* is set to `true`.
|
|
idp.entity\_id
|
Conditionally
|
String
|
The Entity ID of the SAML IdP.
Open the metadata URL in your browser and copy the full value of the `entityID` field. It is located in the first line of the response. Required if *enabled* is set to `true`.
|
|
sp.entity\_id
|
Conditionally
|
String
|
The Entity ID of the service provider. Generally, this parameter is set to the name of your application configured in your IdP. Required if *enabled* is set to `true`.
|
|
sp.signature\_private\_key
|
No
|
String
|
The private key is used to sign the requests. This parameter must be valid base64 encoded and PKCS8 format.
|
|
sp.signature\_private\_key\_password
|
No
|
String
|
The password of the signing key, if it is encrypted.
|