Skip to content

Commit e8d52a6

Browse files
dc-larsenlelia
andauthored
docs: document required API token scopes for Socket Basics (#68)
* docs: document required API token scopes for Socket Basics * docs: clarify Socket Basics token scopes --------- Co-authored-by: lelia <2418071+lelia@users.noreply.github.com>
1 parent d573d3a commit e8d52a6

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ jobs:
5050
> with a review gate. See [docs/github-action.md](docs/github-action.md#pinning-strategies)
5151
> for the full explanation and Dependabot setup.
5252
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.
5454

5555
### What You Get
5656

@@ -160,6 +160,19 @@ Configure scanning policies, notification channels, and rule sets for your entir
160160

161161
![Socket Basics Section Config](docs/screenshots/socket_basics_section_config.png)
162162

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+
163176
## 💻 Other Usage Methods
164177

165178
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:
251264
**Socket API errors:**
252265
- Ensure `SOCKET_SECURITY_API_KEY` and `SOCKET_ORG` are set correctly
253266
- 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))
254268

255269
**Notifier errors:**
256270
- Check that notification credentials (Slack webhook, Jira token, etc.) are properly configured

0 commit comments

Comments
 (0)