org_sync_idp_groups

Author: aslilac

docs/resources/organization.md

@@ -12,8 +12,7 @@ description: |-
 
 An organization on the Coder deployment.
 
-~> **Warning**
-This resource is only compatible with Coder version [2.16.0](https://github.com/coder/coder/releases/tag/v2.16.0) and later.
+~> **Warning** This resource is only compatible with Coder version [2.16.0](https://github.com/coder/coder/releases/tag/v2.16.0) and later.
 
 ## Example Usage
 
@@ -24,7 +23,7 @@ resource "coderd_organization" "blueberry" {
   description  = "The organization for blueberries"
   icon         = "/emojis/1fad0.png"
 
-  sync_mapping = [
+  org_sync_idp_groups = [
     "wibble",
     "wobble",
   ]
@@ -46,6 +45,7 @@ resource "coderd_organization" "blueberry" {
 ```
 
 <!-- schema generated by tfplugindocs -->
+
 ## Schema
 
 ### Required
@@ -59,13 +59,14 @@ resource "coderd_organization" "blueberry" {
 - `group_sync` (Block, Optional) Group sync settings to sync groups from an IdP. (see [below for nested schema](#nestedblock--group_sync))
 - `icon` (String)
 - `role_sync` (Block, Optional) Role sync settings to sync organization roles from an IdP. (see [below for nested schema](#nestedblock--role_sync))
-- `sync_mapping` (Set of String) Claims from the IdP provider that will give users access to this organization.
+- `org_sync_idp_groups` (Set of String) Claims from the IdP provider that will give users access to this organization.
 
 ### Read-Only
 
 - `id` (String) Organization ID
 
 <a id="nestedblock--group_sync"></a>
+
 ### Nested Schema for `group_sync`
 
 Optional:
@@ -75,8 +76,8 @@ Optional:
 - `mapping` (Map of List of String) A map from OIDC group name to Coder group ID.
 - `regex_filter` (String) A regular expression that will be used to filter the groups returned by the OIDC provider. Any group not matched will be ignored.
 
-
 <a id="nestedblock--role_sync"></a>
+
 ### Nested Schema for `role_sync`
 
 Optional:
@@ -93,6 +94,7 @@ Import is supported using the following syntax:
 # or the name of the organization.
 $ terraform import coderd_organization.our_org our-org
 ```
+
 Alternatively, in Terraform v1.5.0 and later, an [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used:
 
 ```terraform

examples/resources/coderd_organization/resource.tf

@@ -4,7 +4,7 @@ resource "coderd_organization" "blueberry" {
   description  = "The organization for blueberries"
   icon         = "/emojis/1fad0.png"
 
-  sync_mapping = [
+  org_sync_idp_groups = [
     "wibble",
     "wobble",
   ]

internal/provider/organization_resource.go

@@ -41,7 +41,7 @@ type OrganizationResourceModel struct {
 	Description types.String `tfsdk:"description"`
 	Icon        types.String `tfsdk:"icon"`
 
-	SyncMapping types.Set    `tfsdk:"sync_mapping"`
+	SyncMapping types.Set    `tfsdk:"org_sync_idp_groups"`
 	GroupSync   types.Object `tfsdk:"group_sync"`
 	RoleSync    types.Object `tfsdk:"role_sync"`
 }
@@ -137,7 +137,7 @@ This resource is only compatible with Coder version [2.16.0](https://github.com/
 				Default:  stringdefault.StaticString(""),
 			},
 
-			"sync_mapping": schema.SetAttribute{
+			"org_sync_idp_groups": schema.SetAttribute{
 				ElementType:         types.StringType,
 				Optional:            true,
 				MarkdownDescription: "Claims from the IdP provider that will give users access to this organization.",

internal/provider/organization_resource_test.go

@@ -96,16 +96,16 @@ func TestAccOrganizationResource(t *testing.T) {
 				{
 					Config: cfg3.String(t),
 					ConfigStateChecks: []statecheck.StateCheck{
-						statecheck.ExpectKnownValue("coderd_organization.test", tfjsonpath.New("sync_mapping").AtSliceIndex(0), knownvalue.StringExact("wibble")),
-						statecheck.ExpectKnownValue("coderd_organization.test", tfjsonpath.New("sync_mapping").AtSliceIndex(1), knownvalue.StringExact("wobble")),
+						statecheck.ExpectKnownValue("coderd_organization.test", tfjsonpath.New("org_sync_idp_groups").AtSliceIndex(0), knownvalue.StringExact("wibble")),
+						statecheck.ExpectKnownValue("coderd_organization.test", tfjsonpath.New("org_sync_idp_groups").AtSliceIndex(1), knownvalue.StringExact("wobble")),
 					},
 				},
 				// Patch org sync
 				{
 					Config: cfg4.String(t),
 					ConfigStateChecks: []statecheck.StateCheck{
-						statecheck.ExpectKnownValue("coderd_organization.test", tfjsonpath.New("sync_mapping").AtSliceIndex(0), knownvalue.StringExact("wibbley")),
-						statecheck.ExpectKnownValue("coderd_organization.test", tfjsonpath.New("sync_mapping").AtSliceIndex(1), knownvalue.StringExact("wobbley")),
+						statecheck.ExpectKnownValue("coderd_organization.test", tfjsonpath.New("org_sync_idp_groups").AtSliceIndex(0), knownvalue.StringExact("wibbley")),
+						statecheck.ExpectKnownValue("coderd_organization.test", tfjsonpath.New("org_sync_idp_groups").AtSliceIndex(1), knownvalue.StringExact("wobbley")),
 					},
 				},
 				// Add group and role sync
@@ -152,7 +152,7 @@ resource "coderd_organization" "test" {
 	icon         = {{orNull .Icon}}
 
 	{{- if .SyncMapping}}
-	sync_mapping = [
+	org_sync_idp_groups = [
 		{{- range $name := .SyncMapping }}
 		"{{$name}}",
 		{{- end}}

internal/provider/organization_sync_settings_resource.go

@@ -244,7 +244,7 @@ func (r *OrganizationSyncSettingsResource) Delete(ctx context.Context, req resou
 	tflog.Trace(ctx, "deleting organization sync", map[string]any{})
 	_, err := r.Client.PatchOrganizationIDPSyncConfig(ctx, codersdk.PatchOrganizationIDPSyncConfigRequest{
 		// This disables organization sync without causing state conflicts for
-		// organization resources that might still specify `sync_mapping`.
+		// organization resources that might still specify `org_sync_idp_groups`.
 		Field: "",
 	})
 	if err != nil {