feat(group): add user groups to token claims (#11009)

# Which Problems Are Solved

If the groups of a user is requested through a scope, details related to
the user's groups are added in the token claims.

# How the Problems Are Solved
By querying the user groups that the user is a part of, and setting them
in the token claims.

This PR introduces two scopes to request user groups: `groups` and
`urn:zitadel:iam:user:groups`
* `groups` returns an array of group names in the token claims with the
same name
* `urn:zitadel:iam:user:groups` returns an array of JSON objects with
information about the user groups in the token claims with the same name

# Additional Changes

N/A

# Additional Context

- Closes #9702 
- Follow-up for PRs:
  * #10455 
  * #10853 
  * #10758 
  * #10940

---------

Co-authored-by: Livio Spring <[email protected]>
This commit is contained in:
Gayathri Vijayan
2025-11-11 09:06:45 +01:00
committed by GitHub
co-authored by Livio Spring
parent e4a959c321
commit a9846498a9
8 changed files with 140 additions and 5 deletions
+1
View File
@@ -51,6 +51,7 @@ func (g *groupProjection) Init() *old_handler.Check {
},
handler.NewPrimaryKey(GroupColumnInstanceID, GroupColumnID),
handler.WithIndex(handler.NewIndex("resource_owner", []string{GroupColumnResourceOwner})),
handler.WithIndex(handler.NewIndex("state", []string{GroupColumnState})),
),
)
}
+10 -4
View File
@@ -82,10 +82,11 @@ func (q *Queries) GetOIDCUserInfo(ctx context.Context, userID string, roleAudien
}
type OIDCUserInfo struct {
User *User `json:"user,omitempty"`
Metadata []UserMetadata `json:"metadata,omitempty"`
Org *UserInfoOrg `json:"org,omitempty"`
UserGrants []UserGrant `json:"user_grants,omitempty"`
User *User `json:"user,omitempty"`
Metadata []UserMetadata `json:"metadata,omitempty"`
Org *UserInfoOrg `json:"org,omitempty"`
UserGrants []UserGrant `json:"user_grants,omitempty"`
UserGroups []UserInfoUserGroup `json:"user_groups,omitempty"`
}
type UserInfoOrg struct {
@@ -94,6 +95,11 @@ type UserInfoOrg struct {
PrimaryDomain string `json:"primary_domain,omitempty"`
}
type UserInfoUserGroup struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
}
//go:embed userinfo_client_by_id.sql
var oidcUserinfoClientQuery string
+14 -1
View File
@@ -62,6 +62,18 @@ user_org as (
join usr u on o.id = u.resource_owner
) r
),
-- find the user's groups
user_groups as (
select json_agg(row_to_json(r)) as user_groups from (
select g.id, g.name
from projections.group_users1 as gu
left join projections.groups1 as g on gu.group_id = g.id and gu.instance_id = g.instance_id
where gu.user_id = $1
and gu.instance_id = $2
and g.state = 1
)
r
),
-- join user grants to orgs, projects and user
grants as (
select json_agg(row_to_json(r)) as grants from (
@@ -87,5 +99,6 @@ select json_build_object(
),
'org', (select organization from user_org),
'metadata', (select metadata from metadata),
'user_grants', (select grants from grants)
'user_grants', (select grants from grants),
'user_groups', (select user_groups from user_groups)
);