Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 40f12ae

Browse files
authored
chore: update group and role sync notes (#15658)
1 parent 24d44b4 commit 40f12ae

File tree

4 files changed

+21
-23
lines changed

4 files changed

+21
-23
lines changed

coderd/apidoc/docs.go

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/apidoc/swagger.json

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

codersdk/idpsync.go

+6-8
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,10 @@ import (
1212
)
1313

1414
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.
1817
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
2019
Mapping map[string][]uuid.UUID `json:"mapping"`
2120
// RegexFilter is a regular expression that filters the groups returned by
2221
// 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
6261
}
6362

6463
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.
6866
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.
7068
Mapping map[string][]string `json:"mapping"`
7169
}
7270

docs/reference/api/schemas.md

+7-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)