Update docs and examples (#1143)

* Uodate docs and examples * Updated docs * Updated docs * Updated docs for is_first_party --------- Co-authored-by: Rajat Bajaj <rajat.bajaj@okta.com>
auth0 · Feb 28, 2025 · 43c35ed · 43c35ed
1 parent 08143bf
commit 43c35ed
Show file tree

Hide file tree

Showing 10 changed files with 112 additions and 15 deletions.
diff --git a/docs/data-sources/client.md b/docs/data-sources/client.md
@@ -54,7 +54,7 @@ data "auth0_client" "some-client-by-id" {
 - `grant_types` (List of String) Types of grants that this client is authorized to use.
 - `id` (String) The ID of this resource.
 - `initiate_login_uri` (String) Initiate login URI. Must be HTTPS or an empty string.
-- `is_first_party` (Boolean) Indicates whether this client is a first-party client.
+- `is_first_party` (Boolean) Indicates whether this client is a first-party client.Defaults to true from the API
 - `is_token_endpoint_ip_header_trusted` (Boolean) Indicates whether the token endpoint IP header is trusted. Requires the authentication method to be set to `client_secret_post` or `client_secret_basic`. Setting this property when creating the resource, will default the authentication method to `client_secret_post`. To change the authentication method to `client_secret_basic` use the `auth0_client_credentials` resource.
 - `jwt_configuration` (List of Object) Configuration settings for the JWTs issued for this client. (see [below for nested schema](#nestedatt--jwt_configuration))
 - `logo_uri` (String) URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.

diff --git a/docs/resources/action.md b/docs/resources/action.md
@@ -8,6 +8,12 @@ description: |-
 
 Actions are secure, tenant-specific, versioned functions written in Node.js that execute at certain points during the Auth0 runtime. Actions are used to customize and extend Auth0's capabilities with custom logic.
 
+-> An action bound to a trigger cannot be deleted. To destroy such an action, the trigger binding must first be deleted.
+A binding is usually managed by [auth0_trigger_action](https://registry.terraform.io/providers/auth0/auth0/latest/docs/resources/trigger_action) resource.
+The provider also supports a 1:many variant [auth0_trigger_actions](https://registry.terraform.io/providers/auth0/auth0/latest/docs/resources/trigger_actions).
+If by any means, a binding is missing is the state file, it can be imported to the state and deleted, before attempting to delete the action.
+
+
 ## Example Usage
 
 ```terraform

diff --git a/docs/resources/client.md b/docs/resources/client.md
@@ -140,7 +140,7 @@ resource "auth0_client" "my_client" {
 - `form_template` (String) HTML form template to be used for WS-Federation.
 - `grant_types` (List of String) Types of grants that this client is authorized to use.
 - `initiate_login_uri` (String) Initiate login URI. Must be HTTPS or an empty string.
-- `is_first_party` (Boolean) Indicates whether this client is a first-party client.
+- `is_first_party` (Boolean) Indicates whether this client is a first-party client.Defaults to true from the API
 - `is_token_endpoint_ip_header_trusted` (Boolean) Indicates whether the token endpoint IP header is trusted. Requires the authentication method to be set to `client_secret_post` or `client_secret_basic`. Setting this property when creating the resource, will default the authentication method to `client_secret_post`. To change the authentication method to `client_secret_basic` use the `auth0_client_credentials` resource.
 - `jwt_configuration` (Block List, Max: 1) Configuration settings for the JWTs issued for this client. (see [below for nested schema](#nestedblock--jwt_configuration))
 - `logo_uri` (String) URL of the logo for the client. Recommended size is 150px x 150px. If none is set, the default badge for the application type will be shown.

diff --git a/docs/resources/email_provider.md b/docs/resources/email_provider.md
@@ -8,6 +8,9 @@ description: |-
 
 With Auth0, you can have standard welcome, password reset, and account verification email-based workflows built right into Auth0. This resource allows you to configure email providers, so you can route all emails that are part of Auth0's authentication workflows through the supported high-volume email service of your choice.
 
+-> For configuring a custom email provider, an action with supported triggers custom-email-provider must exist.
+
+
 ## Example Usage
 
 ```terraform
@@ -75,10 +78,35 @@ resource "auth0_email_provider" "ms365_email_provider" {
   }
 }
 
-# This is an example on how to set up the email provider with a custom action.
-# Make sure a corresponding action exists with custom-email-provider as supported triggers
+# Below is an example of how to set up a custom email provider.
+# The action with custom-email-provider as supported_triggers is a prerequisite.
+resource "auth0_action" "custom_email_provider_action" {
+  name    = "custom-email-provider-action"
+  runtime = "node18"
+  deploy  = true
+  code    = <<-EOT
+  /**
+   * Handler to be executed while sending an email notification.
+   *
+   * @param {Event} event - Details about the user and the context in which they are logging in.
+   * @param {CustomEmailProviderAPI} api - Methods and utilities to help change the behavior of sending a email notification.
+   */
+   exports.onExecuteCustomEmailProvider = async (event, api) => {
+    // Code goes here
+    console.log(event);
+    return;
+   };
+  EOT
+
+  supported_triggers {
+    id      = "custom-email-provider"
+    version = "v1"
+  }
+}
+
 resource "auth0_email_provider" "custom_email_provider" {
-  name                 = "custom"
+  depends_on           = [auth0_action.custom_email_provider_action] # Ensuring the action is created first with `custom-email-provider` as the supported_triggers
+  name                 = "custom"                                    # Indicates a custom implementation
   enabled              = true
   default_from_address = "accounts@example.com"
   credentials {}

diff --git a/docs/resources/trigger_action.md b/docs/resources/trigger_action.md
@@ -45,7 +45,7 @@ resource "auth0_trigger_action" "post_login_alert_action" {
 ### Required
 
 - `action_id` (String) The ID of the action to bind to the trigger.
-- `trigger` (String) The ID of the trigger to bind with. Available options: `post-login`, `credentials-exchange`, `pre-user-registration`, `post-user-registration`, `post-change-password`, `send-phone-message`, `password-reset-post-challenge`, `custom-token-exchange`, `custom-email-provider`.
+- `trigger` (String) The ID of the trigger to bind with. Available options: `post-login`, `credentials-exchange`, `pre-user-registration`, `post-user-registration`, `post-change-password`, `send-phone-message`, `password-reset-post-challenge`, `custom-email-provider`.
 
 ### Optional
 

diff --git a/examples/resources/auth0_email_provider/resource.tf b/examples/resources/auth0_email_provider/resource.tf
@@ -62,10 +62,35 @@ resource "auth0_email_provider" "ms365_email_provider" {
   }
 }
 
-# This is an example on how to set up the email provider with a custom action.
-# Make sure a corresponding action exists with custom-email-provider as supported triggers
+# Below is an example of how to set up a custom email provider.
+# The action with custom-email-provider as supported_triggers is a prerequisite.
+resource "auth0_action" "custom_email_provider_action" {
+  name    = "custom-email-provider-action"
+  runtime = "node18"
+  deploy  = true
+  code    = <<-EOT
+  /**
+   * Handler to be executed while sending an email notification.
+   *
+   * @param {Event} event - Details about the user and the context in which they are logging in.
+   * @param {CustomEmailProviderAPI} api - Methods and utilities to help change the behavior of sending a email notification.
+   */
+   exports.onExecuteCustomEmailProvider = async (event, api) => {
+    // Code goes here
+    console.log(event);
+    return;
+   };
+  EOT
+
+  supported_triggers {
+    id      = "custom-email-provider"
+    version = "v1"
+  }
+}
+
 resource "auth0_email_provider" "custom_email_provider" {
-  name                 = "custom"
+  depends_on           = [auth0_action.custom_email_provider_action] # Ensuring the action is created first with `custom-email-provider` as the supported_triggers
+  name                 = "custom"                                    # Indicates a custom implementation
   enabled              = true
   default_from_address = "accounts@example.com"
   credentials {}

diff --git a/internal/auth0/action/resource_trigger_action.go b/internal/auth0/action/resource_trigger_action.go
@@ -38,10 +38,9 @@ func NewTriggerActionResource() *schema.Resource {
 					"post-change-password",
 					"send-phone-message",
 					"password-reset-post-challenge",
-					"custom-token-exchange",
 					"custom-email-provider",
 				}, false),
-				Description: "The ID of the trigger to bind with. Available options: `post-login`, `credentials-exchange`, `pre-user-registration`, `post-user-registration`, `post-change-password`, `send-phone-message`, `password-reset-post-challenge`, `custom-token-exchange`, `custom-email-provider`.",
+				Description: "The ID of the trigger to bind with. Available options: `post-login`, `credentials-exchange`, `pre-user-registration`, `post-user-registration`, `post-change-password`, `send-phone-message`, `password-reset-post-challenge`, `custom-email-provider`.",
 			},
 			"action_id": {
 				Type:        schema.TypeString,

diff --git a/internal/auth0/client/resource.go b/internal/auth0/client/resource.go
@@ -77,10 +77,11 @@ func NewResource() *schema.Resource {
 					"If none is set, the default badge for the application type will be shown.",
 			},
 			"is_first_party": {
-				Type:        schema.TypeBool,
-				Optional:    true,
-				Computed:    true,
-				Description: "Indicates whether this client is a first-party client.",
+				Type:     schema.TypeBool,
+				Optional: true,
+				Computed: true,
+				Description: "Indicates whether this client is a first-party client." +
+					"Defaults to true from the API",
 			},
 			"is_token_endpoint_ip_header_trusted": {
 				Type:     schema.TypeBool,

diff --git a/templates/resources/action.md.tmpl b/templates/resources/action.md.tmpl
@@ -8,6 +8,12 @@ description: |-
 
 {{ .Description | trimspace }}
 
+-> An action bound to a trigger cannot be deleted. To destroy such an action, the trigger binding must first be deleted.
+A binding is usually managed by [auth0_trigger_action](https://registry.terraform.io/providers/auth0/auth0/latest/docs/resources/trigger_action) resource.
+The provider also supports a 1:many variant [auth0_trigger_actions](https://registry.terraform.io/providers/auth0/auth0/latest/docs/resources/trigger_actions).
+If by any means, a binding is missing is the state file, it can be imported to the state and deleted, before attempting to delete the action.
+
+
 {{ if .HasExample -}}
 
 ## Example Usage

diff --git a/templates/resources/email_provider.md.tmpl b/templates/resources/email_provider.md.tmpl
@@ -0,0 +1,32 @@
+---
+page_title: "{{.Type}}: {{.Name}}"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Type}}: {{.Name}}
+
+{{ .Description | trimspace }}
+
+-> For configuring a custom email provider, an action with supported triggers custom-email-provider must exist.
+
+
+{{ if .HasExample -}}
+
+## Example Usage
+
+{{ tffile .ExampleFile }}
+
+{{- end }}
+
+{{ .SchemaMarkdown | trimspace }}
+
+{{ if .HasImport -}}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" .ImportFile }}
+
+{{- end }}