app

Auth0 Application 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 application is a client that can request authentication and authorization from an Auth0 server. Auth0 applications can be of different types, such as regular web applications, single-page applications, machine-to-machine applications, and others. Each application has a set of allowed origins, allowed callback URLs, and allowed web origins.

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/app.yaml
components:
  terraform:
    auth0/app:
      vars:
        enabled: true
        name: "auth0"

        # We can centralize plat-sandbox, plat-dev, and plat-staging all use a "nonprod" Auth0 tenant, which is deployed in plat-staging.
        auth0_tenant_stage_name: "plat-staging"

        # Common client configuration
        grant_types:
          - "authorization_code"
          - "refresh_token"
          - "implicit"
          - "client_credentials"

        # Stage-specific client configuration
        callbacks:
          - "https://auth.acme-dev.com/login/auth0/callback"
        allowed_origins:
          - "https://*.acme-dev.com"
        web_origins:
          - "https://portal.acme-dev.com"
          - "https://auth.acme-dev.com"

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_ssm_parameters	cloudposse/ssm-parameter-store/aws	0.13.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_client.this	resource
auth0_client_credentials.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
allowed_origins	Allowed Origins	`list(string)`	`[]`	no
app_type	Auth0 Application Type	`string`	`"regular_web"`	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_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
authentication_method	The authentication method for the client credentials	`string`	`"client_secret_post"`	no
callbacks	Allowed Callback URLs	`list(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
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
grant_types	Allowed Grant Types	`list(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
jwt_alg	JWT Algorithm	`string`	`"RS256"`	no
jwt_lifetime_in_seconds	JWT Lifetime in Seconds	`number`	`36000`	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
logo_uri	Logo URI	`string`	`"https://cloudposse.com/wp-content/uploads/2017/07/CloudPosse2-TRANSAPRENT.png"`	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
oidc_conformant	OIDC Conformant	`bool`	`true`	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
sso	Single Sign-On for the Auth0 app	`bool`	`true`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`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
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
web_origins	Allowed Web Origins	`list(string)`	`[]`	no

Outputs

Name	Description
auth0_client_id	The Auth0 Application Client ID

References

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

Usage​

Requirements​

Providers​

Modules​

Resources​

Inputs​

Outputs​

References​