diff --git a/docs/api-reference/endpoints/app-connections/azure-devops/available.mdx b/docs/api-reference/endpoints/app-connections/azure-devops/available.mdx new file mode 100644 index 000000000..67390861d --- /dev/null +++ b/docs/api-reference/endpoints/app-connections/azure-devops/available.mdx @@ -0,0 +1,4 @@ +--- +title: "Available" +openapi: "GET /api/v1/app-connections/azure-devops/available" +--- diff --git a/docs/api-reference/endpoints/app-connections/azure-devops/create.mdx b/docs/api-reference/endpoints/app-connections/azure-devops/create.mdx new file mode 100644 index 000000000..cf4d4e229 --- /dev/null +++ b/docs/api-reference/endpoints/app-connections/azure-devops/create.mdx @@ -0,0 +1,10 @@ +--- +title: "Create" +openapi: "POST /api/v1/app-connections/azure-devops" +--- + + + Azure DevOps Connections must be created through the Infisical UI if you are using OAuth. + Check out the configuration docs for [Azure DevOps Connections](/integrations/app-connections/azure-devops) for a step-by-step + guide. + \ No newline at end of file diff --git a/docs/api-reference/endpoints/app-connections/azure-devops/delete.mdx b/docs/api-reference/endpoints/app-connections/azure-devops/delete.mdx new file mode 100644 index 000000000..f6c2f9951 --- /dev/null +++ b/docs/api-reference/endpoints/app-connections/azure-devops/delete.mdx @@ -0,0 +1,4 @@ +--- +title: "Delete" +openapi: "DELETE /api/v1/app-connections/azure-devops/{connectionId}" +--- diff --git a/docs/api-reference/endpoints/app-connections/azure-devops/get-by-id.mdx b/docs/api-reference/endpoints/app-connections/azure-devops/get-by-id.mdx new file mode 100644 index 000000000..ac411a2bd --- /dev/null +++ b/docs/api-reference/endpoints/app-connections/azure-devops/get-by-id.mdx @@ -0,0 +1,4 @@ +--- +title: "Get by ID" +openapi: "GET /api/v1/app-connections/azure-devops/{connectionId}" +--- diff --git a/docs/api-reference/endpoints/app-connections/azure-devops/get-by-name.mdx b/docs/api-reference/endpoints/app-connections/azure-devops/get-by-name.mdx new file mode 100644 index 000000000..17b29e405 --- /dev/null +++ b/docs/api-reference/endpoints/app-connections/azure-devops/get-by-name.mdx @@ -0,0 +1,4 @@ +--- +title: "Get by Name" +openapi: "GET /api/v1/app-connections/azure-devops/connection-name/{connectionName}" +--- diff --git a/docs/api-reference/endpoints/app-connections/azure-devops/list.mdx b/docs/api-reference/endpoints/app-connections/azure-devops/list.mdx new file mode 100644 index 000000000..89cd0a641 --- /dev/null +++ b/docs/api-reference/endpoints/app-connections/azure-devops/list.mdx @@ -0,0 +1,4 @@ +--- +title: "List" +openapi: "GET /api/v1/app-connections/azure-devops" +--- diff --git a/docs/api-reference/endpoints/app-connections/azure-devops/update.mdx b/docs/api-reference/endpoints/app-connections/azure-devops/update.mdx new file mode 100644 index 000000000..64b3f64cc --- /dev/null +++ b/docs/api-reference/endpoints/app-connections/azure-devops/update.mdx @@ -0,0 +1,10 @@ +--- +title: "Update" +openapi: "PATCH /api/v1/app-connections/azure-devops/{connectionId}" +--- + + + Azure DevOps Connections must be updated through the Infisical UI if you are using OAuth. + Check out the configuration docs for [Azure DevOps Connections](/integrations/app-connections/azure-devops) for a step-by-step + guide. + diff --git a/docs/api-reference/endpoints/secret-syncs/azure-devops/create.mdx b/docs/api-reference/endpoints/secret-syncs/azure-devops/create.mdx new file mode 100644 index 000000000..fb304bc33 --- /dev/null +++ b/docs/api-reference/endpoints/secret-syncs/azure-devops/create.mdx @@ -0,0 +1,4 @@ +--- +title: "Create" +openapi: "POST /api/v1/secret-syncs/azure-devops" +--- diff --git a/docs/api-reference/endpoints/secret-syncs/azure-devops/delete.mdx b/docs/api-reference/endpoints/secret-syncs/azure-devops/delete.mdx new file mode 100644 index 000000000..b57a08c66 --- /dev/null +++ b/docs/api-reference/endpoints/secret-syncs/azure-devops/delete.mdx @@ -0,0 +1,4 @@ +--- +title: "Delete" +openapi: "DELETE /api/v1/secret-syncs/azure-devops/{syncId}" +--- diff --git a/docs/api-reference/endpoints/secret-syncs/azure-devops/get-by-id.mdx b/docs/api-reference/endpoints/secret-syncs/azure-devops/get-by-id.mdx new file mode 100644 index 000000000..cd2fc2b40 --- /dev/null +++ b/docs/api-reference/endpoints/secret-syncs/azure-devops/get-by-id.mdx @@ -0,0 +1,4 @@ +--- +title: "Get by ID" +openapi: "GET /api/v1/secret-syncs/azure-devops/{syncId}" +--- diff --git a/docs/api-reference/endpoints/secret-syncs/azure-devops/get-by-name.mdx b/docs/api-reference/endpoints/secret-syncs/azure-devops/get-by-name.mdx new file mode 100644 index 000000000..ded315b46 --- /dev/null +++ b/docs/api-reference/endpoints/secret-syncs/azure-devops/get-by-name.mdx @@ -0,0 +1,4 @@ +--- +title: "Get by Name" +openapi: "GET /api/v1/secret-syncs/azure-devops/sync-name/{syncName}" +--- diff --git a/docs/api-reference/endpoints/secret-syncs/azure-devops/import-secrets.mdx b/docs/api-reference/endpoints/secret-syncs/azure-devops/import-secrets.mdx new file mode 100644 index 000000000..2429ebcb6 --- /dev/null +++ b/docs/api-reference/endpoints/secret-syncs/azure-devops/import-secrets.mdx @@ -0,0 +1,4 @@ +--- +title: "Import Secrets" +openapi: "POST /api/v1/secret-syncs/azure-devops/{syncId}/import-secrets" +--- diff --git a/docs/api-reference/endpoints/secret-syncs/azure-devops/list.mdx b/docs/api-reference/endpoints/secret-syncs/azure-devops/list.mdx new file mode 100644 index 000000000..d12e2bab7 --- /dev/null +++ b/docs/api-reference/endpoints/secret-syncs/azure-devops/list.mdx @@ -0,0 +1,4 @@ +--- +title: "List" +openapi: "GET /api/v1/secret-syncs/azure-devops" +--- diff --git a/docs/api-reference/endpoints/secret-syncs/azure-devops/remove-secrets.mdx b/docs/api-reference/endpoints/secret-syncs/azure-devops/remove-secrets.mdx new file mode 100644 index 000000000..b14b23fd5 --- /dev/null +++ b/docs/api-reference/endpoints/secret-syncs/azure-devops/remove-secrets.mdx @@ -0,0 +1,4 @@ +--- +title: "Remove Secrets" +openapi: "POST /api/v1/secret-syncs/azure-devops/{syncId}/remove-secrets" +--- diff --git a/docs/api-reference/endpoints/secret-syncs/azure-devops/sync-secrets.mdx b/docs/api-reference/endpoints/secret-syncs/azure-devops/sync-secrets.mdx new file mode 100644 index 000000000..97af04a5d --- /dev/null +++ b/docs/api-reference/endpoints/secret-syncs/azure-devops/sync-secrets.mdx @@ -0,0 +1,4 @@ +--- +title: "Sync Secrets" +openapi: "POST /api/v1/secret-syncs/azure-devops/{syncId}/sync-secrets" +--- diff --git a/docs/api-reference/endpoints/secret-syncs/azure-devops/update.mdx b/docs/api-reference/endpoints/secret-syncs/azure-devops/update.mdx new file mode 100644 index 000000000..0fb0e8f67 --- /dev/null +++ b/docs/api-reference/endpoints/secret-syncs/azure-devops/update.mdx @@ -0,0 +1,4 @@ +--- +title: "Update" +openapi: "PATCH /api/v1/secret-syncs/azure-devops/{syncId}" +--- diff --git a/docs/images/app-connections/azure/devops/devops-connection.png b/docs/images/app-connections/azure/devops/devops-connection.png new file mode 100644 index 000000000..b52bec7ab Binary files /dev/null and b/docs/images/app-connections/azure/devops/devops-connection.png differ diff --git a/docs/images/app-connections/azure/devops/fill-in-connection-details-oauth.png b/docs/images/app-connections/azure/devops/fill-in-connection-details-oauth.png new file mode 100644 index 000000000..a125139a1 Binary files /dev/null and b/docs/images/app-connections/azure/devops/fill-in-connection-details-oauth.png differ diff --git a/docs/images/app-connections/azure/devops/fill-in-connection-details-token.png b/docs/images/app-connections/azure/devops/fill-in-connection-details-token.png new file mode 100644 index 000000000..b78ca39fc Binary files /dev/null and b/docs/images/app-connections/azure/devops/fill-in-connection-details-token.png differ diff --git a/docs/images/app-connections/azure/devops/select-connection.png b/docs/images/app-connections/azure/devops/select-connection.png new file mode 100644 index 000000000..10867ea45 Binary files /dev/null and b/docs/images/app-connections/azure/devops/select-connection.png differ diff --git a/docs/images/integrations/azure-devops/app-api-permissions.png b/docs/images/integrations/azure-devops/app-api-permissions.png new file mode 100644 index 000000000..717bb8ddb Binary files /dev/null and b/docs/images/integrations/azure-devops/app-api-permissions.png differ diff --git a/docs/images/secret-syncs/azure-devops/devops-destination.png b/docs/images/secret-syncs/azure-devops/devops-destination.png new file mode 100644 index 000000000..16f506102 Binary files /dev/null and b/docs/images/secret-syncs/azure-devops/devops-destination.png differ diff --git a/docs/images/secret-syncs/azure-devops/devops-details.png b/docs/images/secret-syncs/azure-devops/devops-details.png new file mode 100644 index 000000000..f985e6f77 Binary files /dev/null and b/docs/images/secret-syncs/azure-devops/devops-details.png differ diff --git a/docs/images/secret-syncs/azure-devops/devops-options.png b/docs/images/secret-syncs/azure-devops/devops-options.png new file mode 100644 index 000000000..5571d7412 Binary files /dev/null and b/docs/images/secret-syncs/azure-devops/devops-options.png differ diff --git a/docs/images/secret-syncs/azure-devops/devops-review.png b/docs/images/secret-syncs/azure-devops/devops-review.png new file mode 100644 index 000000000..104c8d468 Binary files /dev/null and b/docs/images/secret-syncs/azure-devops/devops-review.png differ diff --git a/docs/images/secret-syncs/azure-devops/devops-source.png b/docs/images/secret-syncs/azure-devops/devops-source.png new file mode 100644 index 000000000..fa1779e87 Binary files /dev/null and b/docs/images/secret-syncs/azure-devops/devops-source.png differ diff --git a/docs/images/secret-syncs/azure-devops/devops-synced.png b/docs/images/secret-syncs/azure-devops/devops-synced.png new file mode 100644 index 000000000..e47282364 Binary files /dev/null and b/docs/images/secret-syncs/azure-devops/devops-synced.png differ diff --git a/docs/images/secret-syncs/azure-devops/select-azure-devops-option.png b/docs/images/secret-syncs/azure-devops/select-azure-devops-option.png new file mode 100644 index 000000000..f11192b36 Binary files /dev/null and b/docs/images/secret-syncs/azure-devops/select-azure-devops-option.png differ diff --git a/docs/integrations/app-connections/azure-devops.mdx b/docs/integrations/app-connections/azure-devops.mdx new file mode 100644 index 000000000..378ab2a4c --- /dev/null +++ b/docs/integrations/app-connections/azure-devops.mdx @@ -0,0 +1,137 @@ +--- +title: "Azure DevOps Connection" +description: "Learn how to configure an Azure DevOps Connection for Infisical." +--- + +Infisical currently supports two methods for connecting to Azure DevOps, which are OAuth and Azure DevOps API Token. + + + Using the Azure DevOps OAuth connection on a self-hosted instance of Infisical requires configuring an application in Azure + and registering your instance with it. + + **Prerequisites:** + + - Set up Azure. + + + + Navigate to Azure Active Directory > App registrations to create a new application. + + + Azure Active Directory is now Microsoft Entra ID. + + ![Azure devops](/images/integrations/azure-app-configuration/config-aad.png) + ![Azure devops](/images/integrations/azure-app-configuration/config-new-app.png) + + Create the application. As part of the form, set the **Redirect URI** to `https://your-domain.com/organization/app-connections/azure/oauth/callback`. + + The domain you defined in the Redirect URI should be equivalent to the `SITE_URL` configured in your Infisical instance. + + + ![Azure devops](/images/app-connections/azure/register-callback.png) + + + + For the Azure Connection to work with DevOps Pipelines, you need to assign the following permission to the application. + + #### Azure DevOps permissions + + Set the API permissions of the Azure application to include the following permissions: + - Azure DevOps + - `user_impersonation` + - `vso.project_write` + - `vso.variablegroups_manage` + - `vso.variablegroups_write` + + ![Azure devops](/images/integrations/azure-devops/app-api-permissions.png) + + + + + Obtain the **Application (Client) ID** and **Directory (Tenant) ID** (this will be used later in the Infisical connection) in Overview and generate a **Client Secret** in Certificate & secrets for your Azure application. + + ![Azure devops](../../images/app-connections/azure/client-secrets/config-credentials-1.png) + ![Azure devops](../../images/integrations/azure-app-configuration/config-credentials-2.png) + ![Azure devops](../../images/integrations/azure-app-configuration/config-credentials-3.png) + + Back in your Infisical instance, add two new environment variables for the credentials of your Azure application. + + - `INF_APP_CONNECTION_AZURE_CLIENT_ID`: The **Application (Client) ID** of your Azure application. + - `INF_APP_CONNECTION_AZURE_CLIENT_SECRET`: The **Client Secret** of your Azure application. + + Once added, restart your Infisical instance and use the Azure Client Secrets connection. + + + + + + + #### Create a new Azure DevOps personal access token (PAT) + You'll need to create a new personal access token (PAT) in order to authenticate Infisical with Azure DevOps. + + + ![integrations](../../images/integrations/azure-devops/overview-page.png) + + + Make sure the newly created token has Read/Write access to the Release scope. + ![integrations](../../images/integrations/azure-devops/create-new-token.png) + + + Please make sure that the token has access to the following scopes: Variable Groups _(read, create, & manage)_, Release _(read/write)_, Project and Team _(read)_, Service Connections _(read & query)_ + + + + Copy the newly created token as this will be used to authenticate Infisical with Azure DevOps. + ![integrations](../../images/integrations/azure-devops/new-token-created.png) + + + + +## Setup Azure Connection in Infisical + + + + Navigate to the **App Connections** tab on the **Organization Settings** page. ![App Connections + Tab](/images/app-connections/general/add-connection.png) + + + Select the **Azure Connection** option from the connection options modal. ![Select Azure Connection](/images/app-connections/azure/devops/select-connection.png) + + + + + + + + Fill in the **Tenant ID** field with the Directory (Tenant) ID you obtained in the previous step. And the organization name of the Azure DevOps organization you want to connect to. + ![Fill in Connection Details](/images/app-connections/azure/devops/fill-in-connection-details-oauth.png) + + + You can find the **Organization Name** on https://dev.azure.com/ + + + + You will then be redirected to Azure to grant Infisical access to your Azure account. Once granted, + you will be redirected back to Infisical's App Connections page. ![Azure Client Secrets + Authorization](/images/app-connections/azure/grant-access.png) + + + + + + + Fill in the **API Key** field with the API key you obtained in the previous step. And the organization name of the Azure DevOps organization you want to connect to. + ![Fill in Connection Details](/images/app-connections/azure/devops/fill-in-connection-details-token.png) + + + You can find the **Organization Name** on https://dev.azure.com/ + + + + + + + + Your **Azure Client Secrets Connection** is now available for use. ![Azure Client Secrets](/images/app-connections/azure/devops/devops-connection.png) + + diff --git a/docs/integrations/secret-syncs/azure-devops.mdx b/docs/integrations/secret-syncs/azure-devops.mdx new file mode 100644 index 000000000..802113484 --- /dev/null +++ b/docs/integrations/secret-syncs/azure-devops.mdx @@ -0,0 +1,143 @@ +--- +title: "Azure DevOps Sync" +description: "Learn how to configure a Azure DevOps Sync for Infisical." +--- + +**Prerequisites:** + + - Set up and add secrets to [Infisical Cloud](https://app.infisical.com) + - Create an [Azure DevOps Connection](/integrations/app-connections/azure-devops) + + + + 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 **Azure DevOps** option. + ![Select Azure DevOps](/images/secret-syncs/azure-devops/select-azure-devops-option.png) + + 3. Configure the **Source** from where secrets should be retrieved, then click **Next**. + ![Configure Source](/images/secret-syncs/azure-devops/devops-source.png) + + - **Environment**: The project environment to retrieve secrets from. + - **Secret Path**: The folder path to retrieve secrets from. + + + If you need to sync secrets from multiple folder locations, check out [secret imports](/documentation/platform/secret-reference#secret-imports). + + + 4. Configure the **Destination** to where secrets should be deployed, then click **Next**. + ![Configure Destination](/images/secret-syncs/azure-devops/devops-destination.png) + + - **Azure DevOps Connection**: The Azure DevOps Connection to authenticate with. + - **Project**: The Azure DevOps project to deploy secrets to. +

