Auth0

Pulumi Official

Package maintained by Pulumi

v2.9.0 published on Thursday, May 26, 2022 by Pulumi

Rule

With Auth0, you can create custom Javascript snippets that run in a secure, isolated sandbox as part of your authentication pipeline, which are otherwise known as rules. This resource allows you to create and manage rules. You can create global variable for use with rules by using the auth0.RuleConfig resource.

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
    public MyStack()
    {
        var myRule = new Auth0.Rule("myRule", new Auth0.RuleArgs
        {
            Enabled = true,
            Script = @"function (user, context, callback) {
  callback(null, user, context);
}

",
        });
        var myRuleConfig = new Auth0.RuleConfig("myRuleConfig", new Auth0.RuleConfigArgs
        {
            Key = "foo",
            Value = "bar",
        });
    }

}

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.NewRule(ctx, "myRule", &auth0.RuleArgs{
			Enabled: pulumi.Bool(true),
			Script:  pulumi.String(fmt.Sprintf("%v%v%v%v", "function (user, context, callback) {\n", "  callback(null, user, context);\n", "}\n", "\n")),
		})
		if err != nil {
			return err
		}
		_, err = auth0.NewRuleConfig(ctx, "myRuleConfig", &auth0.RuleConfigArgs{
			Key:   pulumi.String("foo"),
			Value: pulumi.String("bar"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myRule = new Rule("myRule", RuleArgs.builder()        
            .enabled(true)
            .script("""
function (user, context, callback) {
  callback(null, user, context);
}

            """)
            .build());

        var myRuleConfig = new RuleConfig("myRuleConfig", RuleConfigArgs.builder()        
            .key("foo")
            .value("bar")
            .build());

    }
}

import pulumi
import pulumi_auth0 as auth0

my_rule = auth0.Rule("myRule",
    enabled=True,
    script="""function (user, context, callback) {
  callback(null, user, context);
}

""")
my_rule_config = auth0.RuleConfig("myRuleConfig",
    key="foo",
    value="bar")

import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const myRule = new auth0.Rule("my_rule", {
    enabled: true,
    script: `function (user, context, callback) {
  callback(null, user, context);
}
`,
});
const myRuleConfig = new auth0.RuleConfig("my_rule_config", {
    key: "foo",
    value: "bar",
});

resources:
  myRule:
    type: auth0:Rule
    properties:
      enabled: true
      script: |+
        function (user, context, callback) {
          callback(null, user, context);
        }        

  myRuleConfig:
    type: auth0:RuleConfig
    properties:
      key: foo
      value: bar

Create a Rule Resource

new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);

@overload
def Rule(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         enabled: Optional[bool] = None,
         name: Optional[str] = None,
         order: Optional[int] = None,
         script: Optional[str] = None)
@overload
def Rule(resource_name: str,
         args: RuleArgs,
         opts: Optional[ResourceOptions] = None)

func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)

public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)

public Rule(String name, RuleArgs args)
public Rule(String name, RuleArgs args, CustomResourceOptions options)

type: auth0:Rule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RuleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Rule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Rule resource accepts the following input properties:

Script string: String. Code to be executed when the rule runs.
Enabled bool: Boolean. Indicates whether the rule is enabled.
Name string: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
Order int: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.

Script string: String. Code to be executed when the rule runs.
Enabled bool: Boolean. Indicates whether the rule is enabled.
Name string: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
Order int: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.

script String: String. Code to be executed when the rule runs.
enabled Boolean: Boolean. Indicates whether the rule is enabled.
name String: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
order Integer: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.

script string: String. Code to be executed when the rule runs.
enabled boolean: Boolean. Indicates whether the rule is enabled.
name string: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
order number: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.

script str: String. Code to be executed when the rule runs.
enabled bool: Boolean. Indicates whether the rule is enabled.
name str: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
order int: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.

script String: String. Code to be executed when the rule runs.
enabled Boolean: Boolean. Indicates whether the rule is enabled.
name String: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
order Number: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.

Outputs

All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up an Existing Rule Resource

Get an existing Rule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RuleState, opts?: CustomResourceOptions): Rule

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        order: Optional[int] = None,
        script: Optional[str] = None) -> Rule

func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)

public static Rule Get(string name, Input<string> id, RuleState? state, CustomResourceOptions? opts = null)

public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Enabled bool: Boolean. Indicates whether the rule is enabled.
Name string: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
Order int: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.
Script string: String. Code to be executed when the rule runs.

Enabled bool: Boolean. Indicates whether the rule is enabled.
Name string: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
Order int: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.
Script string: String. Code to be executed when the rule runs.

enabled Boolean: Boolean. Indicates whether the rule is enabled.
name String: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
order Integer: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.
script String: String. Code to be executed when the rule runs.

enabled boolean: Boolean. Indicates whether the rule is enabled.
name string: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
order number: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.
script string: String. Code to be executed when the rule runs.

enabled bool: Boolean. Indicates whether the rule is enabled.
name str: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
order int: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.
script str: String. Code to be executed when the rule runs.

enabled Boolean: Boolean. Indicates whether the rule is enabled.
name String: String. Name of the rule. May only contain alphanumeric characters, spaces, and hyphens. May neither start nor end with hyphens or spaces.
order Number: Integer. Order in which the rule executes relative to other rules. Lower-valued rules execute first.
script String: String. Code to be executed when the rule runs.

Import

Existing rules can be imported using their id, e.g.

 $ pulumi import auth0:index/rule:Rule my_rule rul_XXXXXXXXXXXXX

Package Details

Repository: https://github.com/pulumi/pulumi-auth0
License: Apache-2.0
Notes: This Pulumi package is based on the auth0 Terraform Provider.