1. Registry
  2. Packages
  3. Authentik Provider
  4. API Docs
  5. getPolicyExpression
Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik
Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik

    Get policy expressions by id or name

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as authentik from "@pulumi/authentik";
    
    // To get the ID of a policy expression by name
    const defaultUserSettingsAuthorization = authentik.getPolicyExpression({
        name: "default-user-settings-authorization",
    });
    
    import pulumi
    import pulumi_authentik as authentik
    
    # To get the ID of a policy expression by name
    default_user_settings_authorization = authentik.get_policy_expression(name="default-user-settings-authorization")
    
    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 {
    		// To get the ID of a policy expression by name
    		_, err := authentik.LookupPolicyExpression(ctx, &authentik.LookupPolicyExpressionArgs{
    			Name: pulumi.StringRef("default-user-settings-authorization"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Authentik = Pulumi.Authentik;
    
    return await Deployment.RunAsync(() => 
    {
        // To get the ID of a policy expression by name
        var defaultUserSettingsAuthorization = Authentik.GetPolicyExpression.Invoke(new()
        {
            Name = "default-user-settings-authorization",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.authentik.AuthentikFunctions;
    import com.pulumi.authentik.inputs.GetPolicyExpressionArgs;
    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) {
            // To get the ID of a policy expression by name
            final var defaultUserSettingsAuthorization = AuthentikFunctions.getPolicyExpression(GetPolicyExpressionArgs.builder()
                .name("default-user-settings-authorization")
                .build());
    
        }
    }
    
    variables:
      # To get the ID of a policy expression by name
      defaultUserSettingsAuthorization:
        fn::invoke:
          function: authentik:getPolicyExpression
          arguments:
            name: default-user-settings-authorization
    
    Example coming soon!
    

    Using getPolicyExpression

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPolicyExpression(args: GetPolicyExpressionArgs, opts?: InvokeOptions): Promise<GetPolicyExpressionResult>
    function getPolicyExpressionOutput(args: GetPolicyExpressionOutputArgs, opts?: InvokeOutputOptions): Output<GetPolicyExpressionResult>
    def get_policy_expression(id: Optional[str] = None,
                              name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPolicyExpressionResult
    def get_policy_expression_output(id: pulumi.Input[Optional[str]] = None,
                              name: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetPolicyExpressionResult]
    func LookupPolicyExpression(ctx *Context, args *LookupPolicyExpressionArgs, opts ...InvokeOption) (*LookupPolicyExpressionResult, error)
    func LookupPolicyExpressionOutput(ctx *Context, args *LookupPolicyExpressionOutputArgs, opts ...InvokeOption) LookupPolicyExpressionResultOutput

    > Note: This function is named LookupPolicyExpression in the Go SDK.

    public static class GetPolicyExpression 
    {
        public static Task<GetPolicyExpressionResult> InvokeAsync(GetPolicyExpressionArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyExpressionResult> Invoke(GetPolicyExpressionInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyExpressionResult> Invoke(GetPolicyExpressionInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetPolicyExpressionResult> getPolicyExpression(GetPolicyExpressionArgs args, InvokeOptions options)
    public static Output<GetPolicyExpressionResult> getPolicyExpression(GetPolicyExpressionArgs args, InvokeOptions options)
    public static Output<GetPolicyExpressionResult> getPolicyExpression(GetPolicyExpressionArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: authentik:index/getPolicyExpression:getPolicyExpression
      arguments:
        # arguments dictionary
    data "authentik_get_policy_expression" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Generated.
    Name string
    Generated.
    Id string
    Generated.
    Name string
    Generated.
    id string
    Generated.
    name string
    Generated.
    id String
    Generated.
    name String
    Generated.
    id string
    Generated.
    name string
    Generated.
    id str
    Generated.
    name str
    Generated.
    id String
    Generated.
    name String
    Generated.

    getPolicyExpression Result

    The following output properties are available:

    BoundTo double
    Generated.
    Component string
    Generated.
    ExecutionLogging bool
    Generated.
    Expression string
    Generated.
    Id string
    Generated.
    MetaModelName string
    Generated.
    Name string
    Generated.
    VerboseName string
    Generated.
    VerboseNamePlural string
    Generated.
    BoundTo float64
    Generated.
    Component string
    Generated.
    ExecutionLogging bool
    Generated.
    Expression string
    Generated.
    Id string
    Generated.
    MetaModelName string
    Generated.
    Name string
    Generated.
    VerboseName string
    Generated.
    VerboseNamePlural string
    Generated.
    bound_to number
    Generated.
    component string
    Generated.
    execution_logging bool
    Generated.
    expression string
    Generated.
    id string
    Generated.
    meta_model_name string
    Generated.
    name string
    Generated.
    verbose_name string
    Generated.
    verbose_name_plural string
    Generated.
    boundTo Double
    Generated.
    component String
    Generated.
    executionLogging Boolean
    Generated.
    expression String
    Generated.
    id String
    Generated.
    metaModelName String
    Generated.
    name String
    Generated.
    verboseName String
    Generated.
    verboseNamePlural String
    Generated.
    boundTo number
    Generated.
    component string
    Generated.
    executionLogging boolean
    Generated.
    expression string
    Generated.
    id string
    Generated.
    metaModelName string
    Generated.
    name string
    Generated.
    verboseName string
    Generated.
    verboseNamePlural string
    Generated.
    bound_to float
    Generated.
    component str
    Generated.
    execution_logging bool
    Generated.
    expression str
    Generated.
    id str
    Generated.
    meta_model_name str
    Generated.
    name str
    Generated.
    verbose_name str
    Generated.
    verbose_name_plural str
    Generated.
    boundTo Number
    Generated.
    component String
    Generated.
    executionLogging Boolean
    Generated.
    expression String
    Generated.
    id String
    Generated.
    metaModelName String
    Generated.
    name String
    Generated.
    verboseName String
    Generated.
    verboseNamePlural String
    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial