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
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,10 @@ Within seconds, GitHub scans each commit in public repositories for Public API t
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
42
## OAuth 2.0
43
+
44
+
> info ""
45
+
> This feature is currently in pilot and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}.
46
+
43
47
You can authenticate and authorize the Public API using [OAuth 2.0](/docs/connections/oauth/#supported-sources).
Copy file name to clipboardExpand all lines: src/connections/functions/source-functions.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -386,6 +386,10 @@ Once configured, find the webhook URL - either on the **Overview** or **Settings
386
386
Copy and paste this URL into the upstream tool or service to send data to this source.
387
387
388
388
## OAuth 2.0
389
+
390
+
> info ""
391
+
> OAuth 2.0 is currently in pilot and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}.
392
+
389
393
You can authenticate source functins with [OAuth 2.0](/docs/connections/oauth/#supported-sources).
Copy file name to clipboardExpand all lines: src/connections/oauth.md
+15-19Lines changed: 15 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,12 @@
1
1
---
2
2
title: OAuth 2.0
3
+
hidden: true
3
4
---
4
5
5
-
OAuth 2.0 is an online authorization tool that uses tokens to grant access to API resources like Segment’s tracking API. You can use OAuth 2.0 as a security requirement for connections to third-party tools.
6
+
OAuth 2.0 is an online authorization standard that uses tokens to grant access to API resources like Segment’s tracking API. You can use OAuth 2.0 as a security requirement for connections to third-party tools.
6
7
7
8
> info ""
8
-
> This feature is currently in pilot. For pilot, Segment doesn’t support OAuth for Web and Mobile sources where an end-user is involved. OAuth 2.0 only supports server to Segment communication, a machine-to-machine workflow.
9
+
> This feature is currently in pilot and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. OAuth 2.0 only supports server to Segment communication, a machine-to-machine workflow. Take a look at the [supported sources](#supported-sources) to see what sources are currently supported.
9
10
10
11
## Permissions
11
12
Depending on your workspace permissions, your access to OAuth apps is limited.
@@ -26,39 +27,32 @@ Function Read-only | You can only view OAuth apps.
26
27
27
28
To create a new OAuth application:
28
29
29
-
1. Create a private and public key by running the script:
2. Navigate to **Settings > Workspace** settings and select the Access Management tab.
37
-
3. Select the **OAuth application** tab within the **Access Management** page.
38
-
4. Click **Create OAuth app**.
39
-
5. Enter the configuration settings:
30
+
1. Navigate to **Settings > Workspace** settings and select the Access Management tab.
31
+
2. Select the **OAuth application** tab within the **Access Management** page.
32
+
3. Click **Create OAuth app**.
33
+
4. Enter the configuration settings:
40
34
41
35
Settings | Details
42
36
-------- | -------
43
37
Application name | The name of the OAuth app.
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.
38
+
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. You can create a public key by running the script: `openssl rsa -in private.pem -pubout -outform PEM -out public.pem`
45
39
Public key name | Enter a name for your public key.
46
40
Token expiration period | You can choose between: 1 day, 2 days, 3 days, 1 week, 2 weeks, 3 weeks, 30 days.
47
41
Scope | This specifies what type of access is needed for each API. See the list of [supported scopes](#supported-scopes).
48
-
6. Click **Create**.
42
+
5. Click **Create**.
49
43
50
44
Once you create your OAuth app, you can now connect a source to your OAuth app.
51
45
52
46
## Connect a source to OAuth
53
47
> info ""
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
48
+
> OAuth only supports server-side sources. See the list of [supported sources](#supported-sources).
55
49
56
50
To connect a source to OAuth:
57
51
58
52
1. Navigate to **Connections > Sources**.
59
53
2. Select the source you want to enable OAuth for.
60
54
3. Go to the **Settings** tab of the source page and select **OAuth app**.
61
-
4. Click **Create OAuth app**.
55
+
4. Click **Connect OAuth app**.
62
56
5. Select the OAuth app you want to connect the source to.
63
57
6. Click **Connect**.
64
58
7. Select the toggle to **Enable OAuth** for the source.
@@ -104,8 +98,9 @@ To delete an OAuth app:
104
98
5. Enter the name of the OAuth app you want to delete.
105
99
6. Click **Delete OAuth app**.
106
100
107
-
## Remove a token
108
-
To remove a token:
101
+
## Revoke a token
102
+
103
+
When security incidents expose access tokens, you can revoke your access token. To revoke a token:
109
104
1. Navigate to **Settings > Workspace settings** and select the **Access Management** tab.
110
105
2. Select the *OAuth application tab within the **Access Management** page.
111
106
3. Select the **App name** with the token you want to delete.
0 commit comments