Skip to content

Commit 5e5d02b

Browse files
authored
doc: Merges User invitations guides into one (#3642)
1 parent c41eb56 commit 5e5d02b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1127
-1116
lines changed

docs/data-sources/atlas_user.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ subcategory: "MongoDB Cloud Users"
66

77
`mongodbatlas_atlas_user` Provides a MongoDB Atlas User.
88

9-
~> **DEPRECATION:** This data source is deprecated. Use `mongodbatlas_cloud_user_org_assignment` to read organization user assignments. See the [Migration Guide: Migrate off deprecated `mongodbatlas_atlas_user` and `mongodbatlas_atlas_users`](../guides/atlas-user-migration-guide).
9+
~> **DEPRECATION:** This data source is deprecated. Use `mongodbatlas_cloud_user_org_assignment` to read organization user assignments. See the [Migration Guide: Migrate off deprecated `mongodbatlas_atlas_user` and `mongodbatlas_atlas_users`](../guides/atlas-user-management).
1010

1111
-> **NOTE:** If you are the owner of a MongoDB Atlas organization or project, you can also retrieve the user profile for any user with membership in that organization or project.
1212

@@ -31,14 +31,14 @@ data "mongodbatlas_atlas_user" "test" {
3131
* `user_id` - (Optional) Unique 24-hexadecimal digit string that identifies this user.
3232
* `username` - (Optional) Email address that belongs to the MongoDB Atlas user account. You can't modify this address after creating the user.
3333

34-
~> **IMPORTANT:** Either `user_id` or `username` must be configurated.
34+
~> **IMPORTANT:** Either `user_id` or `username` must be configured.
3535

3636
## Attributes Reference
3737

3838
In addition to all arguments above, the following attributes are exported:
3939
* `country` - Two alphabet characters that identifies MongoDB Atlas user's geographic location. This parameter uses the ISO 3166-1a2 code format.
4040
* `created_at` - Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.
41-
* `email_address` - **(DEPRECATED)** Email address that belongs to the MongoDB Atlas user.
41+
* `email_address` - **(DEPRECATED)** Email address that belongs to the MongoDB Atlas user. This attribute is deprecated and will be removed in the next major release. Please transition to `data.mongodbatlas_organization.users.username`, `data.mongodbatlas_team.users.username` or `data.mongodbatlas_project.users.username` attributes. For more details, see [Migration Guide: Migrate off deprecated `mongodbatlas_atlas_user` and `mongodbatlas_atlas_users`](../guides/atlas-user-management)."
4242
* `first_name` - First or given name that belongs to the MongoDB Atlas user.
4343
* `last_auth` - Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
4444
* `last_name` - Last name, family name, or surname that belongs to the MongoDB Atlas user.

docs/data-sources/atlas_users.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ subcategory: "MongoDB Cloud Users"
66

77
`atlas_users` provides Atlas Users associated with a specified Organization, Project, or Team.
88

9-
~> **DEPRECATION:** This data source is deprecated. Replace it with the `users` attribute on `mongodbatlas_organization`, `mongodbatlas_project`, or `mongodbatlas_team` data sources, depending on scope. See the [Migration Guide: Migrate off deprecated `mongodbatlas_atlas_user` and `mongodbatlas_atlas_users`](../guides/atlas-user-migration-guide).
9+
~> **DEPRECATION:** This data source is deprecated. Replace it with the `users` attribute on `mongodbatlas_organization`, `mongodbatlas_project`, or `mongodbatlas_team` data sources, depending on scope. See the [Migration Guide: Migrate off deprecated `mongodbatlas_atlas_user` and `mongodbatlas_atlas_users`](../guides/atlas-user-management).
1010

1111
-> **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation.
1212

@@ -60,7 +60,7 @@ In addition to all arguments above, the following attributes are exported:
6060
* `username` - Email address that belongs to the MongoDB Atlas user account. You cannot modify this address after creating the user.
6161
* `country` - Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
6262
* `created_at` - Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.
63-
* `email_address` - **(DEPRECATED)** Email address that belongs to the MongoDB Atlas user.
63+
* `email_address` - **(DEPRECATED)** Email address that belongs to the MongoDB Atlas user. This attribute is deprecated and will be removed in the next major release. Please transition to `data.mongodbatlas_organization.users.username`, `data.mongodbatlas_team.users.username` or `data.mongodbatlas_project.users.username` attributes. For more details, see [Migration Guide: Migrate off deprecated `mongodbatlas_atlas_user` and `mongodbatlas_atlas_users`](../guides/atlas-user-management)."
6464
* `first_name` - First or given name that belongs to the MongoDB Atlas user.
6565
* `last_auth` - Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
6666
* `last_name` - Last name, family name, or surname that belongs to the MongoDB Atlas user.

docs/data-sources/cloud_user_org_assignment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ subcategory: "MongoDB Cloud Users"
88

99
**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)
1010
endpoint are not returned with this resource. See [MongoDB Atlas API](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationuser) for details.
11-
To manage such users with this resource, refer to our [Org Invitation to Cloud User Org Assignment Migration Guide](../guides/org-invitation-to-cloud-user-org-assignment-migration-guide).
11+
To manage such users with this resource, refer to our [Org Invitation to Cloud User Org Assignment Migration Guide](../guides/atlas-user-management).
1212

1313
## Example Usages
1414

docs/data-sources/cloud_user_project_assignment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ subcategory: "MongoDB Cloud Users"
88

99
-> **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)
1010
endpoint are not returned with this resource. See [MongoDB Atlas API](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectteam) for details.
11-
To manage such users with this resource, refer to our [Project Invitation to Cloud User Project Assignment Migration Guide](../guides/project-invitation-to-cloud-user-project-assignment-migration-guide).
11+
To manage such users with this resource, refer to our [Project Invitation to Cloud User Project Assignment Migration Guide](../guides/atlas-user-management).
1212

