Auth0 Terraform Provider

Requirements

Terraform 0.11.x || 0.12.x
Go 1.10 (to build the provider plugin)

Using the provider

To install this provider, copy and paste this code into your Terraform configuration. Then, run terraform init.

provider "auth0" {
  version = "> 0.8"
}

To configure the provider with your personal client credentials, define the domain, client_id and client_secret.

provider "auth0" {
  version = "> 0.8"
  domain = "<domain>"
  client_id = "<client-id>"
  client_secret = "<client-secret>"
}

These variables can also be accessed via the AUTH0_DOMAIN, AUTH0_CLIENT_ID and AUTH0_CLIENT_SECRET environment variables respectively.

Examples of resources can be found in the examples directory.

Building The Provider

Clone repository to: $GOPATH/src/github.com/alexkappa/terraform-provider-auth0

$ mkdir -p $GOPATH/src/github.com/alexkappa; cd $GOPATH/src/github.com/alexkappa
$ git clone git@github.com:alexkappa/terraform-provider-auth0

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/alexkappa/terraform-provider-auth0
$ make build

Developing the Provider

If you wish to work on the provider, you'll need Go installed on your machine (version 1.10+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

On how to develop custom terraform providers, read the official guide.

To compile the provider, run make build. This will build the provider and install the provider binary in the $GOPATH/bin directory.

$ make build
...
$ $GOPATH/bin/terraform-provider-auth0
...

In order to test the provider, you can simply run make test.

$ make test

In order to run the full suite of Acceptance tests, the following environment variables must be set:

AUTH0_DOMAIN=<your-auth0-tenant-domain>
AUTH0_CLIENT_ID=<your-auth0-client-id>
AUTH0_CLIENT_SECRET=<your-auth0-client-secret>

Then, run make testacc.

Note: The acceptance tests make calls to a real Auth0 tenant, and create real resources. Certain tests, for example for custom domains (TestAccCustomDomain), also require a paid Auth0 subscription to be able to run successfully.

At the time of writing, the following configuration steps are also required for the test tenant:

The Username-Password-Authentication connection must have Requires Username option enabled for the user tests to successfully run.

Supporting the provider

This project is maintained by myself (@alexkappa) with contributions from great people across the community.

I am not affiliated with Auth0 and all work that goes into this provider is done during my spare time. Please be patient with issues and pull requests.