You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/api/public-api/index.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,6 +39,9 @@ Within seconds, GitHub scans each commit in public repositories for Public API t
39
39
40
40
Learn more about [GitHub's secret scanning program](https://docs.github.com/en/developers/overview/secret-scanning-partner-program){:target="_blank"}.
41
41
42
+
## OAuth 2.0
43
+
You can authenticate and authorize the Public API using [OAuth 2.0](/docs/connections/oauth/#supported-sources).
44
+
42
45
### Frequently Asked Questions
43
46
#### What should I do if I see a notification that my token was exposed?
44
47
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.
Copy file name to clipboardExpand all lines: src/connections/oauth.md
+29-8Lines changed: 29 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,12 +12,12 @@ Depending on your workspace permissions, your access to OAuth apps is limited.
12
12
13
13
Segment Role | Permission
14
14
------------ | -----------
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.
21
21
22
22
## Create an OAuth app
23
23
@@ -44,9 +44,11 @@ To create a new OAuth application:
44
44
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.
45
45
Public key name | Enter a name for your public key.
46
46
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).
48
48
6. Click **Create**.
49
49
50
+
Once you create your OAuth app, you can now connect a source to your OAuth app.
51
+
50
52
## Connect a source to OAuth
51
53
> info ""
52
54
> 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:
108
110
2. Select the *OAuth application tab within the **Access Management** page.
109
111
3. Select the **App name** with the token you want to delete.
0 commit comments