Skip to content

Commit c62b30c

Browse files
committed
edits
1 parent ae39a67 commit c62b30c

File tree

3 files changed

+23
-19
lines changed

3 files changed

+23
-19
lines changed

src/api/public-api/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ Within seconds, GitHub scans each commit in public repositories for Public API t
4040
Learn more about [GitHub's secret scanning program](https://docs.github.com/en/developers/overview/secret-scanning-partner-program){:target="_blank"}.
4141

4242
## 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+
4347
You can authenticate and authorize the Public API using [OAuth 2.0](/docs/connections/oauth/#supported-sources).
4448

4549
### Frequently Asked Questions

src/connections/functions/source-functions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,10 @@ Once configured, find the webhook URL - either on the **Overview** or **Settings
386386
Copy and paste this URL into the upstream tool or service to send data to this source.
387387

388388
## 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+
389393
You can authenticate source functins with [OAuth 2.0](/docs/connections/oauth/#supported-sources).
390394

391395
## Source function FAQs

src/connections/oauth.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: OAuth 2.0
3+
hidden: true
34
---
45

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.
67

78
> 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.
910
1011
## Permissions
1112
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.
2627
2728
To create a new OAuth application:
2829

29-
1. Create a private and public key by running the script:
30-
31-
```
32-
openssl genpkey -algorithm RSA -out private.pem -pkeyopt rsa_keygen_bits:2048
33-
openssl rsa -in private.pem -pubout -outform PEM -out public.pem
34-
```
35-
36-
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:
4034

4135
Settings | Details
4236
-------- | -------
4337
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`
4539
Public key name | Enter a name for your public key.
4640
Token expiration period | You can choose between: 1 day, 2 days, 3 days, 1 week, 2 weeks, 3 weeks, 30 days.
4741
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**.
4943

5044
Once you create your OAuth app, you can now connect a source to your OAuth app.
5145

5246
## Connect a source to OAuth
5347
> 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).
5549
5650
To connect a source to OAuth:
5751

5852
1. Navigate to **Connections > Sources**.
5953
2. Select the source you want to enable OAuth for.
6054
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**.
6256
5. Select the OAuth app you want to connect the source to.
6357
6. Click **Connect**.
6458
7. Select the toggle to **Enable OAuth** for the source.
@@ -104,8 +98,9 @@ To delete an OAuth app:
10498
5. Enter the name of the OAuth app you want to delete.
10599
6. Click **Delete OAuth app**.
106100

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:
109104
1. Navigate to **Settings > Workspace settings** and select the **Access Management** tab.
110105
2. Select the *OAuth application tab within the **Access Management** page.
111106
3. Select the **App name** with the token you want to delete.
@@ -116,6 +111,7 @@ To remove a token:
116111
OAuth 2.0 currently supports these sources:
117112
* [HTTP Tracking API](/docs/connections/sources/catalog/libraries/server/http-api/)
118113
* [Node.js](/docs/connections/sources/catalog/libraries/server/node/)
114+
* [Public API](/docs/api/public-api/)
119115
* [Python](/docs/connections/sources/catalog/libraries/server/python/)
120116
* [Source Functions](/docs/connections/functions/source-functions/)
121117

0 commit comments

Comments
 (0)