doc: Adds example & documentation for new `mongodbatlas_cloud_user_team_assignment` resource #3578

csanx · 2025-08-11T08:57:20Z

Description

Adds example & documentation for new mongodbatlas_cloud_user_team_assignment resource

Link to any related issue(s): CLOUDP-333178

Type of change:

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
If changes include deprecations or removals I have added appropriate changelog entries.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

…-mongodbatlas into CLOUDP-333178

This reverts commit 9f0f5b2.

github-actions · 2025-08-11T13:15:45Z

APIx bot: a message has been sent to Docs Slack channel

Copilot

Pull Request Overview

This PR adds comprehensive documentation and examples for the new mongodbatlas_cloud_user_team_assignment resource and data source, enabling users to assign and manage MongoDB Cloud users within teams.

Key changes:

Adds documentation templates for both resource and data source
Creates complete example implementation with Terraform configuration files
Generates final documentation files with schema details and usage examples

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
templates/resources/cloud_user_team_assignment.md.tmpl	Template for resource documentation with import instructions
templates/data-sources/cloud_user_team_assignment.md.tmpl	Template for data source documentation
examples/mongodbatlas_cloud_user_team_assignment/*.tf	Complete Terraform example with provider, variables, main config, and outputs
examples/mongodbatlas_cloud_user_team_assignment/README.md	Example usage documentation
docs/resources/cloud_user_team_assignment.md	Generated resource documentation with schema
docs/data-sources/cloud_user_team_assignment.md	Generated data source documentation with schema

templates/resources/cloud_user_team_assignment.md.tmpl

Copilot · 2025-08-11T13:17:09Z

templates/resources/cloud_user_team_assignment.md.tmpl

+
+-> **NOTE**Users with pending invitations created using the deprecated `mongodbatlas_project_invitation` resource or via the deprecated [Invite One MongoDB Cloud User to One Project](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationuser#tag/Projects/operation/createProjectInvitation)
+endpoint cannot be managed with this resource. See [MongoDB Atlas API](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listteamusers) for details.
+To manage such users with this resource, refer to our [migration guide]<link-to-migration-guide>.


The migration guide link is incomplete with placeholder text '' instead of an actual URL.

Suggested change

To manage such users with this resource, refer to our [migration guide]<link-to-migration-guide>.

To manage such users with this resource, refer to our [migration guide](https://www.mongodb.com/docs/atlas/migrate-cloud-user-team-assignment).

All placeholders will be addressed as part of this ticket CLOUDP-329711

templates/data-sources/cloud_user_team_assignment.md.tmpl

docs/resources/cloud_user_team_assignment.md

docs/data-sources/cloud_user_team_assignment.md

EspenAlbert · 2025-08-11T13:49:58Z

examples/mongodbatlas_cloud_user_team_assignment/main.tf

@@ -0,0 +1,17 @@
+resource "mongodbatlas_cloud_user_team_assignment" "example" {


Should the data sources depend on the resource?

I had the same question earlier but couldn’t find an example where depends_on is used, only data sources using it when a different resource is needed.
Also, we didn’t include this in cloud_user_org_assignment docs #3493, so I did not included it here for consistency.

Have you run the example? I suspect it will fail, since the data source will get NOT FOUND until the resource is created. But maybe we are handling that?

Yes, it fails. The cloud_user_org_assignment example fails for the same reason. Agustin pointed out that the other examples I reviewed without depends_on implicitly depend on the resource because they reference its attributes, so it’s a different situation.
I’ll update both examples to include a depends_on

marcosuma · 2025-08-11T13:51:40Z

docs/data-sources/cloud_user_team_assignment.md

@@ -0,0 +1,75 @@
+# Data Source: mongodbatlas_cloud_user_team_assignment


not related to this PR, but in case you didn't know, you can use https://registry.terraform.io/tools/doc-preview - learned it from @AgustinBettati

it's also in the makefile

terraform-provider-mongodbatlas/Makefile

Line 121 in 8dcf547

@echo "Use this site to preview markdown rendering: https://registry.terraform.io/tools/doc-preview"

Already used that! It was super helpful for detecting small issues 👍🏻

marcosuma · 2025-08-11T13:53:07Z

docs/resources/cloud_user_team_assignment.md

+
+-> **NOTE**Users with pending invitations created using the deprecated `mongodbatlas_project_invitation` resource or via the deprecated [Invite One MongoDB Cloud User to One Project](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationuser#tag/Projects/operation/createProjectInvitation)
+endpoint cannot be managed with this resource. See [MongoDB Atlas API](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listteamusers) for details.
+To manage such users with this resource, refer to our [migration guide]<link-to-migration-guide>.


one note: to make sure we really don't forget these placeholder links (<link-to-migration-guide>) I would probably stay consistent with the same keyword (the one you've used <link-to-migration-guide> is ok) and then create a CLOUDP ticket to search for all those occurrences.

This is valid if you're planning to merge this PR with that placeholder.

Sure, we already have a ticket CLOUDP-329711
I updated the description to flag that this is the specific keyword.

marcosuma · 2025-08-11T14:02:04Z

examples/mongodbatlas_cloud_user_team_assignment/README.md

@@ -0,0 +1,28 @@
+# Example: mongodbatlas_cloud_user_team_assignment


@maastha @csanx this example is great. Will we have one example created specifically for the migration though? Like we had when we've created mongodbatlas_api_key_assignment and had to provide a migration path for mongodbatlas_project_api_key (https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_api_key_assignment/module/old_module)

I think what you are suggesting will be done in the following tickets, that are specifically for designing the migration guides.

jwilliams-mongo · 2025-08-11T22:18:50Z

docs/data-sources/cloud_user_team_assignment.md

+
+Read-Only:
+
+- `org_roles` (Set of String) One or more organization level roles to assign the MongoDB Cloud user.


we usually use "list" or "array" in the docs instead of "set". Does the distinction matter here?

Autogenerated

jwilliams-mongo · 2025-08-11T22:21:16Z

docs/data-sources/cloud_user_team_assignment.md

+
+### Required
+
+- `org_id` (String) Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.


data types here should all be lowercase. i.e. (String) -> (string)

another question here: do we usually add the data type? looking over a smattering of resource and data source examples and I don't see this as a common convention. Is this from the generated schema?

Yes, autogenerated

jwilliams-mongo · 2025-08-11T22:21:52Z

docs/data-sources/cloud_user_team_assignment.md

+- `mobile_number` (String) Mobile phone number that belongs to the MongoDB Cloud user.
+- `org_membership_status` (String) String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.
+- `roles` (Attributes) Organization and project level roles to assign the MongoDB Cloud user within one organization. (see [below for nested schema](#nestedatt--roles))
+- `team_ids` (Set of String) List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.


see comment below as well re: set

Suggested change

- `team_ids` (Set of String) List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

- `team_ids` (set of strings) List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

Autogenerated

jwilliams-mongo · 2025-08-11T22:22:53Z

docs/data-sources/cloud_user_team_assignment.md

+- `last_name` (String) Last name, family name, or surname that belongs to the MongoDB Cloud user.
+- `mobile_number` (String) Mobile phone number that belongs to the MongoDB Cloud user.
+- `org_membership_status` (String) String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.
+- `roles` (Attributes) Organization and project level roles to assign the MongoDB Cloud user within one organization. (see [below for nested schema](#nestedatt--roles))


we don't often use "attributes" in the docs. Is this an object / list of objects?

Autogenerated

jwilliams-mongo · 2025-08-11T22:25:40Z

docs/data-sources/cloud_user_team_assignment.md

+
+Read-Only:
+
+- `org_roles` (Set of String) One or more organization level roles to assign the MongoDB Cloud user.


string should be plural

Autogenerated

docs/resources/cloud_user_team_assignment.md

jwilliams-mongo · 2025-08-11T22:27:29Z

docs/resources/cloud_user_team_assignment.md

+### Required
+
+- `org_id` (String) Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+- `team_id` (String) Unique 24-hexadecimal digit string that identifies the team to which you want to assign the MongoDB Cloud user. Use the [/teams](#tag/Teams/operation/listTeams) endpoint to retrieve all teams to which the authenticated user has access.


I think this relative link should be replaced with an absolute one

jwilliams-mongo · 2025-08-11T22:28:23Z

docs/data-sources/cloud_user_team_assignment.md

+### Required
+
+- `org_id` (String) Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.
+- `team_id` (String) Unique 24-hexadecimal digit string that identifies the team to which you want to assign the MongoDB Cloud user. Use the [/teams](#tag/Teams/operation/listTeams) endpoint to retrieve all teams to which the authenticated user has access.


replace relative link with absolute link to API docs. Or should this be updated to link to a terraform construct?

jwilliams-mongo · 2025-08-11T22:31:39Z

docs/resources/cloud_user_team_assignment.md

@@ -0,0 +1,82 @@
+# Resource: mongodbatlas_cloud_user_team_assignment
+
+`mongodbatlas_cloud_user_team_assignment` provides a Cloud User Team Assignment resource. The resource lets you import, assign, remove, or update a user to a team.


"update a user to a team" is somewhat uncommon construction. Is there a different verb we could use to better describe the behavior?

csanx · 2025-08-12T09:36:19Z

Thanks for the review @jwilliams-mongo! Most of your comments refer to autogenerated parts of the documentation, which I can’t change manually. This convention is more recent, so only newer resources follow it (e.g., mongodbatlas_api_key_project_assignment, mongodbatlas_flex_cluster).

Generating the documentation automatically will ensure consistency across all docs created from now on. I’ll mark in your suggestions which sections are autogenerated so it’s clear which ones I cannot address.

Cristina Sánchez Sánchez and others added 17 commits August 10, 2025 10:55

Examples

f25e9fb

Templates

0620e28

Docs

a703608

Fix

3bca669

Fix

af7ec69

Merge branch 'CLOUDP-320243-dev-2.0.0' into CLOUDP-333178

cab6da4

Fix

58239c8

Fix

2e93e1c

Fix

37f9fdb

Fix

30c2ebe

Fix whitespace

e70006f

fix indent

2696488

Fix

9f0f5b2

Regenerated docs

932b810

Merge branch 'CLOUDP-333178' of github.com:mongodb/terraform-provider…

a3af51e

…-mongodbatlas into CLOUDP-333178

Revert "Fix"

686b2a2

This reverts commit 9f0f5b2.

Fix indent

40cd414

csanx marked this pull request as ready for review August 11, 2025 13:15

Copilot AI review requested due to automatic review settings August 11, 2025 13:15

csanx requested review from a team as code owners August 11, 2025 13:15

Copilot AI reviewed Aug 11, 2025

View reviewed changes

EspenAlbert reviewed Aug 11, 2025

View reviewed changes

marcosuma approved these changes Aug 11, 2025

View reviewed changes

jwilliams-mongo reviewed Aug 11, 2025

View reviewed changes

Cristina Sánchez Sánchez added 2 commits August 12, 2025 11:53

Addressed comments

6423910

Formatting fix

4cea9e1

	To manage such users with this resource, refer to our [migration guide]<link-to-migration-guide>.
	To manage such users with this resource, refer to our [migration guide](https://www.mongodb.com/docs/atlas/migrate-cloud-user-team-assignment).

		@@ -0,0 +1,17 @@
		resource "mongodbatlas_cloud_user_team_assignment" "example" {

		@@ -0,0 +1,75 @@
		# Data Source: mongodbatlas_cloud_user_team_assignment

		@@ -0,0 +1,28 @@
		# Example: mongodbatlas_cloud_user_team_assignment


		Read-Only:

		- `org_roles` (Set of String) One or more organization level roles to assign the MongoDB Cloud user.


		### Required

		- `org_id` (String) Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.

	- `team_ids` (Set of String) List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.
	- `team_ids` (set of strings) List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

		@@ -0,0 +1,82 @@
		# Resource: mongodbatlas_cloud_user_team_assignment

		`mongodbatlas_cloud_user_team_assignment` provides a Cloud User Team Assignment resource. The resource lets you import, assign, remove, or update a user to a team.

doc: Adds example & documentation for new mongodbatlas_cloud_user_team_assignment resource #3578

Are you sure you want to change the base?

doc: Adds example & documentation for new mongodbatlas_cloud_user_team_assignment resource #3578

Conversation

csanx commented Aug 11, 2025

Description

Type of change:

Required Checklist:

Further comments

Uh oh!

github-actions bot commented Aug 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

doc: Adds example & documentation for new `mongodbatlas_cloud_user_team_assignment` resource #3578

doc: Adds example & documentation for new `mongodbatlas_cloud_user_team_assignment` resource #3578