Awesome

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: "tech@acme.com"
        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
<a name="requirement_terraform"></a> terraform	>= 1.0.0
<a name="requirement_auth0"></a> auth0	>= 1.0.0
<a name="requirement_aws"></a> aws	>= 4.9.0

Providers

Name	Version
<a name="provider_auth0"></a> auth0	>= 1.0.0
<a name="provider_aws"></a> aws	>= 4.9.0

Modules

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

Outputs

Name	Description
<a name="output_auth0_domain"></a> auth0_domain	The Auth0 custom domain
<a name="output_client_id_ssm_path"></a> client_id_ssm_path	The SSM parameter path for the Auth0 client ID
<a name="output_client_secret_ssm_path"></a> client_secret_ssm_path	The SSM parameter path for the Auth0 client secret
<a name="output_domain_ssm_path"></a> 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

[!NOTE] This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
<details><summary>Learn More</summary>
It's 100% Open Source and licensed under the APACHE2.
</details>

Related Projects

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

💻 Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you! Hit us up in Slack, in the #cloudposse channel.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-auth0-tenant&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

About

This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-auth0-tenant&utm_content=">Cloud Posse, LLC</a>. <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-auth0-tenant&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>

We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

Your team can operate like a pro today.

Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.

<details> <summary>📚 See What's Included</summary>

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

</details>

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.