1313
## Example Usages
1414

docs/data-sources/cloud_user_team_assignment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ subcategory: "MongoDB Cloud Users"
88

99
-> **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)
1010
endpoint are not returned with this resource. See [MongoDB Atlas API](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listteamusers) for details.
11-
To manage such users with this resource, refer to our [Migration Guide: Team Usernames Attribute to Cloud User Team Assignment](../guides/cloud-user-team-assignment-migration-guide).
11+
To manage such users with this resource, refer to our [Migration Guide: Team Usernames Attribute to Cloud User Team Assignment](../guides/atlas-user-management).
1212

1313
## Example Usages
1414

docs/data-sources/org_invitation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ subcategory: "Organizations"
66

77
`mongodbatlas_org_invitation` describes an invitation for a user to join an Atlas organization.
88

9-
~> **DEPRECATION:** This data source is deprecated. Use `mongodbatlas_cloud_user_org_assignment` to read organization user assignments. See the [Org Invitation to Cloud User Org Assignment Migration Guide](../guides/org-invitation-to-cloud-user-org-assignment-migration-guide).
9+
~> **DEPRECATION:** This data source is deprecated. Use `mongodbatlas_cloud_user_org_assignment` to read organization user assignments. See the [Org Invitation to Cloud User Org Assignment Migration Guide](../guides/atlas-user-management).
1010

1111
## Example Usage
1212

docs/data-sources/organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ In addition to all arguments above, the following attributes are exported:
5454

5555

5656
~> **NOTE:** - Users with pending invitations created using [`mongodbatlas_project_invitation`](../resources/project_invitation.md) resource or via the deprecated [Invite One MongoDB Cloud User to Join One Project](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectinvitation) endpoint are excluded (or cannot be managed) with this resource. See [MongoDB Atlas API - MongoDB Cloud Users](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-mongodb-cloud-users) for details.
57-
To manage these users with this resource/data source, refer to our [Org Invitation to Cloud User Org Assignment Migration Guide](../guides/org-invitation-to-cloud-user-org-assignment-migration-guide).
57+
To manage these users with this resource/data source, refer to our [Org Invitation to Cloud User Org Assignment Migration Guide](../guides/atlas-user-management).
5858

5959

6060

docs/data-sources/organizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ data "mongodbatlas_organizations" "test" {
5959

6060

6161
~> **NOTE:** - Users with pending invitations created using [`mongodbatlas_project_invitation`](../resources/project_invitation.md) resource or via the deprecated [Invite One MongoDB Cloud User to Join One Project](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectinvitation) endpoint are excluded (or cannot be managed) with this resource. See [MongoDB Atlas API - MongoDB Cloud Users](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-mongodb-cloud-users) for details.
62-
To manage these users with this resource/data source, refer to our [Org Invitation to Cloud User Org Assignment Migration Guide](../guides/org-invitation-to-cloud-user-org-assignment-migration-guide).
62+
To manage these users with this resource/data source, refer to our [Org Invitation to Cloud User Org Assignment Migration Guide](../guides/atlas-user-management).
6363

6464

6565
~> **NOTE:** - If you create an organization with our Terraform provider version >=1.30.0, this field is set to `true` by default.<br> - If you have an existing organization created with our Terraform provider version <1.30.0, this field might be `false`, which is the [API default value](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorganization). To prevent the creation of future default alerts, set this explicitly to `true` using the [`mongodbatlas_organization`](../resources/organization.md) resource.

docs/data-sources/project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ In addition to all arguments above, the following attributes are exported:
9898

9999
### Teams
100100

101-
~> **DEPRECATION:** This attribute is deprecated and will be removed in the next major release. Please transition to `mongodbatlas_team_project_assignment`. For more details, see [Migration Guide: Project Teams Attribute to Team Project Assignment Resource](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/team_project_assignment_migration_guide).
101+
~> **DEPRECATION:** This attribute is deprecated and will be removed in the next major release. Please transition to `mongodbatlas_team_project_assignment`. For more details, see [Migration Guide: Project Teams Attribute to Team Project Assignment Resource](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/atlas-user-management).
102102

103103
* `team_id` - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
104104
* `role_names` - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#organization-roles) describes the roles a user can have.

docs/data-sources/project_invitation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ subcategory: "Projects"
66

77
`mongodbatlas_project_invitation` describes an invitation to a user to join an Atlas project.
88

9-
~> **DEPRECATION:** This data source is deprecated. Use `mongodbatlas_cloud_user_project_assignment` to read project user assignments. See the [Project Invitation to Cloud User Project Assignment Migration Guide](../guides/project-invitation-to-cloud-user-project-assignment-migration-guide).
9+
~> **DEPRECATION:** This data source is deprecated. Use `mongodbatlas_cloud_user_project_assignment` to read project user assignments. See the [Project Invitation to Cloud User Project Assignment Migration Guide](../guides/atlas-user-management).
1010

1111
-> **NOTE:** Groups and projects are synonymous terms. You may find GROUP-ID in the official documentation.
1212

0 commit comments

Comments
 (0)