feat(#2535): add support for realm_id in okta_user resource and data_… (#2536)

Author: tim-koehler

okta/services/idaas/data_source_okta_user.go

@@ -85,6 +85,11 @@ func dataSourceUser() *schema.Resource {
 				Default:     false,
 				Description: "Do not populate user roles information (prevents additional API call)",
 			},
+			"realm_id": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The Realm ID associated with the user.",
+			},
 		}),
 		Description: "Get a single users from Okta.",
 	}

okta/services/idaas/data_source_okta_users.go

@@ -57,6 +57,11 @@ func dataSourceUsers() *schema.Resource {
 								Type:     schema.TypeString,
 								Computed: true,
 							},
+							"realm_id": {
+								Type:        schema.TypeString,
+								Computed:    true,
+								Description: "The Realm ID associated with the user.",
+							},
 						}),
 				},
 			},

okta/services/idaas/resource_okta_user.go

@@ -302,6 +302,12 @@ func resourceUser() *schema.Resource {
 				Sensitive:   true,
 				Description: "User Password Recovery Answer",
 			},
+			"realm_id": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Computed:    true,
+				Description: "The Realm ID to associate the user with",
+			},
 			// lintignore:S018
 			"password_hash": {
 				Type:        schema.TypeSet,
@@ -432,6 +438,11 @@ func resourceUserCreate(ctx context.Context, d *schema.ResourceData, meta interf
 		Profile:     profile,
 		Credentials: uc,
 	}
+
+	if realmId, ok := d.GetOk("realm_id"); ok {
+		userBody.RealmId = utils.StringPtr(realmId.(string))
+	}
+
 	client := getOktaClientFromMetadata(meta)
 	user, _, err := client.User.CreateUser(ctx, userBody, qp)
 	if err != nil {
@@ -495,6 +506,7 @@ func resourceUserUpdate(ctx context.Context, d *schema.ResourceData, meta interf
 
 	// There are a few requests here so just making sure the state gets updated per successful downstream change
 	userChange := hasProfileChange(d)
+	realmChange := d.HasChange("realm_id")
 	passwordChange := d.HasChange("password")
 	passwordHashChange := d.HasChange("password_hash")
 	passwordHookChange := d.HasChange("password_inline_hook")
@@ -527,7 +539,7 @@ func resourceUserUpdate(ctx context.Context, d *schema.ResourceData, meta interf
 		return diag.Errorf("Only the status of a DEPROVISIONED user can be updated, we detected other change")
 	}
 
-	if userChange || passwordHashChange || passwordHookChange {
+	if userChange || realmChange || passwordHashChange || passwordHookChange {
 		profile := populateUserProfile(d)
 		userBody := sdk.User{
 			Profile: profile,
@@ -549,6 +561,11 @@ func resourceUserUpdate(ctx context.Context, d *schema.ResourceData, meta interf
 				},
 			}
 		}
+
+		if realmId, ok := d.GetOk("realm_id"); ok {
+			userBody.RealmId = utils.StringPtr(realmId.(string))
+		}
+
 		_, _, err := client.User.UpdateUser(ctx, d.Id(), userBody, nil)
 		if err != nil {
 			return diag.Errorf("failed to update user: %v", err)

okta/services/idaas/user.go

@@ -403,6 +403,9 @@ func flattenUser(u *sdk.User, filteredCustomAttributes []string) map[string]inte
 	}
 
 	attrs["status"] = mapStatus(u.Status)
+	if u.RealmId != nil {
+		attrs["realm_id"] = u.RealmId
+	}
 
 	data, _ := json.Marshal(customAttributes)
 	attrs["custom_profile_attributes"] = string(data)

sdk/v2_createUserRequest.go

@@ -6,4 +6,5 @@ type CreateUserRequest struct {
 	GroupIds    []string         `json:"groupIds,omitempty"`
 	Profile     *UserProfile     `json:"profile,omitempty"`
 	Type        *UserType        `json:"type,omitempty"`
+	RealmId     *string          `json:"realmId,omitempty"`
 }

sdk/v2_user.go

@@ -26,6 +26,7 @@ type User struct {
 	StatusChanged         *time.Time       `json:"statusChanged,omitempty"`
 	TransitioningToStatus string           `json:"transitioningToStatus,omitempty"`
 	Type                  *UserType        `json:"type,omitempty"`
+	RealmId               *string          `json:"realmId,omitempty"`
 }
 
 // Creates a new user in your Okta organization with or without credentials.