Skip to content

Commit

Permalink
Clarifying OAuth usage
Browse files Browse the repository at this point in the history
  • Loading branch information
dannyroosevelt committed Feb 28, 2025
1 parent 82b3bb2 commit 5016fd4
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
3 changes: 0 additions & 3 deletions docs-v2/pages/connect/_meta.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@ export default {
"api": {
"title": "API & SDK reference",
},
"troubleshooting": {
"title": "Troubleshooting",
},
"migrating-from-project-keys-to-oauth": {
"display": "hidden",
},
Expand Down
2 changes: 1 addition & 1 deletion docs-v2/pages/connect/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import VideoPlayer from "@/components/VideoPlayer";
## Act on behalf of your users

- Retrieve OAuth access tokens and API keys for your end users with Pipedream's [REST API](/connect/api/)
- Add 10k pre-built tools and triggers from {process.env.PUBLIC_APPS}+ APIs to your AI agent or embed them directly in your SaaS app
- [Add 10k pre-built tools and triggers](/connect/components) from {process.env.PUBLIC_APPS}+ APIs to your AI agent or embed them in your SaaS app
- Develop and deploy complex multi-step [workflows](/connect/workflows/) in our best-in-class [visual builder](/workflows/building-workflows/)
- Send custom API requests while still avoiding dealing with customer credentials with the [Connect proxy](/connect/api-proxy/)

Expand Down
12 changes: 6 additions & 6 deletions docs-v2/pages/connect/managed-auth/oauth-clients.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ There are two types of apps in Pipedream:
2. **OAuth**: These apps require OAuth authorization. Pipedream manages the OAuth flow for these apps, ensuring you always have a fresh access token for requests.

<Callout type="info">
For any OAuth app that supports it, **you can always use your own client.** Your ability to use Pipedream's OAuth clients in production depends on the use case.
For any OAuth app that supports it, **you can always use your own client.** Your ability to use Pipedream's OAuth clients in production depends on the use case. See below for details.
</Callout>

<br />

<div className="highlightHeaderRowTable">
| Operation | Details | Environment |
| Operation | Details | OAuth Client |
|--------|---------|------------------------------|
| Retrieve user credentrials | [Fetch the credentials](/connect/api#accounts) for your end user from Pipedream's API to use in your app | `development`<br />`production` |
| Invoke workflows | [Trigger any Pipedream workflow](/connect/workflows) and use the connected account of your end users | `development`<br />`production` |
| Embed prebuilt tools | [Run any action and deploy any trigger](/connect/components) directly from your AI agent or app |`development`<br />✅ `production` |
| Proxy API requests | [Write custom code to interface with any integrated API](/connect/api-proxy) while avoiding dealing with user auth |`development`<br />✅ `production` |
| Retrieve user credentrials | [Fetch the credentials](/connect/api#accounts) for your end user from Pipedream's API to use in your app | ❌ Pipedream<br />✅ Custom |
| Invoke workflows | [Trigger any Pipedream workflow](/connect/workflows) and use the connected account of your end users | ❌ Pipedream<br />✅ Custom |
| Embed prebuilt tools | [Run any action and deploy any trigger](/connect/components) directly from your AI agent or app |Pipedream<br />✅ Custom |
| Proxy API requests | [Write custom code to interface with any integrated API](/connect/api-proxy) while avoiding dealing with user auth |Pipedream<br />✅ Custom |
</div>

## Using a custom OAuth client
Expand Down
File renamed without changes.
4 changes: 4 additions & 0 deletions vercel.json
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,10 @@
{
"source": "/docs/code/python/#listing-files-in-tmp",
"destination": "/docs/code/python/working-with-files/#listing-files-in-tmp"
},
{
"source": "/docs/connect/troubleshooting",
"destination": "/docs/connect/managed-auth/troubleshooting"
}
]
}

0 comments on commit 5016fd4

Please sign in to comment.