docs

2026-09-22 13:39:35 +00:00 · 2025-06-07 01:08:32 -04:00
parent f2cdefaeec
commit 54f6e0b5c6
28 changed files with 401 additions and 6 deletions
--- a/docs/api-reference/endpoints/app-connections/oracledb/available.mdx
+++ b/docs/api-reference/endpoints/app-connections/oracledb/available.mdx
@@ -0,0 +1,4 @@
+---
+title: "Available"
+openapi: "GET /api/v1/app-connections/oracledb/available"
+---
--- a/docs/api-reference/endpoints/app-connections/oracledb/create.mdx
+++ b/docs/api-reference/endpoints/app-connections/oracledb/create.mdx
@@ -0,0 +1,8 @@
+---
+title: "Create"
+openapi: "POST /api/v1/app-connections/oracledb"
+---
+
+<Note>
+    Check out the configuration docs for [OracleDB Connections](/integrations/app-connections/oracledb) to learn how to obtain the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/app-connections/oracledb/delete.mdx
+++ b/docs/api-reference/endpoints/app-connections/oracledb/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/app-connections/oracledb/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/oracledb/get-by-id.mdx
+++ b/docs/api-reference/endpoints/app-connections/oracledb/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/app-connections/oracledb/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/oracledb/get-by-name.mdx
+++ b/docs/api-reference/endpoints/app-connections/oracledb/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/app-connections/oracledb/connection-name/{connectionName}"
+---
--- a/docs/api-reference/endpoints/app-connections/oracledb/list.mdx
+++ b/docs/api-reference/endpoints/app-connections/oracledb/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/app-connections/oracledb"
+---
--- a/docs/api-reference/endpoints/app-connections/oracledb/update.mdx
+++ b/docs/api-reference/endpoints/app-connections/oracledb/update.mdx
@@ -0,0 +1,8 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/app-connections/oracledb/{connectionId}"
+---
+
+<Note>
+    Check out the configuration docs for [OracleDB Connections](/integrations/app-connections/oracledb) to learn how to obtain the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/create.mdx
+++ b/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/create.mdx
@@ -0,0 +1,8 @@
+---
+title: "Create"
+openapi: "POST /api/v2/secret-rotations/oracledb-credentials"
+---
+
+<Note>
+    Check out the configuration docs for [OracleDB Credentials Rotations](/documentation/platform/secret-rotation/oracledb-credentials) to learn how to obtain the required parameters.
+</Note>
--- a/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/delete.mdx
+++ b/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v2/secret-rotations/oracledb-credentials/{rotationId}"
+---
--- a/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/get-by-id.mdx
+++ b/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v2/secret-rotations/oracledb-credentials/{rotationId}"
+---
--- a/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/get-by-name.mdx
+++ b/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v2/secret-rotations/oracledb-credentials/rotation-name/{rotationName}"
+---
--- a/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/get-generated-credentials-by-id.mdx
+++ b/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/get-generated-credentials-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get Credentials by ID"
+openapi: "GET /api/v2/secret-rotations/oracledb-credentials/{rotationId}/generated-credentials"
+---
--- a/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/list.mdx
+++ b/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v2/secret-rotations/oracledb-credentials"
+---
--- a/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/rotate-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/rotate-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Rotate Secrets"
+openapi: "POST /api/v2/secret-rotations/oracledb-credentials/{rotationId}/rotate-secrets"
+---
--- a/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/update.mdx
+++ b/docs/api-reference/endpoints/secret-rotations/oracledb-credentials/update.mdx
@@ -0,0 +1,8 @@
+---
+title: "Update"
+openapi: "PATCH /api/v2/secret-rotations/oracledb-credentials/{rotationId}"
+---
+
+<Note>
+    Check out the configuration docs for [OracleDB Credentials Rotations](/documentation/platform/secret-rotation/oracledb-credentials) to learn how to obtain the required parameters.
+</Note>
--- a/docs/documentation/platform/secret-rotation/oracledb-credentials.mdx
+++ b/docs/documentation/platform/secret-rotation/oracledb-credentials.mdx
@@ -0,0 +1,159 @@
+---
+title: "OracleDB Credentials Rotation"
+description: "Learn how to automatically rotate Oracle Database credentials."
+---
+
+<Info>
+    When working with SQL in Oracle databases, any values not surrounded by "quotes" will become UPPERCASE. Keep this in mind when creating users.
+</Info>
+
+## Prerequisites
+
+1. Create a [OracleDB Connection](/integrations/app-connections/oracledb) with the required **Secret Rotation** permissions
+2. Create two designated database users for Infisical to rotate the credentials for. Be sure to grant each user login permissions for the desired database with the necessary privileges their use case will require.
+
+    An example creation statement might look like:
+    ```SQL
+    -- create user roles
+    CREATE USER "infisical_user_1" IDENTIFIED BY "temporary_password";
+    CREATE USER "infisical_user_2" IDENTIFIED BY "temporary_password";
+
+    -- grant necessary privileges
+    GRANT ALL PRIVILEGES TO "infisical_user_1";
+    GRANT ALL PRIVILEGES TO "infisical_user_2";
+    ```
+
+    <Tip>
+        To learn more about the Oracle Database permission system, please visit their [documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/configuring-privilege-and-role-authorization.html).
+    </Tip>
+
+
+## Create an Oracle Database Credentials Rotation in Infisical
+
+<Tabs>
+    <Tab title="Infisical UI">
+        1. Navigate to your Secret Manager Project's Dashboard and select **Add Secret Rotation** from the actions dropdown.
+        ![Secret Manager Dashboard](/images/secret-rotations-v2/generic/add-secret-rotation.png)
+
+        2. Select the **OracleDB Credentials** option.
+        ![Select OracleDB Credentials](/images/secret-rotations-v2/oracledb-credentials/select-oracledb-credentials-option.png)
+
+        3. Select the **OracleDB Connection** to use and configure the rotation behavior. Then click **Next**.
+        ![Rotation Configuration](/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-configuration.png)
+
+            - **OracleDB Connection** - the connection that will perform the rotation of the configured database user credentials.
+            - **Rotation Interval** - the interval, in days, that once elapsed will trigger a rotation.
+            - **Rotate At** - the local time of day when rotation should occur once the interval has elapsed.
+            - **Auto-Rotation Enabled** - whether secrets should automatically be rotated once the rotation interval has elapsed. Disable this option to manually rotate secrets or pause secret rotation.
+
+        4. Input the usernames of the database users created above that will be used for rotation. Then click **Next**.
+        ![Rotation Parameters](/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-parameters.png)
+
+            - **Database Username 1** - the username of the first user that will be used for rotation.
+            - **Database Username 2** - the username of the second user that will be used for rotation.
+
+        5. Specify the secret names that the active credentials should be mapped to. Then click **Next**.
+        ![Rotation Secrets Mapping](/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-secrets-mapping.png)
+
+            - **Username** - the name of the secret that the active username will be mapped to.
+            - **Password** - the name of the secret that the active password will be mapped to.
+
+        6. Give your rotation a name and description (optional). Then click **Next**.
+        ![Rotation Details](/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-details.png)
+
+            - **Name** - the name of the secret rotation configuration. Must be slug-friendly.
+            - **Description** (optional) - a description of this rotation configuration.
+
+        7. Review your configuration, then click **Create Secret Rotation**.
+        ![Rotation Review](/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-confirm.png)
+
+        8. Your **OracleDB Credentials** are now available for use via the mapped secrets.
+        ![Rotation Created](/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-created.png)
+    </Tab>
+    <Tab title="API">
+        To create a OracleDB Credentials Rotation, make an API request to the [Create OracleDB Credentials Rotation](/api-reference/endpoints/secret-rotations/oracledb-credentials/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl --request POST \
+        --url https://us.infisical.com/api/v2/secret-rotations/oracledb-credentials \
+        --header 'Content-Type: application/json' \
+        --data '{
+            "name": "my-oracledb-rotation",
+            "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "description": "my database credentials rotation",
+            "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "environment": "dev",
+            "secretPath": "/",
+            "isAutoRotationEnabled": true,
+            "rotationInterval": 30,
+            "rotateAtUtc": {
+                "hours": 0,
+                "minutes": 0
+            },
+            "parameters": {
+                "username1": "infisical_user_1",
+                "username2": "infisical_user_2"
+            },
+            "secretsMapping": {
+                "username": "ORACLEDB_USERNAME",
+                "password": "ORACLEDB_PASSWORD"
+            }
+        }'
+        ```
+
+        ### Sample response
+
+        ```bash Response
+        {
+            "secretRotation": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "name": "my-oracledb-rotation",
+                "description": "my database credentials rotation",
+                "secretsMapping": {
+                    "username": "ORACLEDB_USERNAME",
+                    "password": "ORACLEDB_PASSWORD"
+                },
+                "isAutoRotationEnabled": true,
+                "activeIndex": 0,
+                "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "createdAt": "2023-11-07T05:31:56Z",
+                "updatedAt": "2023-11-07T05:31:56Z",
+                "rotationInterval": 30,
+                "rotationStatus": "success",
+                "lastRotationAttemptedAt": "2023-11-07T05:31:56Z",
+                "lastRotatedAt": "2023-11-07T05:31:56Z",
+                "lastRotationJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "nextRotationAt": "2023-11-07T05:31:56Z",
+                "connection": {
+                    "app": "oracledb",
+                    "name": "my-oracledb-connection",
+                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
+                },
+                "environment": {
+                    "slug": "dev",
+                    "name": "Development",
+                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
+                },
+                "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "folder": {
+                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                    "path": "/"
+                },
+                "rotateAtUtc": {
+                    "hours": 0,
+                    "minutes": 0
+                },
+                "lastRotationMessage": null,
+                "type": "oracledb-credentials",
+                "parameters": {
+                    "username1": "infisical_user_1",
+                    "username2": "infisical_user_2"
+                }
+            }
+        }
+        ```
+    </Tab>
+</Tabs>
--- a/docs/images/app-connections/oracledb/create-username-and-password-method.png
+++ b/docs/images/app-connections/oracledb/create-username-and-password-method.png
--- a/docs/images/app-connections/oracledb/select-oracledb-connection.png
+++ b/docs/images/app-connections/oracledb/select-oracledb-connection.png
--- a/docs/images/app-connections/oracledb/username-and-password-connection.png
+++ b/docs/images/app-connections/oracledb/username-and-password-connection.png
--- a/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-configuration.png
+++ b/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-configuration.png
--- a/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-confirm.png
+++ b/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-confirm.png
--- a/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-created.png
+++ b/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-created.png
--- a/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-details.png
+++ b/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-details.png
--- a/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-parameters.png
+++ b/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-parameters.png
--- a/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-secrets-mapping.png
+++ b/docs/images/secret-rotations-v2/oracledb-credentials/oracledb-credentials-secrets-mapping.png
--- a/docs/images/secret-rotations-v2/oracledb-credentials/select-oracledb-credentials-option.png
+++ b/docs/images/secret-rotations-v2/oracledb-credentials/select-oracledb-credentials-option.png
--- a/docs/integrations/app-connections/oracledb.mdx
+++ b/docs/integrations/app-connections/oracledb.mdx
@@ -0,0 +1,133 @@
+---
+title: "OracleDB Connection"
+description: "Learn how to configure a Oracle Database Connection for Infisical."
+---
+
+<Info>
+    OracleDB App Connection is a paid feature.
+
+    If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical,
+    then you should contact team@infisical.com to purchase an enterprise license to use it.
+</Info>
+
+Infisical supports connecting to OracleDB using a database user.
+
+## Configure an Oracle Database User for Infisical
+
+<Steps>
+    <Step title="Create a User">
+        Infisical recommends creating a designated user in your Oracle Database for your connection.
+        ```SQL
+        -- create user
+        CREATE USER "infisical" IDENTIFIED BY "my-password";
+        ```
+    </Step>
+    <Step title="Grant Relevant Permissions">
+       Depending on how you intend to use your OracleDB connection, you'll need to grant one or more of the following permissions.
+        <Tip>
+            To learn more about the Oracle Database permission system, please visit their [documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/configuring-privilege-and-role-authorization.html).
+        </Tip>
+        <Tabs>
+            <Tab title="Secret Rotation">
+                For Secret Rotations, your Infisical user will require the ability to alter other users' passwords:
+                ```SQL
+                -- enable permissions to alter login credentials
+                GRANT ALTER USER TO "infisical";
+                ```
+            </Tab>
+        </Tabs>
+    </Step>
+    <Step title="Get Connection Details">
+        You'll need the following information to create your Oracle Database connection:
+        - `host` - The hostname or IP address of your Oracle Database server
+        - `port` - The port number your Oracle Database server is listening on (default: 1521)
+        - `database` - The Oracle Service Name or SID (System Identifier) for the database you are connecting to. For example: `ORCL`, `FREEPDB1`, `XEPDB1`
+        - `username` - The user name of the login created in the steps above
+        - `password` - The user password of the login created in the steps above
+        - `sslCertificate` (optional) - The SSL certificate required for connection (if configured)
+
+        <Note>
+            If you are self-hosting Infisical and intend to connect to an internal/private IP address, be sure to set the `ALLOW_INTERNAL_IP_CONNECTIONS` environment variable to `true`.
+        </Note>
+    </Step>
+</Steps>
+
+## Create Connection in Infisical
+
+<Tabs>
+    <Tab title="Infisical UI">
+        1. Navigate to the App Connections tab on the Organization Settings page.
+        ![App Connections Tab](/images/app-connections/general/add-connection.png)
+
+        2. Select the **OracleDB Connection** option.
+        ![Select OracleDB Connection](/images/app-connections/oracledb/select-oracledb-connection.png)
+
+        3. Select the **Username & Password** method option and provide the details obtained from the previous section and press **Connect to OracleDB**.
+
+        <Note>
+            Optionally, if you'd like Infisical to manage the credentials of this connection, you can enable the Platform Managed Credentials option.
+            If enabled, Infisical will update the password of the connection on creation to prevent external access to this database user.
+        </Note>
+
+        ![Create OracleDB Connection](/images/app-connections/oracledb/create-username-and-password-method.png)
+
+        4. Your **OracleDB Connection** is now available for use.
+        ![Assume User OracleDB Connection](/images/app-connections/oracledb/username-and-password-connection.png)
+    </Tab>
+    <Tab title="API">
+        To create an Oracle Database Connection, make an API request to the [Create OracleDB Connection](/api-reference/endpoints/app-connections/oracledb/create) API endpoint.
+
+        <Note>
+            Optionally, if you'd like Infisical to manage the credentials of this connection, you can set the `isPlatformManagedCredentials` option to `true`.
+            If enabled, Infisical will update the password of the connection on creation to prevent external access to this database user.
+        </Note>
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+        --url https://app.infisical.com/api/v1/app-connections/oracledb \
+        --header 'Content-Type: application/json' \
+        --data '{
+            "name": "my-oracledb-connection",
+            "method": "username-and-password",
+            "isPlatformManagedCredentials": true,
+            "credentials": {
+                "host": "123.4.5.6",
+                "port": 1521,
+                "database": "FREEPDB1",
+                "username": "infisical",
+                "password": "my-password",
+                "sslEnabled": true,
+                "sslRejectUnauthorized": true
+            },
+        }'
+        ```
+
+        ### Sample response
+
+        ```bash Response
+        {
+            "appConnection": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "name": "my-oracledb-connection",
+                "version": 1,
+                "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "createdAt": "2023-11-07T05:31:56Z",
+                "updatedAt": "2023-11-07T05:31:56Z",
+                "app": "oracledb",
+                "method": "username-and-password",
+                "isPlatformManagedCredentials": true,
+                "credentials": {
+                    "host": "123.4.5.6",
+                    "port": 1521,
+                    "database": "FREEPDB1",
+                    "username": "infisical",
+                    "sslEnabled": true,
+                    "sslRejectUnauthorized": true
+                }
+            }
+        }
+        ```
+    </Tab>
+</Tabs>
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -200,6 +200,7 @@
            "documentation/platform/secret-rotation/ldap-password",
            "documentation/platform/secret-rotation/mssql-credentials",
            "documentation/platform/secret-rotation/mysql-credentials",
