Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Authentik Provider
  4. API Docs
  5. RequestRule
Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik
Schema (JSON)
goauthentik/terraform-provider-authentik

authentik.RequestRule

Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik
Schema (JSON)
goauthentik/terraform-provider-authentik

    Example Usage

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

const example = new authentik.RequestRule("example", {
    name: "Example access request rule",
    policyEngineMode: "any",
    notificationMode: "all",
    minReviewers: 1,
    minReviewersIsPerGroup: false,
});

    import pulumi
import pulumi_authentik as authentik

example = authentik.RequestRule("example",
    name="Example access request rule",
    policy_engine_mode="any",
    notification_mode="all",
    min_reviewers=1,
    min_reviewers_is_per_group=False)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2026/authentik"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authentik.NewRequestRule(ctx, "example", &authentik.RequestRuleArgs{
			Name:                   pulumi.String("Example access request rule"),
			PolicyEngineMode:       pulumi.String("any"),
			NotificationMode:       pulumi.String("all"),
			MinReviewers:           pulumi.Float64(1),
			MinReviewersIsPerGroup: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    var example = new Authentik.RequestRule("example", new()
    {
        Name = "Example access request rule",
        PolicyEngineMode = "any",
        NotificationMode = "all",
        MinReviewers = 1,
        MinReviewersIsPerGroup = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.RequestRule;
import com.pulumi.authentik.RequestRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var example = new RequestRule("example", RequestRuleArgs.builder()
            .name("Example access request rule")
            .policyEngineMode("any")
            .notificationMode("all")
            .minReviewers(1.0)
            .minReviewersIsPerGroup(false)
            .build());

    }
}

    resources:
  example:
    type: authentik:RequestRule
    properties:
      name: Example access request rule
      policyEngineMode: any
      notificationMode: all
      minReviewers: 1
      minReviewersIsPerGroup: false

    Example coming soon!

    Create RequestRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RequestRule(name: string, args?: RequestRuleArgs, opts?: CustomResourceOptions);
    @overload
