Skip to content

Commit 67ad635

Browse files
doc: Fixing inconsistent docs in federated_settings_org_role_mapping associated to required attributes (#3460)
* fixing inconsistent documentation * remove human-readable term in external_group_id attribute
1 parent c713256 commit 67ad635

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

docs/data-sources/federated_settings_org_role_mapping.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,15 @@ data "mongodbatlas_federated_settings_org_role_mapping" "role_mapping" {
3838
## Argument Reference
3939

4040
* `federation_settings_id` - (Required) Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
41-
* `org_id` - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
41+
* `org_id` - (Required) Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
42+
* `role_mapping_id` - (Required) Unique 24-hexadecimal digit string that identifies this role mapping.
4243

4344
## Attributes Reference
4445

4546
In addition to all arguments above, the following attributes are exported:
4647
### FederatedSettingsOrgRoleMappings
4748

48-
* `external_group_name` - Unique human-readable label that identifies the identity provider group to which this role mapping applies.
49+
* `external_group_name` - Unique label that identifies the identity provider group to which this role mapping applies.
4950
* `id` - Unique 24-hexadecimal digit string that identifies this role mapping.
5051
* `role_assignments` - Atlas roles and the unique identifiers of the groups and organizations associated with each role.
5152
* `group_id` - Unique identifier of the project to which you want the role mapping to apply.

docs/data-sources/federated_settings_org_role_mappings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ data "mongodbatlas_federated_settings_org_role_mappings" "role_mappings" {
2626
## Argument Reference
2727

2828
* `federation_settings_id` - (Required) Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
29-
* `org_id` - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
29+
* `org_id` - (Required) Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
3030
* `page_num` - (Optional) The page to return. Defaults to `1`.
3131
* `items_per_page` - (Optional) Number of items to return per page, up to a maximum of 500. Defaults to `100`.
3232

@@ -39,7 +39,7 @@ In addition to all arguments above, the following attributes are exported:
3939

4040
### FederatedSettingsOrgRoleMappings
4141

42-
* `external_group_name` - Unique human-readable label that identifies the identity provider group to which this role mapping applies.
42+
* `external_group_name` - Unique label that identifies the identity provider group to which this role mapping applies.
4343
* `id` - Unique 24-hexadecimal digit string that identifies this role mapping.
4444
* `role_assignments` - Atlas roles and the unique identifiers of the groups and organizations associated with each role.
4545
* `group_id` - Unique identifier of the project to which you want the role mapping to apply.

docs/resources/federated_settings_org_role_mapping.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ resource "mongodbatlas_federated_settings_org_role_mapping" "org_group_role_mapp
3030
## Argument Reference
3131

3232
* `federation_settings_id` - (Required) Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
33-
* `org_id` - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
34-
* `external_group_name` - Unique human-readable label that identifies the identity provider group to which this role mapping applies.
35-
* `role_assignments` - Atlas roles and the unique identifiers of the groups and organizations associated with each role.
33+
* `org_id` - (Required) Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
34+
* `external_group_name` - (Required) Unique label that identifies the identity provider group to which this role mapping applies.
35+
* `role_assignments` - (Required) Atlas roles and the unique identifiers of the groups and organizations associated with each role.
3636
* `group_id` - Unique identifier of the project to which you want the role mapping to apply.
3737
* `roles` - Specifies the Roles that are attached to the Role Mapping. Available role IDs can be found on [the User Roles
3838
Reference](https://www.mongodb.com/docs/atlas/reference/user-roles/).

0 commit comments

Comments
 (0)