Onboard a Couchbase App to SSPM
Focus
Focus
SaaS Security

Onboard a Couchbase App to SSPM

Table of Contents

Onboard a Couchbase App to SSPM

Connect a Couchbase App instance to SSPM to detect posture risks.
For SSPM to detect posture risks in your Couchbase instance, you must onboard your Couchbase instance to SSPM. Through the onboarding process, SSPM connects to a Couchbase API by using an API key that you generate from within Couchbase. After connecting to the Couchbase API, SSPM scans your Couchbase instance for misconfigured settings and account risks.
The supported Couchbase account plans for SSPM scans are the following plans:
  • Developer Pro
  • Enterprise
To access your Couchbase instance, SSPM requires the following information, which you will specify during the onboarding process.
ItemDescription
API Key
A unique, confidential alphanumeric string, that you generate using an Organization Owner account on the Couchbase Capella platform. This credential, which Couchbase calls the API Secret, proves your identity and grants SSPM the authority to authenticate and interact with your Couchbase instance. Couchbase displays this sensitive API Secret only once during key generation.
To onboard your Couchbase instance, you complete the following actions:
  1. Generate and copy the API key for your organization.
    1. Identify the Couchbase account that you will use to create the API key.
      Required Permissions: You will need to assign the API key to the Organizaion Owner role. For this reason, the account that you use to create the key must also be assigned to the Organizaion Owner role.
    2. Open a web browser to the Couchbase login page and log in to the Organizaion Owner account.
    3. From the navigation bar at the top of the Couchbase page, navigate to Settings.
    4. From the settings menu in the left-hand navigation, select API Keys.
    5. On the Management API Keys page, click + Generate Key.
    6. On the Generate Management API Key page, complete the following actions:
      1. Specify a Key Name for the key. After you create the key, its name appear in the list of keys on the Management API Keys page. For this reason, and for effective logging and auditing, give the key a meaningful name. For example, SSPM Integration.
      2. (Optional) Provide a Description of the API Key. After you create the key, this description will appear on the details page for the key. Use this field to describe the purpose of the key or to provide additional details about the key. For example, API key to enable SSPM scans.
      3. Under Organization Roles, assign your key to the Organization Owner role.
      4. Specify a Key Expiration period. The default expiration period is 180 days (roughly, 6 months), which serves as a moderate security baseline. However, because this key is assigned to the highly-privileged Organization Owner role, we recommend that you set the period to 90 days or less to enforce regular key rotation.
      5. Generate Key.
        Couchbase generates the API key and its associated API secret.
      6. Copy the API secret and paste it into a text file.
        Although SSPM will prompt you for an API key during onboarding, the value you will enter in SSPM's API Key field is the API secret. Because Couchbase displays this API secret only once, do not continue to the next step without copying the API secret.
  2. Connect SSPM to your Couchbase instance.
    In SSPM, complete the following steps to enable SSPM to connect to your Couchbase instance.
    1. Log in to Strata Cloud Manager.
    2. Select ConfigurationSaaS SecurityPosture SecurityApplicationsAdd Application and click the Couchbase tile.
    3. On the Posture Security tab, Add New instance.
    4. Log in with Credentials.
    5. In the API Key field, enter the API secret.
    6. Connect.