docs

2026-01-10 07:58:15 -05:00 · 2025-05-22 19:57:15 -04:00
parent a64f8ac776
commit 6648397a64
34 changed files with 386 additions and 0 deletions
--- a/docs/api-reference/endpoints/app-connections/1password/available.mdx
+++ b/docs/api-reference/endpoints/app-connections/1password/available.mdx
@@ -0,0 +1,4 @@
+---
+title: "Available"
+openapi: "GET /api/v1/app-connections/1password/available"
+---
--- a/docs/api-reference/endpoints/app-connections/1password/create.mdx
+++ b/docs/api-reference/endpoints/app-connections/1password/create.mdx
@@ -0,0 +1,8 @@
+---
+title: "Create"
+openapi: "POST /api/v1/app-connections/1password"
+---
+
+<Note>
+    Check out the configuration docs for [1Password Connections](/integrations/app-connections/1password) to learn how to obtain the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/app-connections/1password/delete.mdx
+++ b/docs/api-reference/endpoints/app-connections/1password/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/app-connections/1password/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/1password/get-by-id.mdx
+++ b/docs/api-reference/endpoints/app-connections/1password/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/app-connections/1password/{connectionId}"
+---
--- a/docs/api-reference/endpoints/app-connections/1password/get-by-name.mdx
+++ b/docs/api-reference/endpoints/app-connections/1password/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/app-connections/1password/connection-name/{connectionName}"
+---
--- a/docs/api-reference/endpoints/app-connections/1password/list.mdx
+++ b/docs/api-reference/endpoints/app-connections/1password/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/app-connections/1password"
+---
--- a/docs/api-reference/endpoints/app-connections/1password/update.mdx
+++ b/docs/api-reference/endpoints/app-connections/1password/update.mdx
@@ -0,0 +1,8 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/app-connections/1password/{connectionId}"
+---
+
+<Note>
+    Check out the configuration docs for [1Password Connections](/integrations/app-connections/1password) to learn how to obtain the required credentials.
+</Note>
--- a/docs/api-reference/endpoints/secret-syncs/1password/create.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/1password/create.mdx
@@ -0,0 +1,4 @@
+---
+title: "Create"
+openapi: "POST /api/v1/secret-syncs/1password"
+---
--- a/docs/api-reference/endpoints/secret-syncs/1password/delete.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/1password/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: "Delete"
+openapi: "DELETE /api/v1/secret-syncs/1password/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/1password/get-by-id.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/1password/get-by-id.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by ID"
+openapi: "GET /api/v1/secret-syncs/1password/{syncId}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/1password/get-by-name.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/1password/get-by-name.mdx
@@ -0,0 +1,4 @@
+---
+title: "Get by Name"
+openapi: "GET /api/v1/secret-syncs/1password/sync-name/{syncName}"
+---
--- a/docs/api-reference/endpoints/secret-syncs/1password/import-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/1password/import-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Import Secrets"
+openapi: "POST /api/v1/secret-syncs/1password/{syncId}/import-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/1password/list.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/1password/list.mdx
@@ -0,0 +1,4 @@
+---
+title: "List"
+openapi: "GET /api/v1/secret-syncs/1password"
+---
--- a/docs/api-reference/endpoints/secret-syncs/1password/remove-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/1password/remove-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Remove Secrets"
+openapi: "POST /api/v1/secret-syncs/1password/{syncId}/remove-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/1password/sync-secrets.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/1password/sync-secrets.mdx
@@ -0,0 +1,4 @@
+---
+title: "Sync Secrets"
+openapi: "POST /api/v1/secret-syncs/1password/{syncId}/sync-secrets"
+---
--- a/docs/api-reference/endpoints/secret-syncs/1password/update.mdx
+++ b/docs/api-reference/endpoints/secret-syncs/1password/update.mdx
@@ -0,0 +1,4 @@
+---
+title: "Update"
+openapi: "PATCH /api/v1/secret-syncs/1password/{syncId}"
+---
--- a/docs/images/app-connections/1password/app-connection-created.png
+++ b/docs/images/app-connections/1password/app-connection-created.png
--- a/docs/images/app-connections/1password/app-connection-modal.png
+++ b/docs/images/app-connections/1password/app-connection-modal.png
--- a/docs/images/app-connections/1password/app-connection-option.png
+++ b/docs/images/app-connections/1password/app-connection-option.png
--- a/docs/images/app-connections/1password/click-connect-server.png
+++ b/docs/images/app-connections/1password/click-connect-server.png
--- a/docs/images/app-connections/1password/configure-connect-server.png
+++ b/docs/images/app-connections/1password/configure-connect-server.png
--- a/docs/images/app-connections/1password/deploy-server.png
+++ b/docs/images/app-connections/1password/deploy-server.png
--- a/docs/images/app-connections/1password/developer-page.png
+++ b/docs/images/app-connections/1password/developer-page.png
--- a/docs/images/app-connections/1password/set-up-access-token.png
+++ b/docs/images/app-connections/1password/set-up-access-token.png
--- a/docs/images/secret-syncs/1password/configure-destination.png
+++ b/docs/images/secret-syncs/1password/configure-destination.png
--- a/docs/images/secret-syncs/1password/configure-details.png
+++ b/docs/images/secret-syncs/1password/configure-details.png
--- a/docs/images/secret-syncs/1password/configure-source.png
+++ b/docs/images/secret-syncs/1password/configure-source.png
--- a/docs/images/secret-syncs/1password/configure-sync-options.png
+++ b/docs/images/secret-syncs/1password/configure-sync-options.png
--- a/docs/images/secret-syncs/1password/review-configuration.png
+++ b/docs/images/secret-syncs/1password/review-configuration.png
--- a/docs/images/secret-syncs/1password/select-option.png
+++ b/docs/images/secret-syncs/1password/select-option.png
--- a/docs/images/secret-syncs/1password/sync-created.png
+++ b/docs/images/secret-syncs/1password/sync-created.png
--- a/docs/integrations/app-connections/1password.mdx
+++ b/docs/integrations/app-connections/1password.mdx
@@ -0,0 +1,123 @@
+---
+title: "1Password Connection"
+description: "Learn how to configure a 1Password Connection for Infisical."
+---
+
+Infisical supports the use of [Service Accounts](https://developer.1password.com/docs/service-accounts) to connect with 1Password.
+
+## Setup 1Password Connect Server
+
+<Note>
+    If you already have a Connect Server for your vault you may skip this step.
+</Note>
+
+<Steps>
+    <Step title="Navigate to 'Developer' and click 'Other'">
+        ![Developer Page](/images/app-connections/1password/developer-page.png)
+    </Step>
+    <Step title="Select 'Connect Server'">
+        ![Click Connect Server](/images/app-connections/1password/click-connect-server.png)
+    </Step>
+    <Step title="Configure Connect Server">
+        1. Input a name for you Connect Server
+        2. Click "Choose Vaults" and select the vaults you want to connect
+        3. For each selected vault, click **Edit Access** and **Enable All**
+        4. Click "Add Environment"
+
+        ![Configure Connect Server](/images/app-connections/1password/configure-connect-server.png)
+    </Step>
+    <Step title="Configure Access Token">
+        1. Input a name and expiration for the token
+        2. Click "Choose Vaults" and select the vaults you want to connect
+        3. For each selected vault, click **Edit Access** and **Enable All**
+        4. Click "Issue Token"
+
+        ![Set Up Access Token](/images/app-connections/1password/set-up-access-token.png)
+    </Step>
+    <Step title="Deploy Connect Server">
+        Download the Credentials File and set up your Connect Server.
+
+        <Note>
+            Follow [this guide](https://developer.1password.com/docs/connect/get-started#step-2-deploy-1password-connect-server) to deploy a Connect Server.
+        </Note>
+
+        Make sure to save the **Access Token** for later use.
+
+        ![Deploy Server](/images/app-connections/1password/deploy-server.png)
+    </Step>
+</Steps>
+
+## Create 1Password Connection in Infisical
+
+<Tabs>
+    <Tab title="Infisical UI">
+        <Steps>
+            <Step title="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)
+            </Step>
+            <Step title="Select 1Password Connection">
+                Click the **+ Add Connection** button and select the **1Password Connection** option from the available integrations.
+
+                ![Select 1Password Connection](/images/app-connections/1password/app-connection-option.png)
+            </Step>
+            <Step title="Fill out the 1Password Connection Modal">
+                Complete the 1Password Connection form by entering:
+                - A descriptive name for the connection
+                - An optional description for future reference
+                - The URL at which your 1Password Connect Server instance is hosted
+                - The Access Token from earlier steps
+
+                ![1Password Connection Modal](/images/app-connections/1password/app-connection-modal.png)
+            </Step>
+            <Step title="Connection Created">
+                After clicking Create, your **1Password Connection** is established and ready to use with your Infisical projects.
+
+                ![1Password Connection Created](/images/app-connections/1password/app-connection-created.png)
+            </Step>
+        </Steps>
+    </Tab>
+    <Tab title="API">
+        To create an 1Password Connection, make an API request to the [Create 1Password Connection](/api-reference/endpoints/app-connections/1password/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+                --url https://app.infisical.com/api/v1/app-connections/1password \
+                --header 'Content-Type: application/json' \
+                --data '{
+                    "name": "my-1password-connection",
+                    "method": "access-key",
+                    "credentials": {
+                        "instanceUrl": "https://1pass.example.com",
+                        "apiToken": "[PRIVATE TOKEN]"
+                    }
+                }'
+        ```
+
+        ### Sample response
+
+        ```bash Response
+        {
+          "appConnection": {
+              "id": "e5d18aca-86f7-4026-a95e-efb8aeb0d8e6",
+              "name": "my-1password-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": "1password",
+              "method": "api-token",
+              "credentials": {
+                "instanceUrl": "https://1pass.example.com"
+              }
+          }
+        }
+        ```
+    </Tab>
+</Tabs>
--- a/docs/integrations/secret-syncs/1password.mdx
+++ b/docs/integrations/secret-syncs/1password.mdx
@@ -0,0 +1,163 @@
+---
+title: "1Password Sync"
+description: "Learn how to configure a 1Password Sync for Infisical."
+---
+
+**Prerequisites:**
+- Create an [1Password Connection](/integrations/app-connections/1password)
+
+<Tabs>
+    <Tab title="Infisical UI">
+        <Steps>
+            <Step title="Add Sync">
+                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)
+            </Step>
+            <Step title="Select '1Password'">
+                ![Select 1Password](/images/secret-syncs/1password/select-option.png)
+            </Step>
+            <Step title="Configure source">
+                Configure the **Source** from where secrets should be retrieved, then click **Next**.
+
+                ![Configure Source](/images/secret-syncs/1password/configure-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>
+            </Step>
+            <Step title="Configure destination">
+                Configure the **Destination** to where secrets should be deployed, then click **Next**.
+
+                ![Configure Destination](/images/secret-syncs/1password/configure-destination.png)
+
+                - **1Password Connection**: The 1Password Connection to authenticate with.
+                - **Vault**: The 1Password vault to sync secrets to.
+            </Step>
+            <Step title="Configure sync options">
+                Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
+
+                ![Configure Sync Options](/images/secret-syncs/1password/configure-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 1Password when keys conflict.
+                    - **Import Secrets (Prioritize 1Password)**: Imports secrets from the destination endpoint before syncing, prioritizing values from 1Password over Infisical when keys conflict.
+                - **Key Schema**: Template that determines how secret names are transformed when syncing, using `{{secretKey}}` as a placeholder for the original secret name.
+                <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.
+            </Step>
+            <Step title="Configure details">
+                Configure the **Details** of your 1Password Sync, then click **Next**.
+
+                ![Configure Details](/images/secret-syncs/1password/configure-details.png)
+
+                - **Name**: The name of your sync. Must be slug-friendly.
+                - **Description**: An optional description for your sync.
+            </Step>
+            <Step title="Review configuration">
+                Review your 1Password Sync configuration, then click **Create Sync**.
+
+                ![Review Configuration](/images/secret-syncs/1password/review-configuration.png)
+            </Step>
+            <Step title="Sync created">
+                If enabled, your 1Password Sync will begin syncing your secrets to the destination endpoint.
+
+                ![Sync Created](/images/secret-syncs/1password/sync-created.png)
+            </Step>
+        </Steps>
+    </Tab>
+    <Tab title="API">
+        To create an **1Password Sync**, make an API request to the [Create 1Password Sync](/api-reference/endpoints/secret-syncs/1password/create) API endpoint.
+
+        ### Sample request
+
+        ```bash Request
+        curl    --request POST \
+                --url https://app.infisical.com/api/v1/secret-syncs/1password \
+                --header 'Content-Type: application/json' \
+                --data '{
+                    "name": "my-1password-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":
+                        "vaultId": "..."
+                    }
+                }'
+        ```
+
+        ### Sample response
+
+        ```bash Response
+        {
+            "secretSync": {
+                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+                "name": "my-1password-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": "1password",
+                    "name": "my-1password-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": "1password",
+                "destinationConfig": {
+                  "vaultId": "..."
+                }
+            }
+        }
+        ```
+    </Tab>
+</Tabs>
+
+## FAQ
+
+<AccordionGroup>
+    <Accordion title="How are different 1Password item types treated?">
+        Infisical can only perform CRUD operations on the following item types:
+        - API Credentials
+    </Accordion>
+</AccordionGroup>
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -470,6 +470,7 @@
        {
          "group": "Connections",
          "pages": [
+            "integrations/app-connections/1password",
            "integrations/app-connections/auth0",
            "integrations/app-connections/aws",
            "integrations/app-connections/azure-app-configuration",
@@ -500,6 +501,7 @@
        {
          "group": "Syncs",
          "pages": [
+            "integrations/secret-syncs/1password",
            "integrations/secret-syncs/aws-parameter-store",
            "integrations/secret-syncs/aws-secrets-manager",
            "integrations/secret-syncs/azure-app-configuration",
@@ -1041,6 +1043,18 @@
          "pages": [
            "api-reference/endpoints/app-connections/list",
            "api-reference/endpoints/app-connections/options",
+            {
+              "group": "1Password",
+              "pages": [
+                "api-reference/endpoints/app-connections/1password/list",
+                "api-reference/endpoints/app-connections/1password/available",
+                "api-reference/endpoints/app-connections/1password/get-by-id",
+                "api-reference/endpoints/app-connections/1password/get-by-name",
+                "api-reference/endpoints/app-connections/1password/create",
+                "api-reference/endpoints/app-connections/1password/update",
+                "api-reference/endpoints/app-connections/1password/delete"
+              ]
+            },
            {
              "group": "Auth0",
              "pages": [
@@ -1276,6 +1290,20 @@
          "pages": [
            "api-reference/endpoints/secret-syncs/list",
            "api-reference/endpoints/secret-syncs/options",
+            {
+              "group": "1Password",
+              "pages": [
+                "api-reference/endpoints/secret-syncs/1password/list",
+                "api-reference/endpoints/secret-syncs/1password/get-by-id",
+                "api-reference/endpoints/secret-syncs/1password/get-by-name",
+                "api-reference/endpoints/secret-syncs/1password/create",
+                "api-reference/endpoints/secret-syncs/1password/update",
+                "api-reference/endpoints/secret-syncs/1password/delete",
+                "api-reference/endpoints/secret-syncs/1password/sync-secrets",
+                "api-reference/endpoints/secret-syncs/1password/import-secrets",
+                "api-reference/endpoints/secret-syncs/1password/remove-secrets"
+              ]
+            },
            {
              "group": "AWS Parameter Store",
              "pages": [