Skip to content

Commit 6d7d1b7

Browse files
Updating docs on users in Connect
1 parent 9f29307 commit 6d7d1b7

File tree

3 files changed

+64
-4
lines changed

3 files changed

+64
-4
lines changed

docs-v2/pages/connect/managed-auth/users.mdx

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,65 @@ To view or delete your users' connected accounts:
1010

1111
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/)).
1212

13+
## Connecting multiple accounts
14+
15+
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).
16+
17+
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.
18+
1319
<Callout type="warning">
14-
Connect currently supports one connected account per user, app, environment combination.
20+
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).
21+
</Callout>
22+
23+
## Deleting accounts
24+
25+
You have several options for removing access in Pipedream, depending on whether you want to delete an entire user or just specific connected accounts.
26+
27+
### Deleting individual connected accounts
28+
29+
If you need more granular control, you can delete specific connected accounts instead of removing the entire user.
30+
31+
#### From the UI
32+
1. Open the project in Pipedream
33+
2. Navigate to the **Users** tab under **Connect**
34+
3. Find the user whose accounts you want to manage
35+
4. View all connected accounts for that user in the expanded section
36+
5. Click the **Delete** button next to the specific account you want to remove
37+
6. Confirm the deletion when prompted
38+
39+
This allows for more granular control over which integrated services remain accessible to your users.
1540

16-
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.
41+
#### Via the API
42+
You can delete specific connected accounts programmatically:
43+
44+
```bash
45+
curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/accounts/{account_id}" \
46+
-H "Authorization: Bearer {access_token}"
47+
```
48+
49+
For complete API details including TypeScript and Node.js examples, [refer to the API reference](/connect/api/#delete-connected-account).
50+
51+
### Deleting users
52+
53+
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:
54+
55+
#### From the UI
56+
1. Open the project in Pipedream
57+
2. Navigate to the **Users** tab under **Connect**
58+
3. Locate the user you wish to delete
59+
4. Click the **Delete User** button at the end of the row
60+
5. Confirm the deletion in the dialog that appears
61+
62+
<Callout type="danger">
63+
Deleting a user is permanent and cannot be undone. All connected accounts for this user will be permanently removed.
1764
</Callout>
65+
66+
#### Via the API
67+
You can delete a user programmatically using the Pipedream API:
68+
69+
```bash
70+
curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/users/{external_user_id}" \
71+
-H "Authorization: Bearer {access_token}"
72+
```
73+
74+
For complete API details including TypeScript and Node.js examples, see the [API reference](/connect/api/#delete-user).

docs-v2/pages/connect/workflows.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,3 +412,7 @@ Pipedream Connect Error: Required account for hubspot not found for external use
412412
#### The external user ID to use during execution must be passed in the triggering event
413413
- You can't run a workflow on a timer for example, and look up the external user ID to use at runtime.
414414
- The external user ID must be passed in the triggering event, typically via [HTTP trigger](#invoke-the-workflow).
415+
416+
#### Cannot use multiple accounts for the same app during a single execution
417+
- If a user has multiple accounts for the same app (tied to a single external user), **Pipedream will use the most recently created account**.
418+
- Learn about [managing connected accounts](/connect/managed-auth/users/) for your end users.

pnpm-lock.yaml

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)