From 6d7d1b74559e56716dc8d6f5c1d421a144334b04 Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Tue, 25 Feb 2025 13:29:45 -0800 Subject: [PATCH 1/3] Updating docs on users in Connect --- docs-v2/pages/connect/managed-auth/users.mdx | 61 +++++++++++++++++++- docs-v2/pages/connect/workflows.mdx | 4 ++ pnpm-lock.yaml | 3 +- 3 files changed, 64 insertions(+), 4 deletions(-) diff --git a/docs-v2/pages/connect/managed-auth/users.mdx b/docs-v2/pages/connect/managed-auth/users.mdx index 810f2fcd2ce7d..633edbe50941e 100644 --- a/docs-v2/pages/connect/managed-auth/users.mdx +++ b/docs-v2/pages/connect/managed-auth/users.mdx @@ -10,8 +10,65 @@ To view or delete your users' connected accounts: You'll see a list of all users, their connected accounts, and the option to delete any accounts from the UI. You can also retrieve and delete all your users via the API ([see the docs for reference](/connect/api/)). +## Connecting multiple accounts + +Users can connect multiple accounts for many different apps, or for the same app (e.g, I can connect my Notion and Gmail accounts, as well as accounts for multiple Slack workspaces). + +When retrieving account information [from the API](/connect/api/#accounts), you can filter by `external_user_id` and / or `app` to retrieve information for a specific user and / or app. + -Connect currently supports one connected account per user, app, environment combination. +When running workflows on behalf of an end user, right now you can only use a single account for a given app. If there are multiple connected accounts for that app, **Pipedream will use the most recently created account**. See more info on running workflows for your users [here](/connect/workflows). + + +## Deleting accounts + +You have several options for removing access in Pipedream, depending on whether you want to delete an entire user or just specific connected accounts. + +### Deleting individual connected accounts + +If you need more granular control, you can delete specific connected accounts instead of removing the entire user. + +#### From the UI +1. Open the project in Pipedream +2. Navigate to the **Users** tab under **Connect** +3. Find the user whose accounts you want to manage +4. View all connected accounts for that user in the expanded section +5. Click the **Delete** button next to the specific account you want to remove +6. Confirm the deletion when prompted + +This allows for more granular control over which integrated services remain accessible to your users. -So if user `abc-123` in your application connects their Slack account in `production`, then that same user connects a different Slack workspace (also in `production`), the first connected account will get overwritten in Pipedream and replaced by the second. +#### Via the API +You can delete specific connected accounts programmatically: + +```bash +curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/accounts/{account_id}" \ + -H "Authorization: Bearer {access_token}" +``` + +For complete API details including TypeScript and Node.js examples, [refer to the API reference](/connect/api/#delete-connected-account). + +### Deleting users + +When you delete a user, all of their connected accounts and deployed resources (if any) are permanently removed from Pipedream. There are two ways to delete users: + +#### From the UI +1. Open the project in Pipedream +2. Navigate to the **Users** tab under **Connect** +3. Locate the user you wish to delete +4. Click the **Delete User** button at the end of the row +5. Confirm the deletion in the dialog that appears + + +Deleting a user is permanent and cannot be undone. All connected accounts for this user will be permanently removed. + +#### Via the API +You can delete a user programmatically using the Pipedream API: + +```bash +curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/users/{external_user_id}" \ + -H "Authorization: Bearer {access_token}" +``` + +For complete API details including TypeScript and Node.js examples, see the [API reference](/connect/api/#delete-user). \ No newline at end of file diff --git a/docs-v2/pages/connect/workflows.mdx b/docs-v2/pages/connect/workflows.mdx index cdf7eff66b0a2..3023a5f9853c2 100644 --- a/docs-v2/pages/connect/workflows.mdx +++ b/docs-v2/pages/connect/workflows.mdx @@ -412,3 +412,7 @@ Pipedream Connect Error: Required account for hubspot not found for external use #### The external user ID to use during execution must be passed in the triggering event - You can't run a workflow on a timer for example, and look up the external user ID to use at runtime. - The external user ID must be passed in the triggering event, typically via [HTTP trigger](#invoke-the-workflow). + +#### Cannot use multiple accounts for the same app during a single execution +- If a user has multiple accounts for the same app (tied to a single external user), **Pipedream will use the most recently created account**. +- Learn about [managing connected accounts](/connect/managed-auth/users/) for your end users. \ No newline at end of file diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 4949a3b25dc09..cf88c0d8585ab 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -8168,8 +8168,7 @@ importers: specifier: ^1.1.1 version: 1.6.6 - components/needle: - specifiers: {} + components/needle: {} components/neetoinvoice: dependencies: From 4349f467b01b6892db29bae7b992a170da5e40d6 Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Tue, 25 Feb 2025 13:37:22 -0800 Subject: [PATCH 2/3] Update users.mdx --- docs-v2/pages/connect/managed-auth/users.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-v2/pages/connect/managed-auth/users.mdx b/docs-v2/pages/connect/managed-auth/users.mdx index 633edbe50941e..e3bc2e82c9e48 100644 --- a/docs-v2/pages/connect/managed-auth/users.mdx +++ b/docs-v2/pages/connect/managed-auth/users.mdx @@ -71,4 +71,4 @@ curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/users/{externa -H "Authorization: Bearer {access_token}" ``` -For complete API details including TypeScript and Node.js examples, see the [API reference](/connect/api/#delete-user). \ No newline at end of file +For complete API details including TypeScript and Node.js examples, see the [API reference](/connect/api/#delete-an-end-user). \ No newline at end of file From f58abf9edcf5c4673b4a4fd652589a537887671e Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Tue, 25 Feb 2025 13:41:11 -0800 Subject: [PATCH 3/3] Update users.mdx --- docs-v2/pages/connect/managed-auth/users.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs-v2/pages/connect/managed-auth/users.mdx b/docs-v2/pages/connect/managed-auth/users.mdx index e3bc2e82c9e48..39244519f7dc3 100644 --- a/docs-v2/pages/connect/managed-auth/users.mdx +++ b/docs-v2/pages/connect/managed-auth/users.mdx @@ -12,7 +12,7 @@ You'll see a list of all users, their connected accounts, and the option to dele ## Connecting multiple accounts -Users can connect multiple accounts for many different apps, or for the same app (e.g, I can connect my Notion and Gmail accounts, as well as accounts for multiple Slack workspaces). +Users can connect multiple accounts for many different apps, or for the same app (e.g., I can connect my Notion and Gmail accounts, as well as accounts for multiple Slack workspaces). When retrieving account information [from the API](/connect/api/#accounts), you can filter by `external_user_id` and / or `app` to retrieve information for a specific user and / or app. @@ -22,7 +22,7 @@ When running workflows on behalf of an end user, right now you can only use a si ## Deleting accounts -You have several options for removing access in Pipedream, depending on whether you want to delete an entire user or just specific connected accounts. +You can delete an individual connected account or an entire user and all associated accounts and resources from the UI or via the API. ### Deleting individual connected accounts @@ -34,7 +34,6 @@ If you need more granular control, you can delete specific connected accounts in 3. Find the user whose accounts you want to manage 4. View all connected accounts for that user in the expanded section 5. Click the **Delete** button next to the specific account you want to remove -6. Confirm the deletion when prompted This allows for more granular control over which integrated services remain accessible to your users. @@ -56,8 +55,7 @@ When you delete a user, all of their connected accounts and deployed resources ( 1. Open the project in Pipedream 2. Navigate to the **Users** tab under **Connect** 3. Locate the user you wish to delete -4. Click the **Delete User** button at the end of the row -5. Confirm the deletion in the dialog that appears +4. Click the **Delete User** button from the overlow menu at the end of the row Deleting a user is permanent and cannot be undone. All connected accounts for this user will be permanently removed.