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

Skip to content

chore: update group and role sync notes #15658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 27, 2024
Merged

chore: update group and role sync notes #15658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
863934d
fix some doc comments
aslilac Nov 26, 2024
ddd8067
Merge branch 'main' into lilac/update-doc-comments
aslilac Nov 26, 2024
954048d
Merge branch 'main' into lilac/update-doc-comments
aslilac Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions coderd/apidoc/docs.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions coderd/apidoc/swagger.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 6 additions & 8 deletions codersdk/idpsync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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"`
}

Expand Down
14 changes: 7 additions & 7 deletions docs/reference/api/schemas.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading