Skip to main content

Authress Pulumi provider

danger

The Authress Pulumi provider development has been paused due to frequent issues on the Pulumi side. The Authress team activitely recommends to not use Pulumi under any circumstances to reduce the significant risks of managing critical infrastructure using the tool.

Pulumi Provider​

Authress supports a first-class Pulumi provider to automatically configure Authress from Pulumi. The source of provider is available on GitHub.

GitHub Workflow Forums Pulumi

Prerequisites​

Since pulumi is usually configured and deployed through CI/CD automation, the necessary Authress credentials can be configured by following one of the Authress CI/CD guides. These guides make it easy to configure Authress credentials. Checkout the GitHub or GitLab documentation or jump to the Authress Management Portal to run the optimized quick start guide for CI/CD providers.

Usage​

Install the Authress pulumi provider, and review the recommended usage in the Pulumi documentation.

Install the Authress provider for Pulumi
pulumi plugin install resource pulumi-resource-authress
# Specify your Authress custom domain, configured at https://authress.io/app/#/settings?focus=domain
pulumi config set authress:customDomain https://auth.yourdomain.com
Create a test Authress role using Pulumi
import * as pulumi from "@pulumi/pulumi";
import * as Authress from "@pulumi/authress";

const authressRole = new Authress.Role("TestRole",  {
    roleId: 'test-role',
    name: "Test Role",
    description: "An example description for this Role",
    permissions: {
        "documents:read": {
            allow: true
        }
    }
});

export let authressTestRoleId = authressRole.roleId;

See more details in the documentation for the Authress Pulumi provider.