Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse-terraform-components/aws-auth0-tenant/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse-terraform-components/aws-auth0-tenant/releases/latest"><img src="https://img.shields.io/github/release/cloudposse-terraform-components/aws-auth0-tenant.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

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
<!-- prettier-ignore-start --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

Requirements

NameVersion
<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

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

Modules

NameSourceVersion
<a name="module_dns_gbl_delegated"></a> dns_gbl_delegatedcloudposse/stack-config/yaml//modules/remote-state1.5.0
<a name="module_iam_roles"></a> iam_roles../../account-map/modules/iam-rolesn/a
<a name="module_this"></a> thiscloudposse/label/null0.25.0

Resources

NameType
auth0_custom_domain.thisresource
auth0_custom_domain_verification.thisresource
auth0_email_provider.thisresource
auth0_prompt.thisresource
auth0_tenant.thisresource
aws_route53_record.thisresource
aws_ssm_parameter.auth0_client_iddata source
aws_ssm_parameter.auth0_client_secretdata source
aws_ssm_parameter.auth0_domaindata source
aws_ssm_parameter.sendgrid_api_keydata source

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional 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_urlsThe URLs that Auth0 can redirect to after logout.list(string)[]no
<a name="input_attributes"></a> attributesID 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_debugEnable debug mode for the Auth0 providerbooltrueno
<a name="input_auth0_prompt_experience"></a> auth0_prompt_experienceWhich prompt login experience to use. Options include classic and new.string"new"no
<a name="input_context"></a> contextSingle 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_uriThe default redirection URI.string""no
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe 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_headersWhether to disable clickjack protection headers.booltrueno
<a name="input_disable_fields_map_fix"></a> disable_fields_map_fixWhether to disable fields map fix.boolfalseno
<a name="input_disable_management_api_sms_obfuscation"></a> disable_management_api_sms_obfuscationWhether to disable management API SMS obfuscation.boolfalseno
<a name="input_email_provider_default_from_address"></a> email_provider_default_from_addressThe default from address for the email provider.string""no
<a name="input_email_provider_name"></a> email_provider_nameThe 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_errorWhether to enable public signup user exists error.booltrueno
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_enabled_locales"></a> enabled_localesThe enabled locales.list(string)<pre>[<br/> "en"<br/>]</pre>no
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_friendly_name"></a> friendly_nameThe 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_limitLimit 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.numbernullno
<a name="input_idle_session_lifetime"></a> idle_session_lifetimeThe idle session lifetime in hours.number72no
<a name="input_label_key_case"></a> label_key_caseControls 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.stringnullno
<a name="input_label_order"></a> label_orderThe 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)nullno
<a name="input_label_value_case"></a> label_value_caseControls 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.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet 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> nameID 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.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_no_disclose_enterprise_connections"></a> no_disclose_enterprise_connectionsWhether to disclose enterprise connections.boolfalseno
<a name="input_oidc_logout_prompt_enabled"></a> oidc_logout_prompt_enabledWhether the OIDC logout prompt is enabled.boolfalseno
<a name="input_picture_url"></a> picture_urlThe 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_pathThe 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 falsestring""no
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform 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.stringnullno
<a name="input_region"></a> regionAWS Regionstringn/ayes
<a name="input_sandbox_version"></a> sandbox_versionThe sandbox version.string"18"no
<a name="input_sendgrid_api_key_ssm_path"></a> sendgrid_api_key_ssm_pathThe 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_modeThe session cookie mode.string"persistent"no
<a name="input_session_lifetime"></a> session_lifetimeThe session lifetime in hours.number168no
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_support_email"></a> support_emailThe email address to be displayed in the Auth0 Universal Login page.stringn/ayes
<a name="input_support_url"></a> support_urlThe URL to be displayed in the Auth0 Universal Login page.stringn/ayes
<a name="input_tags"></a> tagsAdditional 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> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
<a name="input_use_scope_descriptions_for_consent"></a> use_scope_descriptions_for_consentWhether to use scope descriptions for consent.boolfalseno

Outputs

NameDescription
<a name="output_auth0_domain"></a> auth0_domainThe Auth0 custom domain
<a name="output_client_id_ssm_path"></a> client_id_ssm_pathThe SSM parameter path for the Auth0 client ID
<a name="output_client_secret_ssm_path"></a> client_secret_ssm_pathThe SSM parameter path for the Auth0 client secret
<a name="output_domain_ssm_path"></a> domain_ssm_pathThe SSM parameter path for the Auth0 domain
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- prettier-ignore-end -->

References

[!TIP]

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>

Related Projects

Check out these related projects.

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

βœ… We build it together with your team.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-auth0-tenant&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

<details><summary>πŸ“š <strong>Learn More</strong></summary> <br/>

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

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

Day-0: Your Foundation for Success

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-auth0-tenant&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-auth0-tenant&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse-terraform-components/aws-auth0-tenant/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse-terraform-components/aws-auth0-tenant&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

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

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. 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!

License

<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>

<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>
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.


Copyright Β© 2017-2024 Cloud Posse, LLC

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-auth0-tenant&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse-terraform-components/aws-auth0-tenant?pixel&cs=github&cm=readme&an=aws-auth0-tenant"/>