headscale/docs/ref
Ryan Malloy 209ba5c4ea oidc groups: store and expose the OIDC groups claim
Add a Groups column on the User model populated from the OIDC
'groups' claim at login, and surface it through the gRPC/REST
User message so external tools (Headplane) can read group
membership without reaching into the database.

- proto: add 'repeated string groups = 9' to v1.User.
- types.User: Groups text column, GetGroups/SetGroups JSON helpers,
  FromClaim populates from claims.Groups. The existing
  FlexibleStringSlice on OIDCClaims.Groups already handles
  JumpCloud-style single-string emission.
- types.User.Proto(): populate v1.User.Groups via GetGroups().
- db migration 202505141323: add the column BEFORE the existing
  202505141324 migration that loads users via the struct, so the
  schema is in place before any migration touches the User type.
- db migration 202507021200: extend the inline CREATE TABLE users
  and INSERT INTO users ... SELECT FROM users_old to carry the
  new column through the SQLite schema-recreation step.
- schema.sql: declare the column so squibble.Validate accepts
  databases produced by the new migration chain. Verified against
  all 7 historical sqlite dumps in hscontrol/db/testdata/sqlite.
- types.UserView, types_clone.go: regenerated to expose Groups.
- config-example.yaml, docs/ref/oidc.md: note the 'groups' scope
  and the role the column plays for external integrations.
- integration/oidc_groups_test.go: verify the round-trip via
  headscale.ListUsers() for users with multi-group, single-group,
  and empty group memberships.
2026-06-04 01:57:50 -06:00
..
integration docs: document trusted_proxies config option 2026-05-18 17:17:55 +02:00
api.md Update docs for auth-id changes 2026-03-01 13:38:22 +01:00
configuration.md Reformat docs with mdformat 2026-03-01 09:24:52 +01:00
debug.md Refresh docs for Grants 2026-05-12 14:12:29 +02:00
derp.md Remove redundant prefix 2026-05-12 14:12:29 +02:00
dns.md Remove redundant prefix 2026-05-12 14:12:29 +02:00
oidc.md oidc groups: store and expose the OIDC groups claim 2026-06-04 01:57:50 -06:00
policy.md Add docs for policy-wide options and node attributes 2026-05-18 17:21:58 +02:00
registration.md Rewrite ACL docs as policy 2026-05-12 14:12:29 +02:00
routes.md Refresh docs for Grants 2026-05-12 14:12:29 +02:00
tags.md Update links to Tailscale documentation 2026-04-18 09:33:41 +02:00
tls.md Reformat docs with mdformat 2026-03-01 09:24:52 +01:00