mirror of
https://github.com/coder/coder.git
synced 2026-06-03 04:58:23 +00:00
Thomas Kosiewski
4bda39585d
# Add support for low-level API key scopes This PR adds support for fine-grained API key scopes based on RBAC resource:action pairs. It includes: 1. A new endpoint `/api/v2/auth/scopes` to list all public low-level API key scopes 2. Generated constants in the SDK for all public scopes 3. Tests to verify scope validation during token creation 4. Updated API documentation to reflect the expanded scope options The implementation allows users to create API keys with specific permissions like `workspace:read` or `template:use` instead of only the legacy `all` or `application_connect` scopes. Fixes #19847
31 lines
832 B
Go
31 lines
832 B
Go
package coderd
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/coder/coder/v2/coderd/httpapi"
|
|
"github.com/coder/coder/v2/coderd/rbac"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
)
|
|
|
|
// listExternalScopes returns the curated list of API key scopes (resource:action)
|
|
// requestable via the API.
|
|
//
|
|
// @Summary List API key scopes
|
|
// @ID list-api-key-scopes
|
|
// @Tags Authorization
|
|
// @Produce json
|
|
// @Success 200 {object} codersdk.ExternalAPIKeyScopes
|
|
// @Router /auth/scopes [get]
|
|
func (*API) listExternalScopes(rw http.ResponseWriter, r *http.Request) {
|
|
scopes := rbac.ExternalScopeNames()
|
|
external := make([]codersdk.APIKeyScope, 0, len(scopes))
|
|
for _, scope := range scopes {
|
|
external = append(external, codersdk.APIKeyScope(scope))
|
|
}
|
|
|
|
httpapi.Write(r.Context(), rw, http.StatusOK, codersdk.ExternalAPIKeyScopes{
|
|
External: external,
|
|
})
|
|
}
|