README.md

Terraform Provider for AuthZed

A Terraform provider for managing AuthZed resources through its Cloud API.

Overview

This provider automates the management of resources in AuthZed Dedicated environments:

• Service accounts for programmatic access to permission systems
• API tokens for secure authentication
• Roles and policies for fine-grained access control
• Permission system monitoring and configuration

Note: This provider manages platform administration only. For managing permissions data (relationships between users and resources), use the AuthZed Permissions API directly.

Documentation

Full provider documentation is available on the Terraform Registry.

API documentation is available on Postman.

Development

Building Locally

# Clone the repository
git clone https://github.com/authzed/terraform-provider-authzed.git
cd terraform-provider-authzed

# Build the provider
go build

# Install locally
mkdir -p ~/.terraform.d/plugins/registry.terraform.io/authzed/authzed/0.1.0/$(go env GOOS)_$(go env GOARCH)
cp terraform-provider-authzed ~/.terraform.d/plugins/registry.terraform.io/authzed/authzed/0.1.0/$(go env GOOS)_$(go env GOARCH)/

Working with Development Containers

This repository includes a .devcontainer directory for use with Visual Studio Code and the Remote - Containers extension.

Testing Changes

To use a local build with Terraform, configure your .terraformrc file:

provider_installation {
  dev_overrides {
    "registry.terraform.io/authzed/authzed" = "/path/to/terraform-provider-authzed"
  }
  direct {}
}

Contributing

Contributions are welcome! Please see the contribution guidelines for more information.

License

Apache 2.0 License

Troubleshooting

If you encounter issues with provider installation such as "Failed to query available provider packages" or "no available releases match", this is often caused by locally cached provider files.

Quick fix:

# Remove cached files and reinitialize
rm -rf ~/.terraform.d/plugins/*/authzed
terraform init

For more detailed troubleshooting information, see our Troubleshooting Guide.