mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00

Files

T

Thomas Kosiewski b60ae0a0c4 refactor: add wildcard scope entries for API key scopes (#20032 )

# Add API Key Scope Wildcards

This PR adds wildcard API key scopes (`resource:*`) for all RBAC resources to ensure every resource has a matching wildcard value. It also adds all individual `resource:action` scopes to the API documentation and TypeScript definitions.

The changes include:

- Adding a new database migration (000377) that adds wildcard API key scopes
- Updating the API documentation to include all available scopes
- Enhancing the scope generation scripts to include all resource wildcards
- Updating the TypeScript definitions to match the expanded scope list

These changes make creating API keys with comprehensive permissions for specific resource types easier.

2025-10-06 12:08:17 +02:00

main.go

refactor: add wildcard scope entries for API key scopes (#20032 )

2025-10-06 12:08:17 +02:00

README.md

feat: add public RBAC scope catalog for user-requestable permissions (#19913 )

2025-09-26 11:30:28 +02:00

README.md

check-scopes

Validates that the DB enum api_key_scope contains every <resource>:<action> derived from coderd/rbac/policy/RBACPermissions.

Exits 0 when all scopes are present in coderd/database/dump.sql.
Exits 1 and prints missing values with suggested ALTER TYPE statements otherwise.

Usage

Ensure the schema dump is up-to-date, then run the check:

make -B gen/db   # forces DB dump regeneration
make lint/check-scopes

Or directly:

go run ./tools/check-scopes

Optional flags:

-dump path — override path to dump.sql (default coderd/database/dump.sql).

Remediation

When the tool reports missing values:

Create a DB migration extending the enum, e.g.:

ALTER TYPE api_key_scope ADD VALUE IF NOT EXISTS 'template:view_insights';

Regenerate and re-run:

make -B gen/db && make lint/check-scopes

Decide whether each new scope is public (exposed in the catalog) or internal-only.
- If public, add it to the curated map in coderd/rbac/scopes_catalog.go (externalLowLevel) so it appears in the public catalog and can be requested by users.