Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hashicorp/terraform-provider-auth0
Please see https://github.com/alexkappa/terraform-provider-auth0
https://github.com/hashicorp/terraform-provider-auth0
auth0 terraform terraform-provider
Last synced: 8 days ago
JSON representation
Please see https://github.com/alexkappa/terraform-provider-auth0
- Host: GitHub
- URL: https://github.com/hashicorp/terraform-provider-auth0
- Owner: hashicorp
- License: mpl-2.0
- Archived: true
- Created: 2020-01-28T19:57:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-24T04:35:32.000Z (about 4 years ago)
- Last Synced: 2024-09-19T06:13:15.265Z (16 days ago)
- Topics: auth0, terraform, terraform-provider
- Language: Go
- Homepage: https://github.com/alexkappa/terraform-provider-auth0
- Size: 11.2 MB
- Stars: 27
- Watchers: 12
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Auth0 Terraform Provider
========================
[](https://travis-ci.org/alexkappa/terraform-provider-auth0)
[](https://codeclimate.com/github/alexkappa/terraform-provider-auth0/maintainability)
[](https://codeclimate.com/github/alexkappa/terraform-provider-auth0/test_coverage)
[](https://gitter.im/terraform-provider-auth0/community)
This provider has recently been accepted in the [Terraform Provider Developer Program](https://www.terraform.io/guides/terraform-provider-development-program.html). This means you can install this provider with the same ease as other officially supported providers!
Issues & Pull Requests
----------------------
Please submit issues or pull requests to [alexkappa/terraform-provider-auth0](https://github.com/alexkappa/terraform-provider-auth0). This helps maintainers organize work more efficiently.
Requirements
------------
- [Terraform](https://www.terraform.io/downloads.html) `0.11.x` || `0.12.x`
- [Go](https://golang.org/doc/install) 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 = ""
client_id = ""
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](example/).
Building The Provider
---------------------
Clone repository to: `$GOPATH/src/github.com/alexkappa/terraform-provider-auth0`
```sh
$ mkdir -p $GOPATH/src/github.com/alexkappa; cd $GOPATH/src/github.com/alexkappa
$ git clone [email protected]:alexkappa/terraform-provider-auth0
```
Enter the provider directory and build the provider
```sh
$ 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](http://www.golang.org) installed on your machine (version 1.10+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
On how to develop custom terraform providers, read the [official guide](https://www.terraform.io/docs/extend/writing-custom-providers.html).
To compile the provider, run `make build`. This will build the provider and install the provider binary in the `$GOPATH/bin` directory.
```sh
$ make build
...
$ $GOPATH/bin/terraform-provider-auth0
...
```
In order to test the provider, you can simply run `make test`.
```sh
$ make test
```
In order to run the full suite of Acceptance tests, the following environment variables must be set:
```sh
AUTH0_DOMAIN=your-tenant.auth0.com
AUTH0_CLIENT_ID=xyz
AUTH0_CLIENT_SECRET=xyz
```
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](https://github.com/alexkappa)) with contributions from [great people](https://github.com/alexkappa/terraform-provider-auth0/graphs/contributors) across the community.
I am not affiliated with [Auth0](https://auth0.com/) and all work that goes into this provider is done during my spare time. Please be patient with issues and pull requests.
If you or your company relies on this plugin or the [Go SDK](https://github.com/go-auth0/auth0) and would like to ensure its continuing support please consider [donating](https://github.com/sponsors/alexkappa).