Couchbase

​

Prerequisite

​

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

3

Select Couchbase

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

default:"https://cloudapi.cloud.couchbase.com"

required

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

default:"*"

required

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

5

(Optional) Advanced Configuration

​

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
• {{identity.name}}: Name of the identity that is generating the 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

Examples:

Copy

Ask AI

{{randomUsername}}                              // infisical-3POnzeFyK9gW2nioK0q2gMjr6CZqsRiX
{{unixTimestamp}}                               // 17490641580
{{identity.name}}                               // testuser
{{random 5}}                                    // x9k2m
{{truncate identity.name 4}}                    // test
{{replace identity.name 'user' 'replace'}}      // testreplace

​

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: < > ; . * & | £

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 will see a dynamic secret created in the dashboard.

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

7

Generate dynamic secrets

Once you’ve successfully configured the dynamic secret, you’re ready to generate on-demand credentials. To do this, simply click on 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. 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.

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.

​

Advanced Bucket Configuration Examples

​

Example 1: Specific Bucket Access

[
  {
    "name": "travel-sample"
  }
]

​

Example 2: Bucket with Specific Scopes

[
  {
    "name": "travel-sample",
    "scopes": [
      {
        "name": "inventory"
      },
      {
        "name": "_default"
      }
    ]
  }
]

​

Example 3: Bucket with Scopes and Collections

[
  {
    "name": "travel-sample",
    "scopes": [
      {
        "name": "inventory",
        "collections": ["airport", "airline"]
      },
      {
        "name": "_default",
        "collections": ["users"]
      }
    ]
  }
]

​

Audit or Revoke Leases

​

Renew Leases

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

​

Couchbase Roles and Permissions

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

​

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