chore: update group and role sync notes (#15658)

This commit is contained in:
ケイラ
2024-11-27 14:39:03 -07:00
committed by GitHub
parent 24d44b4518
commit 40f12aeca3
4 changed files with 21 additions and 23 deletions
+6 -8
View File
@@ -12,11 +12,10 @@ import (
)
type GroupSyncSettings struct {
// Field selects the claim field to be used as the created user's
// groups. If the group field is the empty string, then no group updates
// will ever come from the OIDC provider.
// Field is the name of the claim field that specifies what groups a user
// should be in. If empty, no groups will be synced.
Field string `json:"field"`
// Mapping maps from an OIDC group --> Coder group ID
// Mapping is a map from OIDC groups to Coder group IDs
Mapping map[string][]uuid.UUID `json:"mapping"`
// RegexFilter is a regular expression that filters the groups returned by
// the OIDC provider. Any group not matched by this regex will be ignored.
@@ -62,11 +61,10 @@ func (c *Client) PatchGroupIDPSyncSettings(ctx context.Context, orgID string, re
}
type RoleSyncSettings struct {
// Field selects the claim field to be used as the created user's
// groups. If the group field is the empty string, then no group updates
// will ever come from the OIDC provider.
// Field is the name of the claim field that specifies what organization roles
// a user should be given. If empty, no roles will be synced.
Field string `json:"field"`
// Mapping maps from an OIDC group --> Coder organization role
// Mapping is a map from OIDC groups to Coder organization roles.
Mapping map[string][]string `json:"mapping"`
}