synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-21 01:28:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

8
coderd/apidoc/docs.go generated
View File

@ -11126,7 +11126,7 @@ const docTemplate = `{
"type": "boolean"
},
"field": {
"description": "Field selects the claim field to be used as the created user's\ngroups. If the group field is the empty string, then no group updates\nwill ever come from the OIDC provider.",
"description": "Field is the name of the claim field that specifies what groups a user\nshould be in. If empty, no groups will be synced.",
"type": "string"
},
"legacy_group_name_mapping": {
@ -11137,7 +11137,7 @@ const docTemplate = `{
}
},
"mapping": {
"description": "Mapping maps from an OIDC group --\u003e Coder group ID",
"description": "Mapping is a map from OIDC groups to Coder group IDs",
"type": "object",
"additionalProperties": {
"type": "array",
@ -12931,11 +12931,11 @@ const docTemplate = `{
"type": "object",
"properties": {
"field": {
"description": "Field selects the claim field to be used as the created user's\ngroups. If the group field is the empty string, then no group updates\nwill ever come from the OIDC provider.",
"description": "Field is the name of the claim field that specifies what organization roles\na user should be given. If empty, no roles will be synced.",
"type": "string"
},
"mapping": {
"description": "Mapping maps from an OIDC group --\u003e Coder organization role",
"description": "Mapping is a map from OIDC groups to Coder organization roles.",
"type": "object",
"additionalProperties": {
"type": "array",

8
coderd/apidoc/swagger.json generated
View File

@ -9983,7 +9983,7 @@
"type": "boolean"
},
"field": {
"description": "Field selects the claim field to be used as the created user's\ngroups. If the group field is the empty string, then no group updates\nwill ever come from the OIDC provider.",
"description": "Field is the name of the claim field that specifies what groups a user\nshould be in. If empty, no groups will be synced.",
"type": "string"
},
"legacy_group_name_mapping": {
@ -9994,7 +9994,7 @@
}
},
"mapping": {
"description": "Mapping maps from an OIDC group --\u003e Coder group ID",
"description": "Mapping is a map from OIDC groups to Coder group IDs",
"type": "object",
"additionalProperties": {
"type": "array",
@ -11696,11 +11696,11 @@
"type": "object",
"properties": {
"field": {
"description": "Field selects the claim field to be used as the created user's\ngroups. If the group field is the empty string, then no group updates\nwill ever come from the OIDC provider.",
"description": "Field is the name of the claim field that specifies what organization roles\na user should be given. If empty, no roles will be synced.",
"type": "string"
},
"mapping": {
"description": "Mapping maps from an OIDC group --\u003e Coder organization role",
"description": "Mapping is a map from OIDC groups to Coder organization roles.",
"type": "object",
"additionalProperties": {
"type": "array",

14
codersdk/idpsync.go
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"`
}

14
docs/reference/api/schemas.md generated
View File

@ -3026,10 +3026,10 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o
| Name | Type | Required | Restrictions | Description |
| ---------------------------- | ------------------------------ | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `auto_create_missing_groups` | boolean | false | | Auto create missing groups controls whether groups returned by the OIDC provider are automatically created in Coder if they are missing. |
| `field` | string | false | | 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` | string | false | | Field is the name of the claim field that specifies what groups a user should be in. If empty, no groups will be synced. |
| `legacy_group_name_mapping` | object | false | | Legacy group name mapping is deprecated. It remaps an IDP group name to a Coder group name. Since configuration is now done at runtime, group IDs are used to account for group renames. For legacy configurations, this config option has to remain. Deprecated: Use Mapping instead. |
| » `[any property]` | string | false | | |
| `mapping` | object | false | | Mapping maps from an OIDC group --> Coder group ID |
| `mapping` | object | false | | Mapping is a map from OIDC groups to Coder group IDs |
| » `[any property]` | array of string | false | | |
| `regex_filter` | [regexp.Regexp](#regexpregexp) | false | | Regex filter is a regular expression that filters the groups returned by the OIDC provider. Any group not matched by this regex will be ignored. If the group filter is nil, then no group filtering will occur. |
@ -4876,11 +4876,11 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | --------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `field` | string | false | | 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. |
| `mapping` | object | false | | Mapping maps from an OIDC group --> Coder organization role |
| » `[any property]` | array of string | false | | |
| Name | Type | Required | Restrictions | Description |
| ------------------ | --------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| `field` | string | false | | 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. |
| `mapping` | object | false | | Mapping is a map from OIDC groups to Coder organization roles. |
| » `[any property]` | array of string | false | | |
## codersdk.SSHConfig