+ + 5. Configure the **Sync Options** to specify how secrets should be synced, then click **Next**. + ![Configure Options](/images/secret-syncs/azure-devops/devops-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. + + Azure Devops does not support importing secrets. + + - **Key Schema**: Template that determines how secret names are transformed when syncing, using `{{secretKey}}` as a placeholder for the original secret name. + - **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 Azure DevOps Sync, then click **Next**. + ![Configure Details](/images/secret-syncs/azure-devops/devops-details.png) + + - **Name**: The name of your sync. Must be slug-friendly. + - **Description**: An optional description for your sync. + + 7. Review your Azure DevOps Sync configuration, then click **Create Sync**. + ![Confirm Configuration](/images/secret-syncs/azure-devops/devops-review.png) + + 8. If enabled, your Azure DevOps Sync will begin syncing your secrets to the destination endpoint. + ![Sync Secrets](/images/secret-syncs/azure-devops/devops-synced.png) + + + + To create a **Azure DevOps Sync**, make an API request to the [Create Azure DevOps Sync](/api-reference/endpoints/secret-syncs/azure-devops/create) API endpoint. + + ### Sample request + + ```bash Request + curl --request POST \ + --url https://app.infisical.com/api/v1/secret-syncs/azure-devops \ + --header 'Content-Type: application/json' \ + --data '{ + "name": "my-devops-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": { + "devopsProjectId": "12345678-90ab-cdef-1234-567890abcdef", + "devopsProjectName": "example-project" + } + }' + ``` + + ### Sample response + + ```json Response + { + "secretSync": { + "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", + "name": "my-key-vault-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", + "keySchema": "PIPELINE_${key}", + "disableSecretDeletion": true + }, + "connection": { + "app": "azure-devops", + "name": "Production DevOps Organization", + "id": "8b92f5cc-3g77-5e80-6666-6ff57069385d" + }, + "environment": { + "slug": "production", + "name": "Production Environment", + "id": "4f16j9gg-7k11-9i23-2222-2jj91403729h" + }, + "folder": { + "id": "5a71e8dd-2f66-4d70-7777-7cc46958274c", + "path": "/devops/pipeline-secrets" + }, + "destination": "azure-devops", + "destinationConfig": { + "devopsProjectId": "12345678-90ab-cdef-1234-567890abcdef", + "devopsProjectName": "example-project" + } + } + } + ``` + + diff --git a/docs/mint.json b/docs/mint.json index 683455136..3fcce4fb1 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -492,6 +492,7 @@ "integrations/app-connections/aws", "integrations/app-connections/azure-app-configuration", "integrations/app-connections/azure-client-secrets", + "integrations/app-connections/azure-devops", "integrations/app-connections/azure-key-vault", "integrations/app-connections/camunda", "integrations/app-connections/databricks", @@ -524,6 +525,7 @@ "integrations/secret-syncs/aws-parameter-store", "integrations/secret-syncs/aws-secrets-manager", "integrations/secret-syncs/azure-app-configuration", + "integrations/secret-syncs/azure-devops", "integrations/secret-syncs/azure-key-vault", "integrations/secret-syncs/camunda", "integrations/secret-syncs/databricks", @@ -1176,6 +1178,18 @@ "api-reference/endpoints/app-connections/azure-client-secret/delete" ] }, + { + "group": "Azure DevOps", + "pages": [ + "api-reference/endpoints/app-connections/azure-devops/list", + "api-reference/endpoints/app-connections/azure-devops/available", + "api-reference/endpoints/app-connections/azure-devops/get-by-id", + "api-reference/endpoints/app-connections/azure-devops/get-by-name", + "api-reference/endpoints/app-connections/azure-devops/create", + "api-reference/endpoints/app-connections/azure-devops/update", + "api-reference/endpoints/app-connections/azure-devops/delete" + ] + }, { "group": "Azure Key Vault", "pages": [ @@ -1443,6 +1457,20 @@ "api-reference/endpoints/secret-syncs/azure-app-configuration/remove-secrets" ] }, + { + "group": "Azure DevOps", + "pages": [ + "api-reference/endpoints/secret-syncs/azure-devops/list", + "api-reference/endpoints/secret-syncs/azure-devops/get-by-id", + "api-reference/endpoints/secret-syncs/azure-devops/get-by-name", + "api-reference/endpoints/secret-syncs/azure-devops/create", + "api-reference/endpoints/secret-syncs/azure-devops/update", + "api-reference/endpoints/secret-syncs/azure-devops/delete", + "api-reference/endpoints/secret-syncs/azure-devops/sync-secrets", + "api-reference/endpoints/secret-syncs/azure-devops/import-secrets", + "api-reference/endpoints/secret-syncs/azure-devops/remove-secrets" + ] + }, { "group": "Azure Key Vault", "pages": [