> ## Documentation Index
> Fetch the complete documentation index at: https://infisical.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Elasticsearch dynamic secrets

> Learn how to dynamically generate Elasticsearch user credentials.

The Infisical Elasticsearch dynamic secret allows you to generate Elasticsearch credentials on demand based on configured role.

## Prerequisites

1. Create a role with at least `manage_security` and `monitor` permissions.
2. Assign the newly created role to your API key or user that you'll use later in the dynamic secret configuration.

> [!NOTE]
>
> For testing purposes, you can also use a highly privileged role like
> `superuser`, that will have full control over the cluster. This isn't
> recommended in production environments following the principle of least
> privilege.

## Set up dynamic secrets with Elasticsearch

**1. Open Secret Overview Dashboard**

Open the Secret Overview dashboard and select the environment in which you would like to add a dynamic secret.

**2. Click on the 'Add Dynamic Secret' button**

![Add Dynamic Secret Button](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/add-dynamic-secret-button.png)

**3. Select 'Elasticsearch'**

![Dynamic Secret Modal](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/dynamic-secret-modal-elastic-search.png)

**4. Provide the inputs for dynamic secret parameters**

**Secret Name** `string` *required*

Name by which you want the secret to be referenced

**Default TTL** `string` *required*

Default time-to-live for a generated secret (it is possible to modify this value after a secret is generated)

**Max TTL** `string` *required*

Maximum time-to-live for a generated secret.

**Host** `string` *required*

Your Elasticsearch host. This is the endpoint that your instance runs on. *(Example: [https://your-cluster-ip](https://your-cluster-ip))*

**Port** `string` *required*

The port that your Elasticsearch instance is running on. *(Example: 9200)*

**Roles** `string[]` *required*

The roles that the new user that is created when a lease is provisioned will
be assigned to. This is a required field. This defaults to `superuser`, which
is highly privileged. It's recommended to create a new role with the least
privileges required for the lease.

**Authentication Method** `API Key | Username/Password` *required*

Select the authentication method you want to use to connect to your Elasticsearch instance.

**Username** `string` *required*

The username of the user that will be used to provision new dynamic secret
leases. Only required if you selected the `Username/Password` authentication
method.

**Password** `string` *required*

The password of the user that will be used to provision new dynamic secret
leases. Only required if you selected the `Username/Password` authentication
method.

**API Key ID** *required*

The ID of the API key that will be used to provision new dynamic secret
leases. Only required if you selected the `API Key` authentication method.

**API Key** *required*

The API key that will be used to provision new dynamic secret leases. Only
required if you selected the `API Key` authentication method.

**CA(SSL)** `string`

A CA may be required if your DB requires it for incoming connections. This is often the case when connecting to a managed service.

**SSL Reject Unauthorized** `boolean` (default: true)

If enabled, the server certificate will be verified against the list of supplied CAs. Disable this option if you are using a self-signed certificate.

**Username Template** `string` (default: \{\{randomUsername}})

Specifies a template for generating usernames. This field allows customization of how usernames are automatically created.

Allowed template variables are:

* `{{randomUsername}}`: Random username string.
* `{{unixTimestamp}}`: Current Unix timestamp at the time of lease creation.
* `{{identity.name}}`: Name of the identity that is generating the lease.
* `{{dynamicSecret.name}}`: Name of the associated dynamic secret.
* `{{dynamicSecret.type}}`: Type of the associated dynamic secret.
* `{{random N}}`: Random string of N characters.

Allowed template functions are:

* `truncate`: Truncates a string to a specified length.
* `replace`: Replaces a substring with another value.
* `uppercase`: Converts a string to uppercase.
* `lowercase`: Converts a string to lowercase.

Examples:

```yaml theme={"dark"}
{{ randomUsername }}                                            // 3POnzeFyK9gW2nioK0q2gMjr6CZqsRiX
{{ unixTimestamp }}                                             // 17490641580
{{ identity.name }}                                             // <identity-name>
{{ random 5 }}                                                  // x9K2m
{{ truncate identity.name 4 }}                                  // test
{{ replace identity.name '<identity-name>' 'new-value' }}       // new-value
```

![Dynamic Secret Setup Modal](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/dynamic-secret-input-modal-elastic-search.png)

**5. Click `Submit`**

After submitting the form, you'll see a dynamic secret created in the dashboard.

> [!NOTE]
>
> If this step fails, you may have to add the CA certificate.

**6. Generate dynamic secrets**

Once you've successfully configured the dynamic secret, you're ready to generate on-demand credentials.
To do this, simply select the 'Generate' button which appears when hovering over the dynamic secret item.
Alternatively, you can initiate the creation of a new lease by selecting 'New Lease' from the dynamic secret lease list section.

![Dynamic Secret](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/dynamic-secret-generate.png)

![Dynamic Secret](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/dynamic-secret-lease-empty.png)

When generating these secrets, it's important to specify a Time-to-Live (TTL) duration. This will dictate  how long the credentials are valid for.

![Provision Lease](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/provision-lease.png)

> [!TIP]
>
> Ensure that the TTL for the lease falls within the maximum TTL defined when configuring the dynamic secret.

Once you click the `Submit` button, a new secret lease will be generated and the credentials from it will be shown to you.

![Provision Lease](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/lease-values.png)

## Audit or revoke leases

Once you have created one or more leases, you'll be able to access them by selecting the respective dynamic secret item on the dashboard.
This will allow you to see the expiration time of the lease or delete a lease before it's set time to live.

![Provision Lease](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/lease-data.png)

## Renew leases

To extend the life of the generated dynamic secret leases past its initial time to live, simply select the **Renew** button as illustrated below.

![Provision Lease](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/dynamic-secret-lease-renew.png)

> [!WARNING]
>
> Lease renewals can't exceed the maximum TTL set when configuring the dynamic
> secret


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.