+            "documentation/platform/secret-rotation/oracledb-credentials",
            "documentation/platform/secret-rotation/postgres-credentials"
          ]
        },
@@ -506,6 +507,7 @@
            "integrations/app-connections/mssql",
            "integrations/app-connections/mysql",
            "integrations/app-connections/oci",
+            "integrations/app-connections/oracledb",
            "integrations/app-connections/postgres",
            "integrations/app-connections/teamcity",
            "integrations/app-connections/terraform-cloud",
@@ -1030,6 +1032,19 @@
                "api-reference/endpoints/secret-rotations/mysql-credentials/update"
              ]
            },
+            {
+              "group": "OracleDB Credentials",
+              "pages": [
+                "api-reference/endpoints/secret-rotations/oracledb-credentials/create",
+                "api-reference/endpoints/secret-rotations/oracledb-credentials/delete",
+                "api-reference/endpoints/secret-rotations/oracledb-credentials/get-by-id",
+                "api-reference/endpoints/secret-rotations/oracledb-credentials/get-by-name",
+                "api-reference/endpoints/secret-rotations/oracledb-credentials/get-generated-credentials-by-id",
+                "api-reference/endpoints/secret-rotations/oracledb-credentials/list",
+                "api-reference/endpoints/secret-rotations/oracledb-credentials/rotate-secrets",
+                "api-reference/endpoints/secret-rotations/oracledb-credentials/update"
+              ]
+            },
            {
              "group": "PostgreSQL Credentials",
              "pages": [
@@ -1049,8 +1064,8 @@
          "group": "Secret Scanning",
          "pages": [
            {
-              "group":  "Data Sources",
-              "pages":  [
+              "group": "Data Sources",
+              "pages": [
                "api-reference/endpoints/secret-scanning/data-sources/list",
                "api-reference/endpoints/secret-scanning/data-sources/options",
                {
@@ -1071,15 +1086,15 @@
              ]
            },
            {
-              "group":  "Findings",
-              "pages":  [
+              "group": "Findings",
+              "pages": [
                "api-reference/endpoints/secret-scanning/findings/list",
                "api-reference/endpoints/secret-scanning/findings/update"
              ]
            },
            {
-              "group":  "Configuration",
-              "pages":  [
+              "group": "Configuration",
+              "pages": [
                "api-reference/endpoints/secret-scanning/config/get-by-project-id",
                "api-reference/endpoints/secret-scanning/config/update"
              ]
@@ -1322,6 +1337,18 @@
                "api-reference/endpoints/app-connections/oci/delete"
              ]
            },
+            {
+              "group": "OracleDB",
+              "pages": [
+                "api-reference/endpoints/app-connections/oracledb/list",
+                "api-reference/endpoints/app-connections/oracledb/available",
+                "api-reference/endpoints/app-connections/oracledb/get-by-id",
+                "api-reference/endpoints/app-connections/oracledb/get-by-name",
+                "api-reference/endpoints/app-connections/oracledb/create",
+                "api-reference/endpoints/app-connections/oracledb/update",
+                "api-reference/endpoints/app-connections/oracledb/delete"
+              ]
+            },
            {
              "group": "PostgreSQL",
              "pages": [