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

Variables

Required Variables

region (string) required

AWS Region

Optional Variables

auth0_app_connections optional

The list of Auth0 apps to add to this connection

Type:

list(object({
component   = optional(string, "auth0/app")
environment = optional(string, "")
stage       = optional(string, "")
tenant      = optional(string, "")
}))

Default value: [ ]

auth0_debug (bool) optional

Enable debug mode for the Auth0 provider

Default value: true

auth0_tenant_component_name (string) optional

The name of the component

Default value: "auth0/tenant"

auth0_tenant_environment_name (string) optional

The name of the environment where the Auth0 tenant component is deployed. Defaults to the environment of the current stack.

Default value: ""

auth0_tenant_stage_name (string) optional

The name of the stage where the Auth0 tenant component is deployed. Defaults to the stage of the current stack.

Default value: ""

auth0_tenant_tenant_name (string) optional

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.

Default value: ""

auth_params optional

Query string parameters to be included as part of the generated passwordless email link.

Type:

object({
scope         = optional(string, null)
response_type = optional(string, null)
})

Default value: { }

brute_force_protection (bool) optional

Indicates whether to enable brute force protection, which will limit the number of signups and failed logins from a suspicious IP address.

Default value: true

connection_name (string) optional

The name of the connection

Default value: ""

disable_signup (bool) optional

Indicates whether to allow user sign-ups to your application.

Default value: false

email_from (string) optional

When using an email strategy, the address to use as the sender

Default value: null

email_subject (string) optional

When using an email strategy, the subject of the email

Default value: null

non_persistent_attrs (list(string)) optional

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.

Default value: [ ]

options_name (string) optional

The name of the connection options. Required for the email strategy.

Default value: ""

set_user_root_attributes (string) optional

Determines whether to sync user profile attributes at each login or only on the first login. Options include: on_each_login, on_first_login.

Default value: null

strategy (string) optional

The strategy to use for the connection

Default value: "auth0"

syntax (string) optional

The syntax of the template body

Default value: null

template (string) optional

The template to use for the connection. If not provided, the template_file variable must be set.

Default value: ""

template_file (string) optional

The path to the template file. If not provided, the template variable must be set.

Default value: ""

totp optional

The TOTP settings for the connection

Type:

object({
time_step = optional(number, 900)
length    = optional(number, 6)
})

Default value: { }

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

auth0_connection_id

The Auth0 Connection ID

Dependencies

Requirements

• terraform, version: >= 1.0.0
• auth0, version: >= 1.0.0
• aws, version: >= 4.9.0

Providers

• auth0, version: >= 1.0.0
• aws, version: >= 4.9.0

Modules

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

Resources

The following resources are used by this module:

• auth0_connection.this (resource)
• auth0_connection_clients.this (resource)

Data Sources

The following data sources are used by this module:

• aws_ssm_parameter.auth0_client_id (data source)
• aws_ssm_parameter.auth0_client_secret (data source)
• aws_ssm_parameter.auth0_domain (data source)

References

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