Deprecate auth0_tenant.universal-login

auth0 · Jul 8, 2023 · dd7c520 · dd7c520
1 parent dcb7314
commit dd7c520
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 3 deletions.
diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md
@@ -9,6 +9,7 @@ automated workflows before upgrading.
 
 - [Auth0 Global Client](#auth0-global-client)
 - [Auth0 Tenant Pages](#auth0-tenant-pages)
+- [Auth0 Tenant Universal Login](#auth0-tenant-universal-login)
 
 #### Auth0 Global Client
 
@@ -115,6 +116,48 @@ resource "auth0_pages" "my_pages" {
 </tr>
 </table>
 
+#### Auth0 Tenant Universal Login
+
+The `universal_login` settings on the `auth0_tenant` have been deprecated in favour of managing them through the `auth0_branding` resource.
+
+To ensure a smooth transition when we eventually remove the capability to manage these settings through the
+`auth0_tenant` resource, we recommend proactively migrating to the `auth0_branding` resource. This will help you stay
+prepared for future changes.
+
+<table>
+<tr>
+<th>Before (v0.49.0)</th>
+<th>After (v0.50.0)</th>
+</tr>
+<tr>
+<td>
+
+```terraform
+resource "auth0_tenant" "my_tenant" {
+  universal_login {
+    colors {
+      primary         = "#0059d6"
+      page_background = "#000000"
+    }
+  }
+}
+```
+
+</td>
+<td>
+
+```terraform
+resource "auth0_branding" "my_branding" {
+  colors {
+    primary         = "#0059d6"
+    page_background = "#000000"
+  } 
+}
+```
+
+</td>
+</tr>
+</table>
 
 ## Upgrading from v0.48.0 → v0.49.0
 

diff --git a/docs/data-sources/tenant.md b/docs/data-sources/tenant.md
@@ -39,7 +39,7 @@ data "auth0_tenant" "my_tenant" {}
 - `session_lifetime` (Number) Number of hours during which a session will stay valid.
 - `support_email` (String) Support email address for authenticating users.
 - `support_url` (String) Support URL for authenticating users.
-- `universal_login` (List of Object) Configuration settings for Universal Login. (see [below for nested schema](#nestedatt--universal_login))
+- `universal_login` (List of Object) Configuration settings for Universal Login. These configuration settings have been deprecated. Migrate to managing these settings through the `auth0_branding` resource. (see [below for nested schema](#nestedatt--universal_login))
 
 <a id="nestedatt--change_password"></a>
 ### Nested Schema for `change_password`

diff --git a/docs/resources/tenant.md b/docs/resources/tenant.md
@@ -86,7 +86,7 @@ resource "auth0_tenant" "my_tenant" {
 - `session_lifetime` (Number) Number of hours during which a session will stay valid.
 - `support_email` (String) Support email address for authenticating users.
 - `support_url` (String) Support URL for authenticating users.
-- `universal_login` (Block List, Max: 1) Configuration settings for Universal Login. (see [below for nested schema](#nestedblock--universal_login))
+- `universal_login` (Block List, Max: 1, Deprecated) Configuration settings for Universal Login. These configuration settings have been deprecated. Migrate to managing these settings through the `auth0_branding` resource. (see [below for nested schema](#nestedblock--universal_login))
 
 ### Read-Only
 

diff --git a/internal/auth0/tenant/resource.go b/internal/auth0/tenant/resource.go
@@ -346,7 +346,8 @@ func NewResource() *schema.Resource {
 				Optional:    true,
 				Computed:    true,
 				MaxItems:    1,
-				Description: "Configuration settings for Universal Login.",
+				Description: "Configuration settings for Universal Login. These configuration settings have been deprecated. Migrate to managing these settings through the `auth0_branding` resource.",
+				Deprecated:  "These configuration settings have been deprecated. Migrate to managing these settings through the `auth0_branding` resource.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"colors": {