Skip to content

Commit ae39a67

Browse files
committed
edits [netlify-build]
1 parent 1ac84b1 commit ae39a67

File tree

3 files changed

+35
-8
lines changed

3 files changed

+35
-8
lines changed

src/api/public-api/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ Within seconds, GitHub scans each commit in public repositories for Public API t
3939

4040
Learn more about [GitHub's secret scanning program](https://docs.github.com/en/developers/overview/secret-scanning-partner-program){:target="_blank"}.
4141

42+
## OAuth 2.0
43+
You can authenticate and authorize the Public API using [OAuth 2.0](/docs/connections/oauth/#supported-sources).
44+
4245
### Frequently Asked Questions
4346
#### What should I do if I see a notification that my token was exposed?
4447
In most cases, identifying and revoking an exposed token takes seconds. Segment recommends you check the [audit trail](/docs/segment-app/iam/audit-trail/) to ensure no unauthorized actions were taken with the token.

src/connections/functions/source-functions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,9 @@ Once configured, find the webhook URL - either on the **Overview** or **Settings
385385

386386
Copy and paste this URL into the upstream tool or service to send data to this source.
387387

388+
## OAuth 2.0
389+
You can authenticate source functins with [OAuth 2.0](/docs/connections/oauth/#supported-sources).
390+
388391
## Source function FAQs
389392

390393
##### What is the retry policy for a webhook payload?

src/connections/oauth.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ Depending on your workspace permissions, your access to OAuth apps is limited.
1212

1313
Segment Role | Permission
1414
------------ | -----------
15-
Workspace Owner | You can view/create/edit **Workspace Settings>Access Management>OAuth application**.
16-
Workspace Member | You cannot view/create/edit **Workspace Settings > Access Management > OAuth app**.
17-
Source Admin | You can view/edit **Source> Settings > OAuth app**. <br> You can connect/disconnect OAuth application. <br> You can enable/disable OAuth enforcement.
18-
Source Read-only | You can only view **Source > Settings > OAuth app**.
19-
Function Admin | You can view/edit **Source Function Instance > Settings > OAuth app**. <br>You can connect/disconnect OAuth application. <br>You can enable/disable OAuth enforcement.
20-
Function Read-only | You can only view **Source Function Instance > Settings > OAuth application**.
15+
Workspace Owner | You can view, create, and edit OAuth apps.
16+
Workspace Member | You cannot view, create, or edit OAuth apps.
17+
Source Admin | You can view and edit OAuth apps. <br> You can connect and disconnect OAuth apps. <br> You can enable or disable OAuth enforcement.
18+
Source Read-only | You can only view OAuth apps.
19+
Function Admin | You can view and edit OAuth apps. <br>You can connect and disconnect OAuth apps. <br>You can enable and disable OAuth enforcement.
20+
Function Read-only | You can only view OAuth apps.
2121

2222
## Create an OAuth app
2323

@@ -44,9 +44,11 @@ To create a new OAuth application:
4444
Public key | Upload a public key in PEM format to authenticate through the OAuth application. You can upload a second public key after you create the OAuth application.
4545
Public key name | Enter a name for your public key.
4646
Token expiration period | You can choose between: 1 day, 2 days, 3 days, 1 week, 2 weeks, 3 weeks, 30 days.
47-
Scope | This specifies what type of access is needed for each API. For pilot, Segment offers these 2 scopes: <br><li>Tracking API <br><li><li> `tracking_api:write` <br><li>Public API <br><li><li>`public_api:read_write`
47+
Scope | This specifies what type of access is needed for each API. See the list of [supported scopes](#supported-scopes).
4848
6. Click **Create**.
4949
50+
Once you create your OAuth app, you can now connect a source to your OAuth app.
51+
5052
## Connect a source to OAuth
5153
> info ""
5254
> OAuth only supports server-side sources and does not support. Currently for beta, only http API and node.js and public api and source functions are other api points that are covered
@@ -108,4 +110,23 @@ To remove a token:
108110
2. Select the *OAuth application tab within the **Access Management** page.
109111
3. Select the **App name** with the token you want to delete.
110112
4. Enter the complete token
111-
5. Click **Revoke token**.
113+
5. Click **Revoke token**.
114+
115+
## Supported sources
116+
OAuth 2.0 currently supports these sources:
117+
* [HTTP Tracking API](/docs/connections/sources/catalog/libraries/server/http-api/)
118+
* [Node.js](/docs/connections/sources/catalog/libraries/server/node/)
119+
* [Python](/docs/connections/sources/catalog/libraries/server/python/)
120+
* [Source Functions](/docs/connections/functions/source-functions/)
121+
122+
## Supported scopes
123+
OAuth 2.0 currently supports these scopes:
124+
125+
**Tracking API scopes**
126+
* `tracking_api:write`
127+
128+
**Source Functions scopes**
129+
* `functions:write`
130+
131+
**Public API scopes**
132+
* `public_api:read_write`

0 commit comments

Comments
 (0)