@@ -12,11 +12,10 @@ import (
12
12
)
13
13
14
14
type GroupSyncSettings struct {
15
- // Field selects the claim field to be used as the created user's
16
- // groups. If the group field is the empty string, then no group updates
17
- // will ever come from the OIDC provider.
15
+ // Field is the name of the claim field that specifies what groups a user
16
+ // should be in. If empty, no groups will be synced.
18
17
Field string `json:"field"`
19
- // Mapping maps from an OIDC group --> Coder group ID
18
+ // Mapping is a map from OIDC groups to Coder group IDs
20
19
Mapping map [string ][]uuid.UUID `json:"mapping"`
21
20
// RegexFilter is a regular expression that filters the groups returned by
22
21
// 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
62
61
}
63
62
64
63
type RoleSyncSettings struct {
65
- // Field selects the claim field to be used as the created user's
66
- // groups. If the group field is the empty string, then no group updates
67
- // will ever come from the OIDC provider.
64
+ // Field is the name of the claim field that specifies what organization roles
65
+ // a user should be given. If empty, no roles will be synced.
68
66
Field string `json:"field"`
69
- // Mapping maps from an OIDC group --> Coder organization role
67
+ // Mapping is a map from OIDC groups to Coder organization roles.
70
68
Mapping map [string ][]string `json:"mapping"`
71
69
}
72
70
0 commit comments