mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat: get and update group IdP Sync settings (#14647)
--------- Co-authored-by: Steven Masley <stevenmasley@gmail.com>
This commit is contained in:
Kayla Washburn-Love
co-authored by
Steven Masley
Steven Masley
parent
2df9a3e554
commit
5ed065d88d
Generated
+111
@@ -3082,6 +3082,74 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"/organizations/{organization}/settings/idpsync/groups": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"CoderSessionToken": []
|
||||
}
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Enterprise"
|
||||
],
|
||||
"summary": "Get group IdP Sync settings by organization",
|
||||
"operationId": "get-group-idp-sync-settings-by-organization",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "Organization ID",
|
||||
"name": "organization",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/idpsync.GroupSyncSettings"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"security": [
|
||||
{
|
||||
"CoderSessionToken": []
|
||||
}
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Enterprise"
|
||||
],
|
||||
"summary": "Update group IdP Sync settings by organization",
|
||||
"operationId": "update-group-idp-sync-settings-by-organization",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "Organization ID",
|
||||
"name": "organization",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/idpsync.GroupSyncSettings"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/organizations/{organization}/templates": {
|
||||
"get": {
|
||||
"security": [
|
||||
@@ -11733,6 +11801,7 @@ const docTemplate = `{
|
||||
"file",
|
||||
"group",
|
||||
"group_member",
|
||||
"idpsync_settings",
|
||||
"license",
|
||||
"notification_preference",
|
||||
"notification_template",
|
||||
@@ -11764,6 +11833,7 @@ const docTemplate = `{
|
||||
"ResourceFile",
|
||||
"ResourceGroup",
|
||||
"ResourceGroupMember",
|
||||
"ResourceIdpsyncSettings",
|
||||
"ResourceLicense",
|
||||
"ResourceNotificationPreference",
|
||||
"ResourceNotificationTemplate",
|
||||
@@ -15046,6 +15116,44 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"idpsync.GroupSyncSettings": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"auto_create_missing_groups": {
|
||||
"description": "AutoCreateMissing controls whether groups returned by the OIDC provider\nare automatically created in Coder if they are missing.",
|
||||
"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.",
|
||||
"type": "string"
|
||||
},
|
||||
"legacy_group_name_mapping": {
|
||||
"description": "LegacyNameMapping is deprecated. It remaps an IDP group name to\na Coder group name. Since configuration is now done at runtime,\ngroup IDs are used to account for group renames.\nFor legacy configurations, this config option has to remain.\nDeprecated: Use Mapping instead.",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mapping": {
|
||||
"description": "Mapping maps from an OIDC group --\u003e Coder group ID",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"regex_filter": {
|
||||
"description": "RegexFilter is a regular expression that filters the groups returned by\nthe OIDC provider. Any group not matched by this regex will be ignored.\nIf the group filter is nil, then no group filtering will occur.",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/regexp.Regexp"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"key.NodePublic": {
|
||||
"type": "object"
|
||||
},
|
||||
@@ -15164,6 +15272,9 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"regexp.Regexp": {
|
||||
"type": "object"
|
||||
},
|
||||
"serpent.Annotations": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
|
||||
Generated
+103
@@ -2708,6 +2708,66 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/organizations/{organization}/settings/idpsync/groups": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"CoderSessionToken": []
|
||||
}
|
||||
],
|
||||
"produces": ["application/json"],
|
||||
"tags": ["Enterprise"],
|
||||
"summary": "Get group IdP Sync settings by organization",
|
||||
"operationId": "get-group-idp-sync-settings-by-organization",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "Organization ID",
|
||||
"name": "organization",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/idpsync.GroupSyncSettings"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"security": [
|
||||
{
|
||||
"CoderSessionToken": []
|
||||
}
|
||||
],
|
||||
"produces": ["application/json"],
|
||||
"tags": ["Enterprise"],
|
||||
"summary": "Update group IdP Sync settings by organization",
|
||||
"operationId": "update-group-idp-sync-settings-by-organization",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "Organization ID",
|
||||
"name": "organization",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/idpsync.GroupSyncSettings"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/organizations/{organization}/templates": {
|
||||
"get": {
|
||||
"security": [
|
||||
@@ -10589,6 +10649,7 @@
|
||||
"file",
|
||||
"group",
|
||||
"group_member",
|
||||
"idpsync_settings",
|
||||
"license",
|
||||
"notification_preference",
|
||||
"notification_template",
|
||||
@@ -10620,6 +10681,7 @@
|
||||
"ResourceFile",
|
||||
"ResourceGroup",
|
||||
"ResourceGroupMember",
|
||||
"ResourceIdpsyncSettings",
|
||||
"ResourceLicense",
|
||||
"ResourceNotificationPreference",
|
||||
"ResourceNotificationTemplate",
|
||||
@@ -13715,6 +13777,44 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"idpsync.GroupSyncSettings": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"auto_create_missing_groups": {
|
||||
"description": "AutoCreateMissing controls whether groups returned by the OIDC provider\nare automatically created in Coder if they are missing.",
|
||||
"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.",
|
||||
"type": "string"
|
||||
},
|
||||
"legacy_group_name_mapping": {
|
||||
"description": "LegacyNameMapping is deprecated. It remaps an IDP group name to\na Coder group name. Since configuration is now done at runtime,\ngroup IDs are used to account for group renames.\nFor legacy configurations, this config option has to remain.\nDeprecated: Use Mapping instead.",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"mapping": {
|
||||
"description": "Mapping maps from an OIDC group --\u003e Coder group ID",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"regex_filter": {
|
||||
"description": "RegexFilter is a regular expression that filters the groups returned by\nthe OIDC provider. Any group not matched by this regex will be ignored.\nIf the group filter is nil, then no group filtering will occur.",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/regexp.Regexp"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"key.NodePublic": {
|
||||
"type": "object"
|
||||
},
|
||||
@@ -13833,6 +13933,9 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"regexp.Regexp": {
|
||||
"type": "object"
|
||||
},
|
||||
"serpent.Annotations": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
|
||||
Reference in New Issue
Block a user