feat(secret-sync): TeamCity App Connection & Secret Sync

2026-09-22 13:39:35 +00:00 · 2025-04-23 17:58:59 -04:00
parent 4e10f51e50
commit d3ee30f5e6
91 changed files with 1515 additions and 53 deletions
--- a/docs/api-reference/endpoints/app-connections/teamcity/available.mdx
+++ b/docs/api-reference/endpoints/app-connections/teamcity/available.mdx
@@ -0,0 +1,4 @@
+---
+title: "Available"
+openapi: "GET /api/v1/app-connections/teamcity/available"
+---
--- a/docs/api-reference/endpoints/app-connections/teamcity/create.mdx
+++ b/docs/api-reference/endpoints/app-connections/teamcity/create.mdx
@@ -0,0 +1,9 @@
+---
+title: "Create"
+openapi: "POST /api/v1/app-connections/teamcity"
+---
+
+<Note>
+    Check out the configuration docs for [TeamCity Connections](/integrations/app-connections/teamcity) to learn how to obtain
+    the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/app-connections/teamcity/delete.mdx
+++ b/docs/api-reference/endpoints/app-connections/teamcity/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/app-connections/teamcity/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/teamcity/get-by-id.mdx
+++ b/docs/api-reference/endpoints/app-connections/teamcity/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/app-connections/teamcity/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/teamcity/get-by-name.mdx
+++ b/docs/api-reference/endpoints/app-connections/teamcity/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/app-connections/teamcity/connection-name/{connectionName}"
+---
--- a/docs/api-reference/endpoints/app-connections/teamcity/list.mdx
+++ b/docs/api-reference/endpoints/app-connections/teamcity/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/app-connections/teamcity"
+---
--- a/docs/api-reference/endpoints/app-connections/teamcity/update.mdx
+++ b/docs/api-reference/endpoints/app-connections/teamcity/update.mdx
@@ -0,0 +1,9 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/app-connections/teamcity/{connectionId}"
+---
+
+<Note>
+    Check out the configuration docs for [TeamCity Connections](/integrations/app-connections/teamcity) to learn how to obtain
+    the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/secret-syncs/teamcity/create.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/teamcity/create.mdx
@@ -0,0 +1,4 @@
+---
+title: "Create"
+openapi: "POST /api/v1/secret-syncs/teamcity"
+---
--- a/docs/api-reference/endpoints/secret-syncs/teamcity/delete.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/teamcity/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/secret-syncs/teamcity/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/teamcity/get-by-id.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/teamcity/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/secret-syncs/teamcity/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/teamcity/get-by-name.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/teamcity/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/secret-syncs/teamcity/sync-name/{syncName}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/teamcity/import-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/teamcity/import-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Import Secrets"
+openapi: "POST /api/v1/secret-syncs/teamcity/{syncId}/import-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/teamcity/list.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/teamcity/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/secret-syncs/teamcity"
+---
--- a/docs/api-reference/endpoints/secret-syncs/teamcity/remove-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/teamcity/remove-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Remove Secrets"
+openapi: "POST /api/v1/secret-syncs/teamcity/{syncId}/remove-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/teamcity/sync-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/teamcity/sync-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Sync Secrets"
+openapi: "POST /api/v1/secret-syncs/teamcity/{syncId}/sync-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/teamcity/update.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/teamcity/update.mdx
@@ -0,0 +1,4 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/secret-syncs/teamcity/{syncId}"
+---
--- a/docs/images/app-connections/general/add-connection.png
+++ b/docs/images/app-connections/general/add-connection.png
--- a/docs/images/app-connections/teamcity/teamcity-app-connection-created.png
+++ b/docs/images/app-connections/teamcity/teamcity-app-connection-created.png
--- a/docs/images/app-connections/teamcity/teamcity-app-connection-modal.png
+++ b/docs/images/app-connections/teamcity/teamcity-app-connection-modal.png
--- a/docs/images/app-connections/teamcity/teamcity-app-connection-option.png
+++ b/docs/images/app-connections/teamcity/teamcity-app-connection-option.png
--- a/docs/images/app-connections/teamcity/teamcity-main-page.png
+++ b/docs/images/app-connections/teamcity/teamcity-main-page.png
--- a/docs/images/app-connections/teamcity/teamcity-token-copy.png
+++ b/docs/images/app-connections/teamcity/teamcity-token-copy.png
--- a/docs/images/app-connections/teamcity/teamcity-token-created.png
+++ b/docs/images/app-connections/teamcity/teamcity-token-created.png
--- a/docs/images/app-connections/teamcity/teamcity-token-page.png
+++ b/docs/images/app-connections/teamcity/teamcity-token-page.png
--- a/docs/images/app-connections/teamcity/teamcity-token-popup.png
+++ b/docs/images/app-connections/teamcity/teamcity-token-popup.png
--- a/docs/images/secret-syncs/general/secret-sync-tab.png
+++ b/docs/images/secret-syncs/general/secret-sync-tab.png
--- a/docs/images/secret-syncs/teamcity/select-teamcity-option.png
+++ b/docs/images/secret-syncs/teamcity/select-teamcity-option.png
--- a/docs/images/secret-syncs/teamcity/teamcity-sync-created.png
+++ b/docs/images/secret-syncs/teamcity/teamcity-sync-created.png
--- a/docs/images/secret-syncs/teamcity/teamcity-sync-destination.png
+++ b/docs/images/secret-syncs/teamcity/teamcity-sync-destination.png
--- a/docs/images/secret-syncs/teamcity/teamcity-sync-details.png
+++ b/docs/images/secret-syncs/teamcity/teamcity-sync-details.png
--- a/docs/images/secret-syncs/teamcity/teamcity-sync-options.png
+++ b/docs/images/secret-syncs/teamcity/teamcity-sync-options.png
--- a/docs/images/secret-syncs/teamcity/teamcity-sync-review.png
+++ b/docs/images/secret-syncs/teamcity/teamcity-sync-review.png
--- a/docs/images/secret-syncs/teamcity/teamcity-sync-source.png
+++ b/docs/images/secret-syncs/teamcity/teamcity-sync-source.png
--- a/docs/integrations/app-connections/teamcity.mdx
+++ b/docs/integrations/app-connections/teamcity.mdx
@@ -0,0 +1,108 @@
+---
+title: "TeamCity Connection"
+description: "Learn how to configure a TeamCity Connection for Infisical."
+---
+
+Infisical supports connecting to TeamCity using an Access Token to securely sync your secrets to TeamCity.
+
+## Setup TeamCity Connection in Infisical
+
+<Steps>
+    <Step title="Navigate to your profile on TeamCity">
+        Navigate to the TeamCity **Profile** page by clicking on your profile icon in the bottom-left corner.
+        ![TeamCity Main Page](/images/app-connections/teamcity/teamcity-main-page.png)
+    </Step>
+    <Step title="Select Access Tokens Tab">
+        Select the **Access Tokens** tab from the left sidebar navigation menu.
+        ![TeamCity Token Page](/images/app-connections/teamcity/teamcity-token-page.png)
+    </Step>
+    <Step title="Create the Access Token">
+        Click the **Create access token** button and provide a name for your token (e.g., "Infisical Integration"). You may set an expiration date or leave it blank for no expiry.
+        The permission scope can either be **Same as current user** or **Limit per project**. If you're choosing **Limit per project**, make sure you select the relevant project and enable the **View build configuration settings** and **Edit project** permissions.
+        <Note>
+            Setting your permission scope to **Same as current user** will allow your integration to access multiple projects as long as the current user has read and write access to them.
+        </Note>
+        <Note>
+            Setting your permission scope to **Limit per project** requires the **View build configuration settings** and **Edit project** permissions.
+        </Note>
+        ![TeamCity Token Popup](/images/app-connections/teamcity/teamcity-token-popup.png)
+    </Step>
+    <Step title="Copy the Access Token">
+        After creation, a modal with the API token will be displayed. Copy this token immediately and store it securely, as you won't be able to view it again after closing this dialog.
+        ![TeamCity Token Copy Popup](/images/app-connections/teamcity/teamcity-token-copy.png)
+    </Step>
+    <Step title="Token Created">
+        You should now see your newly created token in the list of access tokens.
+        ![TeamCity Token Created](/images/app-connections/teamcity/teamcity-token-created.png)
+    </Step>
+    <Step title="Setup Vercel Connection in Infisical">
+        <Tabs>
+            <Tab title="Infisical UI">
+                1. Navigate to App Connections
+
+                    In your Infisical dashboard, go to **Organization Settings** and select the [**App Connections**](https://app.infisical.com/organization/app-connections) tab.
+                    ![App Connections Tab](/images/app-connections/general/add-connection.png)
+                2. Add Connection
+
+                    Click the **+ Add Connection** button and select the **TeamCity Connection** option from the available integrations.
+                    ![Select TeamCity Connection](/images/app-connections/teamcity/teamcity-app-connection-option.png)
+                3. Fill the TeamCity Connection Modal
+
+                    Complete the TeamCity Connection form by entering:
+                    - A descriptive name for the connection
+                    - The Access Token you generated in steps 3-4
+                    - The URL of your TeamCity instance
+                    - An optional description for future reference
+
+                    ![TeamCity Connection Modal](/images/app-connections/teamcity/teamcity-app-connection-modal.png)
+                4. Connection Created
+
+                    After clicking Create, your **TeamCity Connection** is established and ready to use with your Infisical projects.
+                    ![TeamCity Connection Created](/images/app-connections/teamcity/teamcity-app-connection-created.png)
+            </Tab>
+            <Tab title="API">
+                To create a TeamCity Connection, make an API request to the [Create TeamCity
+                Connection](/api-reference/endpoints/app-connections/teamcity/create) API endpoint.
+
+                ### Sample request
+
+                ```bash Request
+                curl    --request POST \
+                        --url https://app.infisical.com/api/v1/app-connections/teamcity \
+                        --header 'Content-Type: application/json' \
+                        --data '{
+                            "name": "my-teamcity-connection",
+                            "method": "access-token",
+                            "credentials": {
+                                "accessToken": "...",
+                                "instanceUrl": "https://yourcompany.teamcity.com"
+                            }
+                        }'
+                ```
+
+                ### Sample response
+
+                ```bash Response
+                {
+                  "appConnection": {
+                    "id": "e5d18aca-86f7-4026-a95e-efb8aeb0d8e6",
+                    "name": "my-teamcity-connection",
+                    "description": null,
+                    "version": 1,
+                    "orgId": "6f03caa1-a5de-43ce-b127-95a145d3464c",
+                    "createdAt": "2025-04-23T19:46:34.831Z",
+                    "updatedAt": "2025-04-23T19:46:34.831Z",
+                    "isPlatformManagedCredentials": false,
+                    "credentialsHash": "7c2d371dec195f82a6a0d5b41c970a229cfcaf88e894a5b6395e2dbd0280661f",
+                    "app": "teamcity",
+                    "method": "access-token",
+                    "credentials": {
+                      "instanceUrl": "https://yourcompany.teamcity.com"
+                    }
+                  }
+                }
+                ```
+            </Tab>
+        </Tabs>
+    </Step>
+</Steps>
--- a/docs/integrations/secret-syncs/teamcity.mdx
+++ b/docs/integrations/secret-syncs/teamcity.mdx
@@ -0,0 +1,147 @@
+---
+title: "TeamCity Sync"
+description: "Learn how to configure a TeamCity Sync for Infisical."
+---
+
+**Prerequisites:**
+
+        - Set up and add secrets to [Infisical Cloud](https://app.infisical.com)
+        - Create a [TeamCity Connection](/integrations/app-connections/teamcity) with the required **Secret Sync** permissions
+
+<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 **TeamCity** option.
+        ![Select TeamCity](/images/secret-syncs/teamcity/select-teamcity-option.png)
+
+        3. Configure the **Source** from where secrets should be retrieved, then click **Next**.
+        ![Configure Source](/images/secret-syncs/teamcity/teamcity-sync-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/teamcity/teamcity-sync-destination.png)
+
+            - **TeamCity Connection**: The TeamCity Connection to authenticate with.
+            - **Project**: The TeamCity project to sync secrets to.
+            - **Build Configuration**: The build configuration to sync secrets to.
+
+            <Note>
+                Not including a Build Configuration will sync secrets to the entire project.
+            </Note>
+
+        5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
+        ![Configure Options](/images/secret-syncs/teamcity/teamcity-sync-options.png)
+
+            - **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync.
+                - **Overwrite Destination Secrets**: Removes any secrets at the destination endpoint not present in Infisical.
+                - **Import Secrets (Prioritize Infisical)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Infisical over TeamCity when keys conflict.
+                - **Import Secrets (Prioritize TeamCity)**: Imports secrets from the destination endpoint before syncing, prioritizing values from TeamCity over Infisical when keys conflict.
+            - **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 TeamCity Sync, then click **Next**.
+        ![Configure Details](/images/secret-syncs/teamcity/teamcity-sync-details.png)
+
+            - **Name**: The name of your sync. Must be slug-friendly.
+            - **Description**: An optional description for your sync.
+
+        7. Review your TeamCity Sync configuration, then click **Create Sync**.
+        ![Confirm Configuration](/images/secret-syncs/teamcity/teamcity-sync-review.png)
+
+        8. If enabled, your TeamCity Sync will begin syncing your secrets to the destination endpoint.
+        ![Sync Secrets](/images/secret-syncs/teamcity/teamcity-sync-created.png)
+
+    </Tab>
+    <Tab title="API">
+        To create a **TeamCity Sync**, make an API request to the [Create TeamCity Sync](/api-reference/endpoints/secret-syncs/teamcity/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+        --url https://app.infisical.com/api/v1/secret-syncs/teamcity \
+        --header 'Content-Type: application/json' \
+        --data '{
+            "name": "my-teamcity-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"
+            },
+            "destinationConfig": {
+                "project": "TestProject",
+                "buildConfig": "TestBuildConfig"
+            }
+        }'
+        ```
+
+        <Note>
+          The **Project** and **Build Config** parameters must use project and build configuration IDs, not their names.
+        </Note>
+
+        ### Sample response
+
+        ```bash Response
+        {
+            "secretSync": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "name": "my-teamcity-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": "teamcity",
+                    "name": "my-teamcity-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": "teamcity",
+                "destinationConfig": {
+                    "project": "TestProject",
+                    "buildConfig": "TestBuildConfig"
+                }
+            }
+        }
+        ```
+    </Tab>
+</Tabs>
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -428,7 +428,8 @@
            "integrations/app-connections/postgres",
            "integrations/app-connections/terraform-cloud",
            "integrations/app-connections/vercel",
-            "integrations/app-connections/windmill"
+            "integrations/app-connections/windmill",
+            "integrations/app-connections/teamcity"
          ]
        }
      ]
@@ -451,7 +452,8 @@
            "integrations/secret-syncs/humanitec",
            "integrations/secret-syncs/terraform-cloud",
            "integrations/secret-syncs/vercel",
-            "integrations/secret-syncs/windmill"
+            "integrations/secret-syncs/windmill",
+            "integrations/secret-syncs/teamcity"
          ]
        }
      ]
@@ -558,9 +560,7 @@
    },
    {
      "group": "Others",
-      "pages": [
-        "integrations/external/backstage"
-      ]
+      "pages": ["integrations/external/backstage"]
    },
    {
      "group": "",
@@ -1072,6 +1072,18 @@
                "api-reference/endpoints/app-connections/windmill/update",
                "api-reference/endpoints/app-connections/windmill/delete"
              ]
+            },
+            {
+              "group": "TeamCity",
+              "pages": [
+                "api-reference/endpoints/app-connections/teamcity/list",
+                "api-reference/endpoints/app-connections/teamcity/available",
+                "api-reference/endpoints/app-connections/teamcity/get-by-id",
+                "api-reference/endpoints/app-connections/teamcity/get-by-name",
+                "api-reference/endpoints/app-connections/teamcity/create",
+                "api-reference/endpoints/app-connections/teamcity/update",
+                "api-reference/endpoints/app-connections/teamcity/delete"
+              ]
            }
          ]
        },
@@ -1242,6 +1254,20 @@
                "api-reference/endpoints/secret-syncs/windmill/import-secrets",
                "api-reference/endpoints/secret-syncs/windmill/remove-secrets"
              ]
+            },
+            {
+              "group": "TeamCity",
+              "pages": [
+                "api-reference/endpoints/secret-syncs/teamcity/list",
+                "api-reference/endpoints/secret-syncs/teamcity/get-by-id",
+                "api-reference/endpoints/secret-syncs/teamcity/get-by-name",
+                "api-reference/endpoints/secret-syncs/teamcity/create",
+                "api-reference/endpoints/secret-syncs/teamcity/update",
+                "api-reference/endpoints/secret-syncs/teamcity/delete",
+                "api-reference/endpoints/secret-syncs/teamcity/sync-secrets",
+                "api-reference/endpoints/secret-syncs/teamcity/import-secrets",
+                "api-reference/endpoints/secret-syncs/teamcity/remove-secrets"
+              ]
            }
          ]
        },