def RequestRule(resource_name: str,
                args: Optional[RequestRuleArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def RequestRule(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                min_reviewers: Optional[float] = None,
                min_reviewers_is_per_group: Optional[bool] = None,
                name: Optional[str] = None,
                notification_mode: Optional[str] = None,
                notification_transports: Optional[Sequence[str]] = None,
                policy_engine_mode: Optional[str] = None,
                request_flow: Optional[str] = None,
                request_rule_id: Optional[str] = None)
    func NewRequestRule(ctx *Context, name string, args *RequestRuleArgs, opts ...ResourceOption) (*RequestRule, error)
    public RequestRule(string name, RequestRuleArgs? args = null, CustomResourceOptions? opts = null)
    public RequestRule(String name, RequestRuleArgs args)
public RequestRule(String name, RequestRuleArgs args, CustomResourceOptions options)

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


    resource "authentik_request_rule" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args RequestRuleArgs
    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 RequestRuleArgs
    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 RequestRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RequestRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RequestRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var requestRuleResource = new Authentik.RequestRule("requestRuleResource", new()
{
    MinReviewers = 0.0,
    MinReviewersIsPerGroup = false,
    Name = "string",
    NotificationMode = "string",
    NotificationTransports = new[]
    {
        "string",
    },
    PolicyEngineMode = "string",
    RequestFlow = "string",
    RequestRuleId = "string",
});

    example, err := authentik.NewRequestRule(ctx, "requestRuleResource", &authentik.RequestRuleArgs{
	MinReviewers:           pulumi.Float64(0),
	MinReviewersIsPerGroup: pulumi.Bool(false),
	Name:                   pulumi.String("string"),
	NotificationMode:       pulumi.String("string"),
	NotificationTransports: pulumi.StringArray{
		pulumi.String("string"),
	},
	PolicyEngineMode: pulumi.String("string"),
	RequestFlow:      pulumi.String("string"),
	RequestRuleId:    pulumi.String("string"),
})

    resource "authentik_request_rule" "requestRuleResource" {
  lifecycle {
    create_before_destroy = true
  }
  min_reviewers              = 0
  min_reviewers_is_per_group = false
  name                       = "string"
  notification_mode          = "string"
  notification_transports    = ["string"]
  policy_engine_mode         = "string"
  request_flow               = "string"
  request_rule_id            = "string"
}

    var requestRuleResource = new RequestRule("requestRuleResource", RequestRuleArgs.builder()
    .minReviewers(0.0)
    .minReviewersIsPerGroup(false)
    .name("string")
    .notificationMode("string")
    .notificationTransports("string")
    .policyEngineMode("string")
    .requestFlow("string")
    .requestRuleId("string")
    .build());

    request_rule_resource = authentik.RequestRule("requestRuleResource",
    min_reviewers=float(0),
    min_reviewers_is_per_group=False,
    name="string",
    notification_mode="string",
    notification_transports=["string"],
    policy_engine_mode="string",
    request_flow="string",
    request_rule_id="string")

    const requestRuleResource = new authentik.RequestRule("requestRuleResource", {
    minReviewers: 0,
    minReviewersIsPerGroup: false,
    name: "string",
    notificationMode: "string",
    notificationTransports: ["string"],
    policyEngineMode: "string",
    requestFlow: "string",
    requestRuleId: "string",
});

    type: authentik:RequestRule
properties:
    minReviewers: 0
    minReviewersIsPerGroup: false
    name: string
    notificationMode: string
    notificationTransports:
        - string
    policyEngineMode: string
    requestFlow: string
    requestRuleId: string

    RequestRule Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RequestRule resource accepts the following input properties:

    MinReviewers double
    Generated.
    MinReviewersIsPerGroup bool
    Generated.
    Name string
    NotificationMode string
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    NotificationTransports List<string>
    PolicyEngineMode string
    Allowed values:

    • all
    • any Generated.
    RequestFlow string
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    RequestRuleId string
    MinReviewers float64
    Generated.
    MinReviewersIsPerGroup bool
    Generated.
    Name string
    NotificationMode string
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    NotificationTransports []string
    PolicyEngineMode string
    Allowed values:

    • all
    • any Generated.
    RequestFlow string
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    RequestRuleId string
    min_reviewers number
    Generated.
    min_reviewers_is_per_group bool
    Generated.
    name string
    notification_mode string
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notification_transports list(string)
    policy_engine_mode string
    Allowed values:

    • all
    • any Generated.
    request_flow string
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    request_rule_id string
    minReviewers Double
    Generated.
    minReviewersIsPerGroup Boolean
    Generated.
    name String
    notificationMode String
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notificationTransports List<String>
    policyEngineMode String
    Allowed values:

    • all
    • any Generated.
    requestFlow String
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    requestRuleId String
    minReviewers number
    Generated.
    minReviewersIsPerGroup boolean
    Generated.
    name string
    notificationMode string
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notificationTransports string[]
    policyEngineMode string
    Allowed values:

    • all
    • any Generated.
    requestFlow string
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    requestRuleId string
    min_reviewers float
    Generated.
    min_reviewers_is_per_group bool
    Generated.
    name str
    notification_mode str
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notification_transports Sequence[str]
    policy_engine_mode str
    Allowed values:

    • all
    • any Generated.
    request_flow str
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    request_rule_id str
    minReviewers Number
    Generated.
    minReviewersIsPerGroup Boolean
    Generated.
    name String
    notificationMode String
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notificationTransports List<String>
    policyEngineMode String
    Allowed values:

    • all
    • any Generated.
    requestFlow String
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    requestRuleId String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Targets List<string>
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Targets []string
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    id string
    The provider-assigned unique ID for this managed resource.
    targets list(string)
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    targets List<String>
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    id string
    The provider-assigned unique ID for this managed resource.
    targets string[]
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    id str
    The provider-assigned unique ID for this managed resource.
    targets Sequence[str]
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    targets List<String>
    Objects currently bound to this rule, derived from its request rule bindings. Generated.

    Look up Existing RequestRule Resource

    Get an existing RequestRule 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?: RequestRuleState, opts?: CustomResourceOptions): RequestRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        min_reviewers: Optional[float] = None,
        min_reviewers_is_per_group: Optional[bool] = None,
        name: Optional[str] = None,
        notification_mode: Optional[str] = None,
        notification_transports: Optional[Sequence[str]] = None,
        policy_engine_mode: Optional[str] = None,
        request_flow: Optional[str] = None,
        request_rule_id: Optional[str] = None,
        targets: Optional[Sequence[str]] = None) -> RequestRule
    func GetRequestRule(ctx *Context, name string, id IDInput, state *RequestRuleState, opts ...ResourceOption) (*RequestRule, error)
    public static RequestRule Get(string name, Input<string> id, RequestRuleState? state, CustomResourceOptions? opts = null)
    public static RequestRule get(String name, Output<String> id, RequestRuleState state, CustomResourceOptions options)
    resources:  _:    type: authentik:RequestRule    get:      id: ${id}
    import {
  to = authentik_request_rule.example
  id = "${id}"
}
    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:
    MinReviewers double
    Generated.
    MinReviewersIsPerGroup bool
    Generated.
    Name string
    NotificationMode string
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    NotificationTransports List<string>
    PolicyEngineMode string
    Allowed values:

    • all
    • any Generated.
    RequestFlow string
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    RequestRuleId string
    Targets List<string>
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    MinReviewers float64
    Generated.
    MinReviewersIsPerGroup bool
    Generated.
    Name string
    NotificationMode string
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    NotificationTransports []string
    PolicyEngineMode string
    Allowed values:

    • all
    • any Generated.
    RequestFlow string
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    RequestRuleId string
    Targets []string
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    min_reviewers number
    Generated.
    min_reviewers_is_per_group bool
    Generated.
    name string
    notification_mode string
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notification_transports list(string)
    policy_engine_mode string
    Allowed values:

    • all
    • any Generated.
    request_flow string
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    request_rule_id string
    targets list(string)
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    minReviewers Double
    Generated.
    minReviewersIsPerGroup Boolean
    Generated.
    name String
    notificationMode String
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notificationTransports List<String>
    policyEngineMode String
    Allowed values:

    • all
    • any Generated.
    requestFlow String
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    requestRuleId String
    targets List<String>
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    minReviewers number
    Generated.
    minReviewersIsPerGroup boolean
    Generated.
    name string
    notificationMode string
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notificationTransports string[]
    policyEngineMode string
    Allowed values:

    • all
    • any Generated.
    requestFlow string
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    requestRuleId string
    targets string[]
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    min_reviewers float
    Generated.
    min_reviewers_is_per_group bool
    Generated.
    name str
    notification_mode str
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notification_transports Sequence[str]
    policy_engine_mode str
    Allowed values:

    • all
    • any Generated.
    request_flow str
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    request_rule_id str
    targets Sequence[str]
    Objects currently bound to this rule, derived from its request rule bindings. Generated.
    minReviewers Number
    Generated.
    minReviewersIsPerGroup Boolean
    Generated.
    name String
    notificationMode String
    Allowed values:

    • all
    • direct
    • random_min_reviewers Generated.
    notificationTransports List<String>
    policyEngineMode String
    Allowed values:

    • all
    • any Generated.
    requestFlow String
    UUID or slug of the flow shown to the requester when creating a request against this rule.
    requestRuleId String
    targets List<String>
    Objects currently bound to this rule, derived from its request rule bindings. Generated.

    Package Details

    Repository
    authentik goauthentik/terraform-provider-authentik
    License
    Notes
    This Pulumi package is based on the authentik Terraform Provider.
    Viewing docs for authentik 2026.8.0
    published on Wednesday, Sep 9, 2026 by goauthentik
    Schema (JSON)
    goauthentik/terraform-provider-authentik

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial