tenant

This component configures an Auth0 tenant. This component is used to configure authentication for the Terraform provider for Auth0 and to configure the Auth0 tenant itself.

Usage

Stack Level: Global

Here's an example snippet for how to use this component.

# catalog/auth0/tenant.yaml
components:
  terraform:
    auth0/tenant:
      vars:
        enabled: true
        # Make sure this name does not conflict with other Auth0 components, such as `auth0/app`
        name: auth0
        support_email: "[email protected]"
        support_url: "https://acme.com"

Auth0 Tenant Creation

Chicken before the egg...

The Auth0 tenant must exist before we can manage it with Terraform. In order to create the Auth0 application used by the Auth0 Terraform provider, we must first create the Auth0 tenant. Then once we have the Auth0 provider configured, we can import the tenant into Terraform. However, the tenant is not a resource identifiable by an ID within the Auth0 Management API! We can nevertheless import it using a random string. On first run, we import the existing tenant using a random string. It does not matter what this value is. Terraform will use the same tenant as the Auth0 application for the Terraform Auth0 Provider.

Create the Auth0 tenant now using the Auth0 Management API or the Auth0 Dashboard following the Auth0 create tenants documentation.

Provider Pre-requisites

Once the Auth0 tenant is created or you've been given access to an existing tenant, you can configure the Auth0 provider in Terraform. Follow the Auth0 provider documentation to create a Machine to Machine application.

tip

Machine to Machine App Name

Use the Context Label format for the machine name for consistency. For example, acme-plat-gbl-prod-auth0-provider.

After creating the Machine to Machine application, add the app's domain, client ID, and client secret to AWS Systems Manager Parameter Store in the same account and region as this component deployment. The path for the parameters are defined by the component deployment's Null Label context ID as follows:

auth0_domain_ssm_path        = "/${module.this.id}/domain"
auth0_client_id_ssm_path     = "/${module.this.id}/client_id"
auth0_client_secret_ssm_path = "/${module.this.id}/client_secret"

For example, if we're deploying auth0/tenant into plat-gbl-prod and my default region is us-west-2, then I would add the following parameters to the plat-prod account in us-west-2:

important

Be sure that this AWS SSM parameter path does not conflict with SSM parameters used by other Auth0 components, such as auth0/app. In both components, the SSM parameter paths are defined by the component deployment's context ID.

/acme-plat-gbl-prod-auth0/domain
/acme-plat-gbl-prod-auth0/client_id
/acme-plat-gbl-prod-auth0/client_secret

Requirements

Name	Version
terraform	>= 1.0.0
auth0	>= 1.0.0
aws	>= 4.9.0

Providers

Name	Version
auth0	>= 1.0.0
aws	>= 4.9.0

Modules

Name	Source	Version
dns_gbl_delegated	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
iam_roles	../../account-map/modules/iam-roles	n/a
this	cloudposse/label/null	0.25.0

Resources

Name	Type
auth0_custom_domain.this	resource
auth0_custom_domain_verification.this	resource
auth0_email_provider.this	resource
auth0_prompt.this	resource
auth0_tenant.this	resource
aws_route53_record.this	resource
aws_ssm_parameter.auth0_client_id	data source
aws_ssm_parameter.auth0_client_secret	data source
aws_ssm_parameter.auth0_domain	data source
aws_ssm_parameter.sendgrid_api_key	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
allowed_logout_urls	The URLs that Auth0 can redirect to after logout.	list(string)	[]	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
auth0_debug	Enable debug mode for the Auth0 provider	bool	true	no
auth0_prompt_experience	Which prompt login experience to use. Options include classic and new.	string	"new"	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
default_redirection_uri	The default redirection URI.	string	""	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
disable_clickjack_protection_headers	Whether to disable clickjack protection headers.	bool	true	no
disable_fields_map_fix	Whether to disable fields map fix.	bool	false	no
disable_management_api_sms_obfuscation	Whether to disable management API SMS obfuscation.	bool	false	no
email_provider_default_from_address	The default from address for the email provider.	string	""	no
email_provider_name	The name of the email provider. If not defined, no email provider will be created.	string	""	no
enable_public_signup_user_exists_error	Whether to enable public signup user exists error.	bool	true	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
enabled_locales	The enabled locales.	list(string)	[ "en" ]	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
friendly_name	The friendly name of the Auth0 tenant. If not provided, the module context ID will be used.	string	""	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
idle_session_lifetime	The idle session lifetime in hours.	number	72	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
no_disclose_enterprise_connections	Whether to disclose enterprise connections.	bool	false	no
oidc_logout_prompt_enabled	Whether the OIDC logout prompt is enabled.	bool	false	no
picture_url	The URL of the picture to be displayed in the Auth0 Universal Login page.	string	"https://cloudposse.com/wp-content/uploads/2017/07/CloudPosse2-TRANSAPRENT.png"	no
provider_ssm_base_path	The base path for the SSM parameters. If not defined, this is set to the module context ID. This is also required when var.enabled is set to false	string	""	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
region	AWS Region	string	n/a	yes
sandbox_version	The sandbox version.	string	"18"	no
sendgrid_api_key_ssm_path	The SSM path to the SendGrid API key. Only required if email_provider_name is sendgrid.	string	""	no
session_cookie_mode	The session cookie mode.	string	"persistent"	no
session_lifetime	The session lifetime in hours.	number	168	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
support_email	The email address to be displayed in the Auth0 Universal Login page.	string	n/a	yes
support_url	The URL to be displayed in the Auth0 Universal Login page.	string	n/a	yes
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
use_scope_descriptions_for_consent	Whether to use scope descriptions for consent.	bool	false	no

Outputs

Name	Description
auth0_domain	The Auth0 custom domain
client_id_ssm_path	The SSM parameter path for the Auth0 client ID
client_secret_ssm_path	The SSM parameter path for the Auth0 client secret
domain_ssm_path	The SSM parameter path for the Auth0 domain

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component
• Auth0 Terraform Provider
• Auth0 Documentation