feat(secret-sync): Add Heroku Secret Sync

2026-09-22 13:39:35 +00:00 · 2025-06-17 10:52:55 -03:00
parent 46f9927cf1
commit c2612f242c
86 changed files with 1772 additions and 52 deletions
--- a/docs/api-reference/endpoints/app-connections/heroku/available.mdx
+++ b/docs/api-reference/endpoints/app-connections/heroku/available.mdx
@@ -0,0 +1,4 @@
+---
+title: "Available"
+openapi: "GET /api/v1/app-connections/heroku/available"
+---
--- a/docs/api-reference/endpoints/app-connections/heroku/create.mdx
+++ b/docs/api-reference/endpoints/app-connections/heroku/create.mdx
@@ -0,0 +1,10 @@
+---
+title: "Create"
+openapi: "POST /api/v1/app-connections/heroku"
+---
+
+<Note>
+    Heroku OAuth Connections must be created through the Infisical UI.
+    Check out the configuration docs for [Heroku OAuth Connections](/integrations/app-connections/heroku) for a step-by-step
+    guide.
+</Note>
--- a/docs/api-reference/endpoints/app-connections/heroku/delete.mdx
+++ b/docs/api-reference/endpoints/app-connections/heroku/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/app-connections/heroku/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/heroku/get-by-id.mdx
+++ b/docs/api-reference/endpoints/app-connections/heroku/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/app-connections/heroku/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/heroku/get-by-name.mdx
+++ b/docs/api-reference/endpoints/app-connections/heroku/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/app-connections/heroku/connection-name/{connectionName}"
+---
--- a/docs/api-reference/endpoints/app-connections/heroku/list.mdx
+++ b/docs/api-reference/endpoints/app-connections/heroku/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/app-connections/heroku"
+---
--- a/docs/api-reference/endpoints/app-connections/heroku/update.mdx
+++ b/docs/api-reference/endpoints/app-connections/heroku/update.mdx
@@ -0,0 +1,10 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/app-connections/heroku/{connectionId}"
+---
+
+<Note>
+    Heroku OAuth Connections must be updated through the Infisical UI.
+    Check out the configuration docs for [Heroku OAuth Connections](/integrations/app-connections/heroku) for a step-by-step
+    guide.
+</Note>
--- a/docs/api-reference/endpoints/secret-syncs/heroku/create.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/heroku/create.mdx
@@ -0,0 +1,4 @@
+---
+title: "Create"
+openapi: "POST /api/v1/secret-syncs/heroku"
+---
--- a/docs/api-reference/endpoints/secret-syncs/heroku/delete.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/heroku/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/secret-syncs/heroku/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/heroku/get-by-id.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/heroku/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/secret-syncs/heroku/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/heroku/get-by-name.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/heroku/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/secret-syncs/heroku/sync-name/{syncName}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/heroku/import-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/heroku/import-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Import Secrets"
+openapi: "POST /api/v1/secret-syncs/heroku/{syncId}/import-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/heroku/list.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/heroku/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/secret-syncs/heroku"
+---
--- a/docs/api-reference/endpoints/secret-syncs/heroku/remove-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/heroku/remove-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Remove Secrets"
+openapi: "POST /api/v1/secret-syncs/heroku/{syncId}/remove-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/heroku/sync-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/heroku/sync-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Sync Secrets"
+openapi: "POST /api/v1/secret-syncs/heroku/{syncId}/sync-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/heroku/update.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/heroku/update.mdx
@@ -0,0 +1,4 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/secret-syncs/heroku/{syncId}"
+---
--- a/docs/images/app-connections/heroku/heroku-api-token.png
+++ b/docs/images/app-connections/heroku/heroku-api-token.png
--- a/docs/images/app-connections/heroku/heroku-connection.png
+++ b/docs/images/app-connections/heroku/heroku-connection.png
--- a/docs/images/app-connections/heroku/heroku-create-oauth-method.png
+++ b/docs/images/app-connections/heroku/heroku-create-oauth-method.png
--- a/docs/images/app-connections/heroku/heroku-create-token-method.png
+++ b/docs/images/app-connections/heroku/heroku-create-token-method.png
--- a/docs/images/app-connections/heroku/heroku-select-connection.png
+++ b/docs/images/app-connections/heroku/heroku-select-connection.png
--- a/docs/images/secret-syncs/heroku/heroku-created.png
+++ b/docs/images/secret-syncs/heroku/heroku-created.png
--- a/docs/images/secret-syncs/heroku/heroku-destination.png
+++ b/docs/images/secret-syncs/heroku/heroku-destination.png
--- a/docs/images/secret-syncs/heroku/heroku-details.png
+++ b/docs/images/secret-syncs/heroku/heroku-details.png
--- a/docs/images/secret-syncs/heroku/heroku-options.png
+++ b/docs/images/secret-syncs/heroku/heroku-options.png
--- a/docs/images/secret-syncs/heroku/heroku-review.png
+++ b/docs/images/secret-syncs/heroku/heroku-review.png
--- a/docs/images/secret-syncs/heroku/heroku-source.png
+++ b/docs/images/secret-syncs/heroku/heroku-source.png
--- a/docs/images/secret-syncs/heroku/select-heroku-option.png
+++ b/docs/images/secret-syncs/heroku/select-heroku-option.png
--- a/docs/integrations/app-connections/heroku.mdx
+++ b/docs/integrations/app-connections/heroku.mdx
@@ -0,0 +1,121 @@
+---
+title: "Heroku App Connection"
+description: "Learn how to configure a Heroku App Connection for Infisical using OAuth or Auth Token methods."
+---
+
+Infisical supports two methods for connecting to Heroku: **OAuth** and **Auth Token**. Choose the method that best fits your setup and security requirements.
+
+<Tabs>
+  <Tab title="OAuth Method">
+    The OAuth method provides secure authentication through Heroku's OAuth flow.
+
+    <Accordion title="Self-Hosted Instance Setup">
+      Using the Heroku App Connection with OAuth on a self-hosted instance of Infisical requires configuring an API client in Heroku and registering your instance with it.
+
+      **Prerequisites:**
+      - A Heroku account with existing applications
+      - Self-hosted Infisical instance
+
+      <Steps>
+        <Step title="Create an API client in Heroku">
+          Navigate to your user Account settings > Applications to create a new API client.
+
+          ![Heroku config settings](/images/integrations/heroku/integrations-heroku-config-settings.png)
+          ![Heroku config applications](/images/integrations/heroku/integrations-heroku-config-applications.png)
+          ![Heroku config new app](/images/integrations/heroku/integrations-heroku-config-new-app.png)
+
+          Create the API client. As part of the form, set the **OAuth callback URL** to `https://your-domain.com/organization/app-connections/heroku/oauth/callback`.
+
+          <Tip>
+            The domain you defined in the OAuth callback URL should be equivalent to the `SITE_URL` configured in your Infisical instance.
+          </Tip>
+
+          ![Heroku config new app form](/images/integrations/heroku/integrations-heroku-config-new-app-form.png)
+        </Step>
+        <Step title="Add your Heroku API client credentials to Infisical">
+          Obtain the **Client ID** and **Client Secret** for your Heroku API client.
+
+          ![Heroku config credentials](/images/integrations/heroku/integrations-heroku-config-credentials.png)
+
+          Back in your Infisical instance, add two new environment variables for the credentials of your Heroku API client:
+
+          - `INF_APP_CONNECTION_HEROKU_CLIENT_ID`: The **Client ID** of your Heroku API client.
+          - `INF_APP_CONNECTION_HEROKU_CLIENT_SECRET`: The **Client Secret** of your Heroku API client.
+
+          Once added, restart your Infisical instance and use the Heroku App Connection.
+        </Step>
+      </Steps>
+    </Accordion>
+
+    ## Setup Heroku OAuth Connection in Infisical
+
+    <Steps>
+      <Step title="Navigate to App Connections">
+        Navigate to the **App Connections** tab on the **Organization Settings** page.
+        ![App Connections Tab](/images/app-connections/general/add-connection.png)
+      </Step>
+      <Step title="Add Connection">
+        Select the **Heroku App Connection** option from the connection options modal.
+        ![Select Heroku Connection](/images/app-connections/heroku/heroku-select-connection.png)
+      </Step>
+      <Step title="Choose OAuth Method">
+        Select the **OAuth** method and click **Connect to Heroku**.
+
+        ![Connect via Heroku OAuth](/images/app-connections/heroku/heroku-create-oauth-method.png)
+      </Step>
+      <Step title="Grant Access">
+        You will be redirected to Heroku to grant Infisical access to your Heroku account. Once granted, you will be redirected back to Infisical's App Connections page.
+        ![Heroku Authorization](/images/integrations/heroku/integrations-heroku-auth.png)
+      </Step>
+      <Step title="Connection Created">
+        Your **Heroku App Connection** is now available for use.
+        ![Heroku OAuth Connection](/images/app-connections/heroku/heroku-connection.png)
+      </Step>
+    </Steps>
+
+  </Tab>
+
+  <Tab title="Auth Token Method">
+    The Auth Token method uses a Heroku API token for authentication, providing a straightforward setup process.
+
+    ## Setup Heroku Auth Token Connection in Infisical
+
+    <Steps>
+      <Step title="Generate Heroku API Token">
+        Log in to your Heroku account and navigate to Account Settings.
+
+        Under the **Authorizations** section, reveal and copy your Authorization token. If you don't have one, click **Create Authorization** to create a new token.
+
+        <Warning>
+          Keep your Authorization token secure and do not share it. Anyone with access to this token can manage your Heroku applications.
+        </Warning>
+
+        ![Heroku API Token](/images/app-connections/heroku/heroku-api-token.png)
+      </Step>
+      <Step title="Navigate to App Connections">
+        Navigate to the **App Connections** tab on the **Organization Settings** page.
+        ![App Connections Tab](/images/app-connections/general/add-connection.png)
+      </Step>
+      <Step title="Add Connection">
+        Select the **Heroku App Connection** option from the connection options modal.
+        ![Select Heroku Connection](/images/app-connections/heroku/heroku-select-connection.png)
+      </Step>
+      <Step title="Configure Auth Token">
+        Select the **Auth Token** method and paste your Heroku Authorization token in the provided field.
+
+        ![Configure Auth Token](/images/app-connections/heroku/heroku-create-token-method.png)
+
+        Click **Connect** to establish the connection.
+      </Step>
+      <Step title="Connection Created">
+        Your **Heroku App Connection** is now available for use.
+        ![Heroku Auth Token Connection](/images/app-connections/heroku/heroku-connection.png)
+      </Step>
+    </Steps>
+
+    <Info>
+      Auth Token connections require manual token rotation when your Heroku Authorization expires or is regenerated. Monitor your connection status and update the token as needed.
+    </Info>
+
+  </Tab>
+</Tabs>
--- a/docs/integrations/secret-syncs/heroku.mdx
+++ b/docs/integrations/secret-syncs/heroku.mdx
@@ -0,0 +1,143 @@
+---
+title: "Heroku Sync"
+description: "Learn how to configure a Heroku Sync for Infisical."
+---
+
+**Prerequisites:**
+
+- Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
+- Create a [Heroku App Connection](/integrations/app-connections/heroku)
+
+<Tabs>
+    <Tab title="Infisical UI">
+        1. Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Click on the **Add Sync** button.
+        ![Secret Syncs Tab](/images/secret-syncs/general/secret-sync-tab.png)
+
+        2. Select the **Heroku** option.
+        ![Select Heroku](/images/secret-syncs/heroku/select-heroku-option.png)
+
+        3. Configure the **Source** from where secrets should be retrieved, then click **Next**.
+        ![Configure Source](/images/secret-syncs/heroku/heroku-source.png)
+
+            - **Environment**: The project environment to retrieve secrets from.
+            - **Secret Path**: The folder path to retrieve secrets from.
+
+        <Tip>
+            If you need to sync secrets from multiple folder locations, check out [secret imports](/documentation/platform/secret-reference#secret-imports).
+        </Tip>
+
+        4. Configure the **Destination** to where secrets should be deployed, then click **Next**.
+        ![Configure Destination](/images/secret-syncs/heroku/heroku-destination.png)
+
+            - **Heroku App Connection**: The Heroku App Connection to authenticate with.
+            - **Heroku App**: The Heroku application to sync secrets to.
+
+        5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
+        ![Configure Options](/images/secret-syncs/heroku/heroku-options.png)
+
+            - **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync.
+                - **Import - Prefer values from Infisical**: Import secrets from Heroku to Infisical; if a secret with the same name already exists in Infisical, do nothing. Afterwards, sync secrets to Heroku.
+                - **Import - Prefer values from Heroku**: Import secrets from Heroku to Infisical; if a secret with the same name already exists in Infisical, replace its value with the one from Heroku. Afterwards, sync secrets to Heroku.
+                - **Overwrite Destination Secrets**: Removes any secrets at the destination endpoint not present in Infisical.
+            - **Key Schema**: Template that determines how secret names are transformed when syncing, using `{{secretKey}}` as a placeholder for the original secret name and `{{environment}}` for the environment.
+            <Note>
+                We highly recommend using a Key Schema to ensure that Infisical only manages the specific keys you intend, keeping everything else untouched.
+            </Note>
+            - **Auto-Sync Enabled**: If enabled, secrets will automatically be synced from the source location when changes occur. Disable to enforce manual syncing only.
+            - **Disable Secret Deletion**: If enabled, Infisical will not remove secrets from the sync destination. Enable this option if you intend to manage some secrets manually outside of Infisical.
+
+        6. Configure the **Details** of your Heroku Sync, then click **Next**.
+        ![Configure Details](/images/secret-syncs/heroku/heroku-details.png)
+
+            - **Name**: The name of your sync. Must be slug-friendly.
+            - **Description**: An optional description for your sync.
+
+        7. Review your Heroku Sync configuration, then click **Create Sync**.
+        ![Confirm Configuration](/images/secret-syncs/heroku/heroku-review.png)
+
+        8. If enabled, your Heroku Sync will begin syncing your secrets to the destination endpoint.
+        ![Sync Secrets](/images/secret-syncs/heroku/heroku-created.png)
+
+    </Tab>
+    <Tab title="API">
+        To create a **Heroku Sync**, make an API request to the [Create Heroku Sync](/api-reference/endpoints/secret-syncs/heroku/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+        --url https://app.infisical.com/api/v1/secret-syncs/heroku \
+        --header 'Content-Type: application/json' \
+        --data '{
+            "name": "my-heroku-sync",
+            "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "description": "an example sync",
+            "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+            "environment": "dev",
+            "secretPath": "/my-secrets",
+            "isEnabled": true,
+            "syncOptions": {
+                "initialSyncBehavior": "overwrite-destination",
+                "disableSecretDeletion": true
+            },
+            "destinationConfig": {
+                "app": "8dd25736052a4b50",
+                "appName": "my-app",
+            }
+        }'
+        ```
+
+        ### Sample response
+
+        ```bash Response
+        {
+            "secretSync": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "name": "my-heroku-sync",
+                "description": "an example sync",
+                "isEnabled": true,
+                "version": 1,
+                "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "createdAt": "2023-11-07T05:31:56Z",
+                "updatedAt": "2023-11-07T05:31:56Z",
+                "syncStatus": "succeeded",
+                "lastSyncJobId": "123",
+                "lastSyncMessage": null,
+                "lastSyncedAt": "2023-11-07T05:31:56Z",
+                "importStatus": null,
+                "lastImportJobId": null,
+                "lastImportMessage": null,
+                "lastImportedAt": null,
+                "removeStatus": null,
+                "lastRemoveJobId": null,
+                "lastRemoveMessage": null,
+                "lastRemovedAt": null,
+                "syncOptions": {
+                    "initialSyncBehavior": "overwrite-destination"
+                },
+                "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "connection": {
+                    "app": "heroku",
+                    "name": "my-heroku-connection",
+                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
+                },
+                "environment": {
+                    "slug": "dev",
+                    "name": "Development",
+                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
+                },
+                "folder": {
+                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                    "path": "/my-secrets"
+                },
+                "destination": "heroku",
+                "destinationConfig": {
+                    "app": "8dd25736052a4b50",
+                    "appName": "my-app"
+                }
+            }
+        }
+        ```
+    </Tab>
+</Tabs>
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -1,6 +1,6 @@
 {
  "name": "Infisical",
-  "openapi": "https://app.infisical.com/api/docs/json",
+  "openapi": "http://localhost:8080/api/docs/json",
  "logo": {
    "dark": "/logo/dark.svg",
    "light": "/logo/light.svg",
@@ -507,6 +507,7 @@
            "integrations/app-connections/github",
            "integrations/app-connections/github-radar",
            "integrations/app-connections/hashicorp-vault",
+            "integrations/app-connections/heroku",
            "integrations/app-connections/humanitec",
            "integrations/app-connections/ldap",
            "integrations/app-connections/mssql",
@@ -540,6 +541,7 @@
            "integrations/secret-syncs/gcp-secret-manager",
            "integrations/secret-syncs/github",
            "integrations/secret-syncs/hashicorp-vault",
+            "integrations/secret-syncs/heroku",
            "integrations/secret-syncs/humanitec",
            "integrations/secret-syncs/oci-vault",
            "integrations/secret-syncs/teamcity",
@@ -1310,6 +1312,18 @@
                "api-reference/endpoints/app-connections/hashicorp-vault/delete"
              ]
            },
+            {
+              "group": "Heroku",
+              "pages": [
+                "api-reference/endpoints/app-connections/heroku/list",
+                "api-reference/endpoints/app-connections/heroku/available",
+                "api-reference/endpoints/app-connections/heroku/get-by-id",
+                "api-reference/endpoints/app-connections/heroku/get-by-name",
+                "api-reference/endpoints/app-connections/heroku/create",
+                "api-reference/endpoints/app-connections/heroku/update",
+                "api-reference/endpoints/app-connections/heroku/delete"
+              ]
+            },
            {
              "group": "Humanitec",
              "pages": [
@@ -1600,6 +1614,19 @@
                "api-reference/endpoints/secret-syncs/hashicorp-vault/remove-secrets"
              ]
            },
+            {
+              "group": "Heroku",
+              "pages": [
+                "api-reference/endpoints/secret-syncs/heroku/list",
+                "api-reference/endpoints/secret-syncs/heroku/get-by-id",
+                "api-reference/endpoints/secret-syncs/heroku/get-by-name",
+                "api-reference/endpoints/secret-syncs/heroku/create",
+                "api-reference/endpoints/secret-syncs/heroku/update",
+                "api-reference/endpoints/secret-syncs/heroku/delete",
+                "api-reference/endpoints/secret-syncs/heroku/sync-secrets",
+                "api-reference/endpoints/secret-syncs/heroku/remove-secrets"
+              ]
+            },
            {
              "group": "Humanitec",
              "pages": [