Skip to content

Commit e970dc2

Browse files
authored
Merge pull request #3921 from segmentio/add-github-token-scanning
Add section for api token security [SECFEAT-1021]
2 parents 9560202 + a61448e commit e970dc2

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

src/api/public-api/index.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,25 @@ The Public API includes the following benefits over the Config API:
2424
| Improved architecture | The Public API is built with improved security, checks for authentication, authorization, input validation, HTTPS exposed services, auto-scaling, and more in mind. |
2525
| Cleaner mapping | The Public API uses unique IDs for reference, in place of slugs in the Config API. Unique IDs are, by design, unique. |
2626
| Available in Europe | The Public API is accessible to both US and EU-based workspaces. |
27-
| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate |
27+
| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate |
28+
29+
## API Token Security
30+
31+
To enhance API token security, Segment partners with GitHub to prevent fraudulent use of exposed API tokens found in public git repositories. This helps to prevent malicious actors from using exposed tokens to perform unauthorized actions in your Segment workspace.
32+
33+
Within seconds, GitHub scans each commit in public repositories for Public API tokens, and sends detected tokens to Segment. Valid tokens are automatically revoked and workspace owners are notified.
34+
35+
Learn more about [GitHub's secret scanning program](https://docs.github.com/en/developers/overview/secret-scanning-partner-program){:target="_blank"}.
36+
37+
### Frequently Asked Questions
38+
#### What should I do if I see a notification that my token was exposed?
39+
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.
40+
41+
#### How did my token get exposed?
42+
Developers can accidentally commit tokens to public repositories, exposing them to the public. This can happen when developers use a token in a local development environment and forget to remove it before committing their code.
43+
44+
#### Why are exposed tokens automatically revoked?
45+
By automatically revoking the exposed token, Segment helps keep your workspace secure and prevents potential abuse of the token.
46+
47+
#### How do I enable this feature?
48+
This feature is automatically enabled for all workspaces on Team or Business tier plans.

0 commit comments

Comments
 (0)