Skip to content

Commit 044d6b1

Browse files
authored
doc: Update project documentation to remove api_keys references (#1386)
1 parent 47526e4 commit 044d6b1

File tree

4 files changed

+0
-24
lines changed

4 files changed

+0
-24
lines changed

examples/atlas-api-key/create-and-assign-pak-seperately/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,4 @@ Variables Required to be set:
1010
- `private_key`: Atlas private key
1111

1212
In this example, we will set up an organization API key and attach an access list to it.
13-
**Note:** in this example parameter api_keys is deprecated and will be removed in v1.12.0 release from codebase. Use `mongodbatlas_project_api_key` resource instead.
1413

website/docs/d/project.html.markdown

-2
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,6 @@ In addition to all arguments above, the following attributes are exported:
8888
* `created` - The ISO-8601-formatted timestamp of when Atlas created the project.
8989
* `teams.#.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.
9090
* `teams.#.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.
91-
* `api_keys.#.api_key_id` - The unique identifier of the programmatic API key you want to associate with the project. The programmatic API key and project must share the same parent organization.
92-
* `api_keys.#.role_names` - Each string in the array represents a project role assigned to the programmatic API key. The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#organization-roles) describes the roles a user can have.
9391
* `limits.#.name` - Human-readable label that identifies this project limit.
9492
* `limits.#.value` - Amount the limit is set to.
9593
* `limits.#.current_usage` - Amount that indicates the current usage of the limit.

website/docs/d/projects.html.markdown

-7
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,6 @@ resource "mongodbatlas_project" "test" {
3131
team_id = "5e1dd7b4f2a30ba80a70cd4rw"
3232
role_names = ["GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE"]
3333
}
34-
35-
api_keys {
36-
api_key_id = "61003b299dda8d54a9d7d10c"
37-
role_names = ["GROUP_READ_ONLY"]
38-
}
3934
4035
limits {
4136
name = "atlas.project.deployment.clusters"
@@ -68,8 +63,6 @@ data "mongodbatlas_projects" "test" {
6863
* `created` - The ISO-8601-formatted timestamp of when Atlas created the project.
6964
* `teams.#.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.
7065
* `teams.#.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.
71-
* `api_keys.#.api_key_id` - The unique identifier of the Organization Programmatic API key assigned to the Project.
72-
* `api_keys.#.role_names` - List of roles that the Organization Programmatic API key has been assigned. The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#organization-roles) describes the roles a user can have.
7366
* `limits.#.name` - Human-readable label that identifies this project limit.
7467
* `limits.#.value` - Amount the limit is set to.
7568
* `limits.#.current_usage` - Amount that indicates the current usage of the limit.

website/docs/r/project.html.markdown

-14
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,6 @@ resource "mongodbatlas_project" "test" {
3333
role_names = ["GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE"]
3434
}
3535
36-
api_keys {
37-
api_key_id = "61003b299dda8d54a9d7d10c"
38-
role_names = ["GROUP_READ_ONLY"]
39-
}
40-
4136
limits {
4237
name = "atlas.project.deployment.clusters"
4338
value = 26
@@ -83,15 +78,6 @@ Teams attribute is optional
8378

8479
~> **NOTE:** Project created by API Keys must belong to an existing organization.
8580

86-
### Programmatic API Keys
87-
api_keys allows one to assign an existing organization programmatic API key to a Project. The api_keys attribute is optional.
88-
89-
* `api_key_id` - (Required) The unique identifier of the Programmatic API key you want to associate with the Project. The Programmatic API key and Project must share the same parent organization. Note: this is not the `publicKey` of the Programmatic API key but the `id` of the key. See [Programmatic API Keys](https://docs.atlas.mongodb.com/reference/api/apiKeys/) for more.
90-
91-
**WARNING:** The `api_keys` parameter is deprecated and will be removed in v1.12.0 release from codebase. Use `mongodbatlas_project_api_key` resource instead.
92-
93-
* `role_names` - (Required) List of Project roles that the Programmatic API key needs to have. Ensure you provide: at least one role and ensure all roles are valid for the Project. You must specify an array even if you are only associating a single role with the Programmatic API key. The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-roles/#organization-roles) describes the roles a user can have.
94-
9581
### Limits
9682
`limits` allows one to configure a variety of limits to a Project. The limits attribute is optional.
9783

0 commit comments

Comments
 (0)