Authress Terraform Provider

Manage Authress resources declaratively from Terraform or OpenTofu.

Installation

Install the Authress terraform provider and review the full documentation at the Terraform Registry.

terraform {
  required_providers {
    authress = {
      source = "authress/authress"
    }
  }
}

provider "authress" {}

Authentication is configured automatically via your CI/CD pipeline's OIDC integration. See the Authress CI/CD setup guide for GitHub Actions, GitLab CI, and other platforms.

Resources

authress_role

Manages a role containing a set of permissions.

resource "authress_role" "editor" {
  role_id     = "ro_editor"
  name        = "Editor"
  description = "Can read and write content"

  permissions = {
    "documents:read" = {
      allow = true
    }
    "documents:write" = {
      allow    = true
      grant    = true
      delegate = false
    }
  }
}

authress_service_client

Manages a service client (machine identity) with optional access keys.

resource "authress_service_client" "api_worker" {
  client_id = "sc_api_worker"
  name      = "API Worker"

  tags = {
    environment = "production"
    team        = "backend"
  }

  options {
    grant_user_permissions_access = true
  }

  access_key {
    public_key = "MCowBQYDK2VwAyEA..."
  }
}

Development

For developing this plugin see Development Docs.