connection

Auth 0 Connection component. Auth0 is a third-party service that provides authentication and authorization as a service. It is typically used to to authenticate users.

An Auth0 connection is a bridge between Auth0 and an identity provider (IdP) that allows your application to authenticate users. Auth0 supports many types of connections, including social identity providers such as Google, Facebook, and Twitter, enterprise identity providers such as Microsoft Azure AD, and passwordless authentication methods such as email and SMS.

Usage

Before deploying this component, you need to deploy the auth0/tenant component. This components with authenticate with the Auth0 Terraform provider using the Auth0 tenant's client ID and client secret configured with the auth0/tenant component.

Stack Level: Global

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

# stacks/catalog/auth0/connection.yaml
components:
  terraform:
    auth0/connection:
      vars:
        enabled: true
        name: "auth0"

        # These must all be specified for the connection to be created
        strategy: "email"
        connection_name: "email"
        options_name: "email"

        email_from: "{{`{{ application.name }}`}} <[email protected]>"
        email_subject: "Welcome to {{`{{ application.name }}`}}"
        syntax: "liquid"

        auth_params:
          scope: "openid profile"
          response_type: "code"

        totp:
          time_step: 895
          length: 6

        template_file: "templates/email.html"

        # Stage-specific configuration
        auth0_app_connections:
          - stage: sandbox
          - stage: dev
          - stage: staging

Requirements

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

Providers

Name	Version
auth0	>= 1.0.0
aws.auth0_provider	>= 4.9.0

Modules

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

Resources

Name	Type
auth0_connection.this	resource
auth0_connection_clients.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

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
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_app_connections	The list of Auth0 apps to add to this connection	list(object({ component = optional(string, "auth0/app") environment = optional(string, "") stage = optional(string, "") tenant = optional(string, "") }))	[]	no
auth0_debug	Enable debug mode for the Auth0 provider	bool	true	no
auth0_tenant_component_name	The name of the component	string	"auth0/tenant"	no
auth0_tenant_environment_name	The name of the environment where the Auth0 tenant component is deployed. Defaults to the environment of the current stack.	string	""	no
auth0_tenant_stage_name	The name of the stage where the Auth0 tenant component is deployed. Defaults to the stage of the current stack.	string	""	no
auth0_tenant_tenant_name	The name of the tenant where the Auth0 tenant component is deployed. Yes this is a bit redundant, since Auth0 also calls this resource a tenant. Defaults to the tenant of the current stack.	string	""	no
auth_params	Query string parameters to be included as part of the generated passwordless email link.	object({ scope = optional(string, null) response_type = optional(string, null) })	{}	no
brute_force_protection	Indicates whether to enable brute force protection, which will limit the number of signups and failed logins from a suspicious IP address.	bool	true	no
connection_name	The name of the connection	string	""	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
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_signup	Indicates whether to allow user sign-ups to your application.	bool	false	no
email_from	When using an email strategy, the address to use as the sender	string	null	no
email_subject	When using an email strategy, the subject of the email	string	null	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	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
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
non_persistent_attrs	If there are user fields that should not be stored in Auth0 databases due to privacy reasons, you can add them to the DenyList here.	list(string)	[]	no
options_name	The name of the connection options. Required for the email strategy.	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
set_user_root_attributes	Determines whether to sync user profile attributes at each login or only on the first login. Options include: on_each_login, on_first_login.	string	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
strategy	The strategy to use for the connection	string	"auth0"	no
syntax	The syntax of the template body	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
template	The template to use for the connection. If not provided, the template_file variable must be set.	string	""	no
template_file	The path to the template file. If not provided, the template variable must be set.	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
totp	The TOTP settings for the connection	object({ time_step = optional(number, 900) length = optional(number, 6) })	{}	no

Outputs

Name	Description
auth0_connection_id	The Auth0 Connection ID

References

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