|
50 | 50 | > with a review gate. See [docs/github-action.md](docs/github-action.md#pinning-strategies) |
51 | 51 | > for the full explanation and Dependabot setup. |
52 | 52 |
|
53 | | -**That's it!** With just your `SOCKET_SECURITY_API_KEY`, all scanning configurations are managed through the [Socket Dashboard](https://socket.dev/dashboard) — no workflow changes needed. |
| 53 | +**That's it!** With a properly scoped `SOCKET_SECURITY_API_KEY`, all scanning configurations are managed through the [Socket Dashboard](https://socket.dev/dashboard) — no workflow changes needed. See [Required API Token Scopes](#required-api-token-scopes) for details. |
54 | 54 |
|
55 | 55 | ### What You Get |
56 | 56 |
|
@@ -160,6 +160,19 @@ Configure scanning policies, notification channels, and rule sets for your entir |
160 | 160 |
|
161 | 161 |  |
162 | 162 |
|
| 163 | +### Required API Token Scopes |
| 164 | + |
| 165 | +Create your `SOCKET_SECURITY_API_KEY` in the [Socket Dashboard](https://socket.dev/dashboard) under **Settings → API Tokens**. Dashboard routes can depend on your organization and login session, so start from the dashboard or see the [Socket API Tokens docs](https://docs.socket.dev/docs/api-keys) for token-management details. Socket Basics needs the following scopes: |
| 166 | + |
| 167 | +| Scope | Required for | |
| 168 | +|-------|--------------| |
| 169 | +| `full-scans` | Submitting scan results to your organization | |
| 170 | +| `socket-basics` | Loading scanner configuration from the Socket Dashboard | |
| 171 | + |
| 172 | +If Socket Basics is configured from the Socket Dashboard, the `socket-basics` scope is required. If it is missing, you will see `Insufficient permissions` when Socket Basics loads dashboard configuration. |
| 173 | + |
| 174 | +If Socket Basics is configured with CLI arguments, environment variables, or a JSON config file, only `full-scans` permissions are required for result submission. Set `SOCKET_ORG` explicitly in your workflow when using this mode. |
| 175 | + |
163 | 176 | ## 💻 Other Usage Methods |
164 | 177 |
|
165 | 178 | 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 +264,7 @@ Add new connectors by: |
251 | 264 | **Socket API errors:** |
252 | 265 | - Ensure `SOCKET_SECURITY_API_KEY` and `SOCKET_ORG` are set correctly |
253 | 266 | - Verify your Socket Enterprise subscription is active |
| 267 | +- If you see `Insufficient permissions`, confirm your API token has the scopes required for your configuration mode (see [Required API Token Scopes](#required-api-token-scopes)) |
254 | 268 |
|
255 | 269 | **Notifier errors:** |
256 | 270 | - Check that notification credentials (Slack webhook, Jira token, etc.) are properly configured |
|
0 commit comments