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

# OCI Integration

# Connect OCI Account

Follow these simple steps to complete the setup modal and securely integrate your OCI environment for AI-driven analysis.

## 1. Basic Configuration Follow below steps

1. Once you logged in you will navigate to **Dashboard**.

2. Go to the integration and click on **Connect** button to add OCI Datasource.

3. Enter **Account Name** (e.g., Production-OCI).

4. **Environment**: Click the dropdown menu and select the environment type (e.g., Production, Staging, Development).

5. Enter OCI Tenancy ID (To generate OCI ID refer user guide).

6. Enter OCI User ID (To generate OCI User ID refer user guide).

7. Enter OCI Fingerprint (To generate OCI Fingerprint refer user guide).

8. Enter OCI Private key (To generate OCI Private key refer user guide).

9. Enter OCI Compartment ID (To generate Compartment ID refer user guide).

<Accordion title="📖 View Setup Guide">
  # Oracle Cloud Integration Setup

  Follow the steps below to collect the required OCI credentials and configure your Oracle Cloud account for Zero-X scanning.

  ## 1. Sign In to Oracle Cloud

  1. Open the **Oracle Cloud Console**.
  2. Sign in using a user account that can create API keys.
     * Typically, an administrator account.
     * Or a user with IAM permissions to manage their own API keys.

  ## 2. Open Your User Profile

  1. Click the **Profile** icon in the top-right corner.
  2. Select **My Profile** or **User Settings**.

  This page contains the information required for API authentication.

  ## 3. Collect Required OCIDs

  You need the following OCIDs:

  | API Field | Where to Find It |
  | - | - |
  | **OCI Tenancy ID** | **User Profile** page or **Administration → Tenancy Details** |
  | **OCI User ID** | **User Profile** page |

  Both values begin with `ocid1.`.

  ### Example

  ```text theme={null}
  ocid1.user.oc1..aaaaaaa...
  ocid1.tenancy.oc1..aaaaaaa...
  ```

  Copy both values exactly as displayed in the OCI Console.

  ## 4. Create an API Key

  The API key provides the **Fingerprint** and **Private Key** required for authentication.

  ### Steps

  1. Navigate to **My Profile**.
  2. Open **API Keys** under **Resources**.
  3. Click **Add API Key**.
  4. Select **Generate API Key Pair**.
  5. Download the generated private key (`.pem`) file.
  6. Complete the wizard.

  > **Important:** Oracle displays the private key only once during creation. Store the downloaded `.pem` file securely.

  ### Required Values

  After creating the API key, Oracle displays a fingerprint similar to:

  ```text theme={null}
  aa:bb:cc:dd:ee:ff:00:11:22:33:44:55:66:77:88:99
  ```

  Record the following values:

  | API Field | Source |
  | - | - |
  | `fingerprint` | Displayed after API key creation |
  | `privateKey` | Contents of the downloaded `.pem` file |

  ### Example Private Key

  ```text theme={null}
  -----BEGIN PRIVATE KEY-----
  MIIE...
  ...
  -----END PRIVATE KEY-----
  ```

  When sending the private key in JSON, either:

  * Paste the complete PEM content, or
  * Replace line breaks with `\n`.

  ### JSON Example

  ```json theme={null}
  {
      "privateKey": "-----BEGIN PRIVATE KEY-----\nMIIE...\n-----END PRIVATE KEY-----"
  }
  ```

  ## 5. Get Your Home Region

  Identify the **OCI Home Region** for your tenancy.

  ### Option 1

  Go to:

  **Administration → Region Management**

  ### Option 2

  Use the **Region Selector** in the top navigation bar.

  The Home Region is the region where the tenancy was originally created.

  > **Important:** Use the **Region Identifier**, not the display name.

  ### Example

  ```text theme={null}
  ap-mumbai-1
  ```

  ## 6. Get Your Compartment ID

  1. Sign in to the **OCI Console**.
  2. Open the **☰ Navigation Menu**.
  3. Go to **Identity & Security → Compartments**.
  4. Locate the compartment you want to scan.
  5. Click the compartment.
  6. On the compartment details page, copy the **OCID**.

  The Compartment ID looks like:

  ```text theme={null}
  ocid1.compartment.oc1..aaaaaaa...
  ```

  ## Permissions Required for Full Scanning

  To perform comprehensive cloud inventory and security scans, additional read permissions may be required for services such as:

  * Identity and Access Management (IAM)
  * Compute
  * Networking
  * Storage
  * Database Services
  * Monitoring

  The exact permissions depend on the resources and services being scanned.

  > **Note:** Grant only the permissions required by your organization's security and access-control policies.

  ## Required Information Checklist

  Before configuring the OCI integration in Zero-X, make sure you have the following:

  | Required Information | Available From |
  | - | - |
  | OCI Tenancy ID | User Profile / Tenancy Details |
  | OCI User ID | User Profile |
  | Fingerprint | API Key creation |
  | Private Key | Downloaded `.pem` file |
  | Home Region | Region Management / Region Selector |
  | Compartment ID | Compartment Details |

  Once all required values are collected, they can be entered in the Zero-X OCI integration configuration.
</Accordion>


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