From 3bc2da77ce5b8751d80e4e7ac44ab37d27530981 Mon Sep 17 00:00:00 2001 From: David Larsen Date: Mon, 27 Apr 2026 22:53:53 -0500 Subject: [PATCH] docs: document required API token scopes for Socket Basics --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 5c0c2b9..cb19a58 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,17 @@ Configure scanning policies, notification channels, and rule sets for your entir ![Socket Basics Section Config](docs/screenshots/socket_basics_section_config.png) +### Required API Token Scopes + +Create your `SOCKET_SECURITY_API_KEY` in the Socket Dashboard under **Settings → API Tokens**. Socket Basics needs the following scopes: + +| Scope | Required for | +|-------|--------------| +| `socket-basics` | Loading scanner configuration from the Socket Dashboard | +| `full-scans` | Submitting scan results to your organization | + +If your token is missing the `socket-basics` scope, you will see `Insufficient permissions` when Socket Basics tries to load dashboard config. As a workaround, set `SOCKET_ORG` explicitly in your workflow to skip the dashboard config load and run with CLI/environment configuration only. + ## 💻 Other Usage Methods For GitHub Actions, see the [Quick Start](#-quick-start---github-actions) above or the **[Complete GitHub Actions Guide](docs/github-action.md)** for advanced workflows. @@ -251,6 +262,7 @@ Add new connectors by: **Socket API errors:** - Ensure `SOCKET_SECURITY_API_KEY` and `SOCKET_ORG` are set correctly - Verify your Socket Enterprise subscription is active +- If you see `Insufficient permissions`, confirm your API token has the `socket-basics` and `full-scans` scopes (see [Required API Token Scopes](#required-api-token-scopes)) **Notifier errors:** - Check that notification credentials (Slack webhook, Jira token, etc.) are properly configured