> ## 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.

# Couchbase dynamic secrets

> Learn how to dynamically generate Couchbase Database user credentials.

The Infisical Couchbase dynamic secret allows you to generate Couchbase Cloud Database user credentials on demand based on configured roles and bucket access permissions.

## Prerequisite

Create an API Key in your Couchbase Cloud following the [official documentation](https://docs.couchbase.com/cloud/get-started/create-account.html#create-api-key).

> [!NOTE]
>
> The API Key must have permission to manage database users in your Couchbase Cloud organization and project.

## Set up dynamic secrets with Couchbase

**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 Couchbase**

![Dynamic Secret Modal](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/couchbase/dynamic-secret-couchbase-modal.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

**URL** `string` *required* (default: [https://cloudapi.cloud.couchbase.com](https://cloudapi.cloud.couchbase.com))

The Couchbase Cloud API URL

**Organization ID** `string` *required*

Your Couchbase Cloud organization ID

**Project ID** `string` *required*

Your Couchbase Cloud project ID

**Cluster ID** `string` *required*

Your Couchbase Cloud cluster ID where users will be created

**Roles** `array` *required*

Database credential roles to assign to the generated user. Available options:

* **read**: Read access to bucket data (alias for data\_reader)
* **write**: Read and write access to bucket data (alias for data\_writer)

**Bucket Access** `string` *required* (default: \*)

Specify bucket access configuration:

* Use `*` for access to all buckets
* Use comma-separated bucket names (e.g., `bucket1,bucket2,bucket3`) for specific buckets
* Use Advanced Bucket Configuration for granular scope and collection access

**API Key** `string` *required*

Your Couchbase Cloud API Key for authentication

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

**5. (Optional) Advanced Configuration**

![Advanced Configuration Modal](https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/platform/dynamic-secrets/couchbase/advanced-option-couchbase.png)

**Advanced Bucket Configuration** `boolean` (default: false)

Enable advanced bucket configuration to specify granular access to buckets, scopes, and collections

When Advanced Bucket Configuration is enabled, you can configure:

**Buckets** `array`

List of buckets with optional scope and collection specifications:

* **Bucket Name**: Name of the bucket (e.g., travel-sample)
* **Scopes**: Optional array of scopes within the bucket
  * **Scope Name**: Name of the scope (e.g., inventory, \_default)
  * **Collections**: Optional array of collection names within the scope

**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
```

**Password Configuration** `object`

Optional password generation requirements for Couchbase users:

**Password Length** `number` (default: 12)

Length of the generated password

**Character Requirements** `object`

Minimum required character counts:

* **Lowercase Count**: Minimum lowercase letters (default: 1)
* **Uppercase Count**: Minimum uppercase letters (default: 1)
* **Digit Count**: Minimum digits (default: 1)
* **Symbol Count**: Minimum special characters (default: 1)

**Allowed Symbols** `string` (default: !@#\$%^()\_+-=\[]\{}:,?/\~\`)

Special characters allowed in passwords. Cannot contain: `< > ; . * & | £`

> [!NOTE]
>
> Couchbase password requirements: minimum 8 characters, maximum 128 characters, at least 1 uppercase, 1 lowercase, 1 digit, and 1 special character. Cannot contain: `< > ; . * & | £`

**6. Click 'Submit'**

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

> [!NOTE]
>
> If this step fails, you may need to verify your Couchbase Cloud API key permissions and organization/project/cluster IDs.

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

**7. 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 for it will be shown to you.

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

## Advanced bucket configuration examples

The advanced bucket configuration allows you to specify granular access control:

### Example 1: Specific bucket access

```json theme={"dark"}
[
  {
    "name": "travel-sample"
  }
]
```

### Example 2: Bucket with specific scopes

```json theme={"dark"}
[
  {
    "name": "travel-sample",
    "scopes": [
      {
        "name": "inventory"
      },
      {
        "name": "_default"
      }
    ]
  }
]
```

### Example 3: Bucket with scopes and collections

```json theme={"dark"}
[
  {
    "name": "travel-sample",
    "scopes": [
      {
        "name": "inventory",
        "collections": ["airport", "airline"]
      },
      {
        "name": "_default",
        "collections": ["users"]
      }
    ]
  }
]
```

## 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 its 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

## Couchbase roles and permissions

The Couchbase dynamic secret integration supports the following database credential roles:

* **read**: Provides read-only access to bucket data
* **write**: Provides read and write access to bucket data

> [!NOTE]
>
> These roles are specifically for database credentials and are different from Couchbase's administrative roles. They provide data-level access to buckets, scopes, and collections based on your configuration.

## Troubleshooting

### Common issues

1. **Invalid API Key**: Ensure your Couchbase Cloud API key has the necessary permissions to manage database users
2. **Invalid Organization/Project/Cluster IDs**: Verify that the provided IDs exist and are accessible with your API key
3. **Role Permission Errors**: Make sure you're using only the supported database credential roles (read, write)
4. **Bucket Access Issues**: Ensure the specified buckets exist in your cluster and are accessible


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