Skip to content

Commit 6e1d464

Browse files
s/oauth app/oauth client
1 parent 6bdfb2c commit 6e1d464

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs-v2/pages/rest-api/auth.mdx

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,24 @@ The Pipedream API supports two methods of authentication: [OAuth](#oauth) and [U
66

77
✅ OAuth clients are tied to the workspace, administered by workspace admins <br />
88
✅ Tokens are short-lived <br />
9-
✅ OAuth clients support scopes, limiting access to specific operations <br />
9+
✅ OAuth clients support scopes, limiting access to specific operations (coming soon!)<br />
10+
✅ Limit access to specific Pipedream projects (coming soon!)<br />
1011

1112
When testing the API or using the CLI, you can use your user API key. This key is tied to your user account and provides full access to any resources your user has access to, across workspaces.
1213

1314
## OAuth
1415

15-
Workspace administrators can create OAuth applications in your workspace's [API settings](https://pipedream.com/settings/api).
16+
Workspace administrators can create OAuth clients in your workspace's [API settings](https://pipedream.com/settings/api).
1617

1718
Since API requests are meant to be made server-side, and since grants are not tied to individual end users, all OAuth clients are [**Client Credentials** applications](https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/).
1819

19-
### Creating an OAuth application
20+
### Creating an OAuth client
2021

21-
1. Visit your workspace's [API settings](https://pipedream.com/settings/api).
22-
2. Click the **New OAuth App** button.
23-
3. Name your app and click **Create**.
24-
4. Copy the app's client secret. **It will not be accessible again**. Click **Close**.
25-
5. Copy the app's client ID from the list of OAuth applications.
22+
1. Visit the [API settings](https://pipedream.com/settings/api) for your workspace.
23+
2. Click the **New OAuth Client** button.
24+
3. Name your client and click **Create**.
25+
4. Copy the client secret. **It will not be accessible again**. Click **Close**.
26+
5. Copy the client ID from the list.
2627

2728
### How to get an access token
2829

@@ -69,7 +70,7 @@ Access tokens expire after 1 hour. Store access tokens securely, server-side.
6970
### Revoking a client secret
7071

7172
1. Visit your workspace's [API settings](https://pipedream.com/settings/api).
72-
2. Click the **...** button to the right of the OAuth app whose secret you want to revoke, then click **Rotate client secret**.
73+
2. Click the **...** button to the right of the OAuth client whose secret you want to revoke, then click **Rotate client secret**.
7374
3. Copy the new client secret. **It will not be accessible again**.
7475

7576
### OAuth security

0 commit comments

Comments
 (0)