Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
lantoli committed Apr 22, 2024
1 parent c4e6e0c commit 4d7a049
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 11 deletions.
7 changes: 7 additions & 0 deletions .changelog/2185.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```release-note:breaking-change
resource/mongodbatlas_federated_settings_identity_provider: Import can only use a 24-hexadecimal digit string that identifies the IdP, `idp_id`, instead of `okta_idp_id`
```

```release-note:breaking-change
data-source/mongodbatlas_federated_settings_identity_provider: The only allowed format for `identity_provider_id` is a 24-hexadecimal digit string
```
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,15 @@ resource "mongodbatlas_federated_settings_identity_provider" "identity_provider"
data "mongodbatlas_federated_settings_identity_provider" "identity_provider_ds" {
federation_settings_id = mongodbatlas_federated_settings_identity_provider.identity_provider.id
identity_provider_id = "0oad47f7fXnk1297"
identity_provider_id = "0oad4fas87jL5Xnk12971234"
}
```

## Argument Reference

* `federation_settings_id` - (Required) Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
* `identity_provider_id` - (Required) Unique 20-hexadecimal or 24-hexadecimal digit string that identifies the IdP.

**WARNING:** Starting from terraform provider version 1.16.0, the only allowed format for `identity_provider_id` will be 24-hexadecimal digit string. See more [here](../guides/1.15.0-upgrade-guide.html.markdown)
* `identity_provider_id` - (Required) Unique 24-hexadecimal digit string that identifies the IdP.

## Attributes Reference

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ description: |-

```terraform
resource "mongodbatlas_federated_settings_identity_provider" "identity_provider" {
federation_settings_id = "627a9687f7f7f7f774de306f14"
federation_settings_id = "627a9687f7f7f7f774de306f"
name = "mongodb_federation_test"
associated_domains = ["yourdomain.com"]
sso_debug_enabled = true
Expand Down Expand Up @@ -77,7 +77,7 @@ In addition to all arguments above, the following attributes are exported:
* `audience_uri` - Identifier for the intended audience of the SAML Assertion.
* `display_name` - Human-readable label that identifies the IdP.
* `issuer_uri` - Identifier for the issuer of the SAML Assertion.
* `idp_id` - Unique 20-hexadecimal digit string that identifies the IdP.
* `idp_id` - Unique 24-hexadecimal digit string that identifies the IdP.
### Pem File Info - List that contains the file information, including: start date, and expiration date for the identity provider's PEM-encoded public key certificate.
* `not_after` - Expiration Date.
* `not_before` - Start Date.
Expand Down
5 changes: 3 additions & 2 deletions website/docs/guides/1.16.0-upgrade-guide.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ The Terraform MongoDB Atlas Provider version 1.16.0 has a number of new and exci

**New Resources, Data Sources, and Features:**


- The HashiCorp Terraform Version Compatibility Matrix has been published for the Terraform MongoDB Atlas Provider. See full details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs#hashicorp-terraform-version-compatibility-matrix

**Deprecations and Removals:**

- The HashiCorp Terraform Version Compatibility Matrix has been published for the Terraform MongoDB Atlas Provider. See full details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs#hashicorp-terraform-version-compatibility-matrix
- Format of IdP Id that uniquely identifies the identity provider when importing [`mongodbatlas_federated_settings_identity_provider`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/federated_settings_identity_provider) resource and [`mongodbatlas_federated_settings_identity_provider`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/data-sources/federated_settings_identity_provider) data source only accepts the new IdP Id format that is a 24-hex characters long string.
More info can be found in the [previous guide](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.15.0-upgrade-guide).


### Helpful Links
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,7 @@ In addition to all arguments above, the following attributes are exported:
Identity Provider **must** be imported before using federation_settings_id-idp_id, e.g.

```
$ terraform import mongodbatlas_federated_settings_identity_provider.identity_provider 6287a663c660f52b1c441c6c-0oad4fas87jL5Xnk1297
$ terraform import mongodbatlas_federated_settings_identity_provider.identity_provider 6287a663c660f52b1c441c6c-0oad4fas87jL5Xnk12971234
```

**WARNING:** Starting from terraform provider version 1.16.0, to import the resource a 24-hexadecimal digit string that identifies the IdP (`idp_id`) will have to be used instead of `okta_idp_id`. See more [here](../guides/1.15.0-upgrade-guide.html.markdown)

For more information see: [MongoDB Atlas API Reference.](https://www.mongodb.com/docs/atlas/reference/api/federation-configuration/)

0 comments on commit 4d7a049

Please sign in to comment.