authentik 2025.2.0, Mar 24 25

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

authentik.PolicyPassword

Explore with Pulumi AI

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

Example Usage

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

const name = new authentik.PolicyPassword("name", {
    errorMessage: "foo",
    lengthMin: 8,
});

import pulumi
import pulumi_authentik as authentik

name = authentik.PolicyPassword("name",
    error_message="foo",
    length_min=8)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authentik.NewPolicyPassword(ctx, "name", &authentik.PolicyPasswordArgs{
			ErrorMessage: pulumi.String("foo"),
			LengthMin:    pulumi.Float64(8),
		})
		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 name = new Authentik.PolicyPassword("name", new()
    {
        ErrorMessage = "foo",
        LengthMin = 8,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.PolicyPassword;
import com.pulumi.authentik.PolicyPasswordArgs;
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 name = new PolicyPassword("name", PolicyPasswordArgs.builder()
            .errorMessage("foo")
            .lengthMin(8)
            .build());

    }
}

resources:
  name:
    type: authentik:PolicyPassword
    properties:
      errorMessage: foo
      lengthMin: 8

Create PolicyPassword Resource

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

Constructor syntax

new PolicyPassword(name: string, args: PolicyPasswordArgs, opts?: CustomResourceOptions);

@overload
def PolicyPassword(resource_name: str,
                   args: PolicyPasswordArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def PolicyPassword(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   error_message: Optional[str] = None,
                   execution_logging: Optional[bool] = None,
                   hibp_allowed_count: Optional[float] = None,
                   amount_uppercase: Optional[float] = None,
                   check_have_i_been_pwned: Optional[bool] = None,
                   check_static_rules: Optional[bool] = None,
                   check_zxcvbn: Optional[bool] = None,
                   amount_symbols: Optional[float] = None,
                   amount_digits: Optional[float] = None,
                   amount_lowercase: Optional[float] = None,
                   length_min: Optional[float] = None,
                   name: Optional[str] = None,
                   password_field: Optional[str] = None,
                   policy_password_id: Optional[str] = None,
                   symbol_charset: Optional[str] = None,
                   zxcvbn_score_threshold: Optional[float] = None)

func NewPolicyPassword(ctx *Context, name string, args PolicyPasswordArgs, opts ...ResourceOption) (*PolicyPassword, error)

public PolicyPassword(string name, PolicyPasswordArgs args, CustomResourceOptions? opts = null)

public PolicyPassword(String name, PolicyPasswordArgs args)
public PolicyPassword(String name, PolicyPasswordArgs args, CustomResourceOptions options)

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

Parameters

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

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

name String: The unique name of the resource.
args PolicyPasswordArgs: 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 policyPasswordResource = new Authentik.PolicyPassword("policyPasswordResource", new()
{
    ErrorMessage = "string",
    ExecutionLogging = false,
    HibpAllowedCount = 0,
    AmountUppercase = 0,
    CheckHaveIBeenPwned = false,
    CheckStaticRules = false,
    CheckZxcvbn = false,
    AmountSymbols = 0,
    AmountDigits = 0,
    AmountLowercase = 0,
    LengthMin = 0,
    Name = "string",
    PasswordField = "string",
    PolicyPasswordId = "string",
    SymbolCharset = "string",
    ZxcvbnScoreThreshold = 0,
});

example, err := authentik.NewPolicyPassword(ctx, "policyPasswordResource", &authentik.PolicyPasswordArgs{
	ErrorMessage:         pulumi.String("string"),
	ExecutionLogging:     pulumi.Bool(false),
	HibpAllowedCount:     pulumi.Float64(0),
	AmountUppercase:      pulumi.Float64(0),
	CheckHaveIBeenPwned:  pulumi.Bool(false),
	CheckStaticRules:     pulumi.Bool(false),
	CheckZxcvbn:          pulumi.Bool(false),
	AmountSymbols:        pulumi.Float64(0),
	AmountDigits:         pulumi.Float64(0),
	AmountLowercase:      pulumi.Float64(0),
	LengthMin:            pulumi.Float64(0),
	Name:                 pulumi.String("string"),
	PasswordField:        pulumi.String("string"),
	PolicyPasswordId:     pulumi.String("string"),
	SymbolCharset:        pulumi.String("string"),
	ZxcvbnScoreThreshold: pulumi.Float64(0),
})

var policyPasswordResource = new PolicyPassword("policyPasswordResource", PolicyPasswordArgs.builder()
    .errorMessage("string")
    .executionLogging(false)
    .hibpAllowedCount(0)
    .amountUppercase(0)
    .checkHaveIBeenPwned(false)
    .checkStaticRules(false)
    .checkZxcvbn(false)
    .amountSymbols(0)
    .amountDigits(0)
    .amountLowercase(0)
    .lengthMin(0)
    .name("string")
    .passwordField("string")
    .policyPasswordId("string")
    .symbolCharset("string")
    .zxcvbnScoreThreshold(0)
    .build());

policy_password_resource = authentik.PolicyPassword("policyPasswordResource",
    error_message="string",
    execution_logging=False,
    hibp_allowed_count=0,
    amount_uppercase=0,
    check_have_i_been_pwned=False,
    check_static_rules=False,
    check_zxcvbn=False,
    amount_symbols=0,
    amount_digits=0,
    amount_lowercase=0,
    length_min=0,
    name="string",
    password_field="string",
    policy_password_id="string",
    symbol_charset="string",
    zxcvbn_score_threshold=0)

const policyPasswordResource = new authentik.PolicyPassword("policyPasswordResource", {
    errorMessage: "string",
    executionLogging: false,
    hibpAllowedCount: 0,
    amountUppercase: 0,
    checkHaveIBeenPwned: false,
    checkStaticRules: false,
    checkZxcvbn: false,
    amountSymbols: 0,
    amountDigits: 0,
    amountLowercase: 0,
    lengthMin: 0,
    name: "string",
    passwordField: "string",
    policyPasswordId: "string",
    symbolCharset: "string",
    zxcvbnScoreThreshold: 0,
});

type: authentik:PolicyPassword
properties:
    amountDigits: 0
    amountLowercase: 0
    amountSymbols: 0
    amountUppercase: 0
    checkHaveIBeenPwned: false
    checkStaticRules: false
    checkZxcvbn: false
    errorMessage: string
    executionLogging: false
    hibpAllowedCount: 0
    lengthMin: 0
    name: string
    passwordField: string
    policyPasswordId: string
    symbolCharset: string
    zxcvbnScoreThreshold: 0

PolicyPassword 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 PolicyPassword resource accepts the following input properties:

ErrorMessage string
AmountDigits double
AmountLowercase double
AmountSymbols double
AmountUppercase double
CheckHaveIBeenPwned bool: Defaults to false.
CheckStaticRules bool: Defaults to true.
CheckZxcvbn bool: Defaults to false.
ExecutionLogging bool: Defaults to false.
HibpAllowedCount double: Defaults to 1.
LengthMin double
Name string
PasswordField string: Defaults to password.
PolicyPasswordId string: The ID of this resource.
SymbolCharset string: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
ZxcvbnScoreThreshold double: Defaults to 2.

ErrorMessage string
AmountDigits float64
AmountLowercase float64
AmountSymbols float64
AmountUppercase float64
CheckHaveIBeenPwned bool: Defaults to false.
CheckStaticRules bool: Defaults to true.
CheckZxcvbn bool: Defaults to false.
ExecutionLogging bool: Defaults to false.
HibpAllowedCount float64: Defaults to 1.
LengthMin float64
Name string
PasswordField string: Defaults to password.
PolicyPasswordId string: The ID of this resource.
SymbolCharset string: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
ZxcvbnScoreThreshold float64: Defaults to 2.

errorMessage String
amountDigits Double
amountLowercase Double
amountSymbols Double
amountUppercase Double
checkHaveIBeenPwned Boolean: Defaults to false.
checkStaticRules Boolean: Defaults to true.
checkZxcvbn Boolean: Defaults to false.
executionLogging Boolean: Defaults to false.
hibpAllowedCount Double: Defaults to 1.
lengthMin Double
name String
passwordField String: Defaults to password.
policyPasswordId String: The ID of this resource.
symbolCharset String: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
zxcvbnScoreThreshold Double: Defaults to 2.

errorMessage string
amountDigits number
amountLowercase number
amountSymbols number
amountUppercase number
checkHaveIBeenPwned boolean: Defaults to false.
checkStaticRules boolean: Defaults to true.
checkZxcvbn boolean: Defaults to false.
executionLogging boolean: Defaults to false.
hibpAllowedCount number: Defaults to 1.
lengthMin number
name string
passwordField string: Defaults to password.
policyPasswordId string: The ID of this resource.
symbolCharset string: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
zxcvbnScoreThreshold number: Defaults to 2.

error_message str
amount_digits float
amount_lowercase float
amount_symbols float
amount_uppercase float
check_have_i_been_pwned bool: Defaults to false.
check_static_rules bool: Defaults to true.
check_zxcvbn bool: Defaults to false.
execution_logging bool: Defaults to false.
hibp_allowed_count float: Defaults to 1.
length_min float
name str
password_field str: Defaults to password.
policy_password_id str: The ID of this resource.
symbol_charset str: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
zxcvbn_score_threshold float: Defaults to 2.

errorMessage String
amountDigits Number
amountLowercase Number
amountSymbols Number
amountUppercase Number
checkHaveIBeenPwned Boolean: Defaults to false.
checkStaticRules Boolean: Defaults to true.
checkZxcvbn Boolean: Defaults to false.
executionLogging Boolean: Defaults to false.
hibpAllowedCount Number: Defaults to 1.
lengthMin Number
name String
passwordField String: Defaults to password.
policyPasswordId String: The ID of this resource.
symbolCharset String: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
zxcvbnScoreThreshold Number: Defaults to 2.

Outputs

All input properties are implicitly available as output properties. Additionally, the PolicyPassword 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 Existing PolicyPassword Resource

Get an existing PolicyPassword 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?: PolicyPasswordState, opts?: CustomResourceOptions): PolicyPassword

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amount_digits: Optional[float] = None,
        amount_lowercase: Optional[float] = None,
        amount_symbols: Optional[float] = None,
        amount_uppercase: Optional[float] = None,
        check_have_i_been_pwned: Optional[bool] = None,
        check_static_rules: Optional[bool] = None,
        check_zxcvbn: Optional[bool] = None,
        error_message: Optional[str] = None,
        execution_logging: Optional[bool] = None,
        hibp_allowed_count: Optional[float] = None,
        length_min: Optional[float] = None,
        name: Optional[str] = None,
        password_field: Optional[str] = None,
        policy_password_id: Optional[str] = None,
        symbol_charset: Optional[str] = None,
        zxcvbn_score_threshold: Optional[float] = None) -> PolicyPassword

func GetPolicyPassword(ctx *Context, name string, id IDInput, state *PolicyPasswordState, opts ...ResourceOption) (*PolicyPassword, error)

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

public static PolicyPassword get(String name, Output<String> id, PolicyPasswordState state, CustomResourceOptions options)

resources:  _:    type: authentik:PolicyPassword    get:      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:

AmountDigits double
AmountLowercase double
AmountSymbols double
AmountUppercase double
CheckHaveIBeenPwned bool: Defaults to false.
CheckStaticRules bool: Defaults to true.
CheckZxcvbn bool: Defaults to false.
ErrorMessage string
ExecutionLogging bool: Defaults to false.
HibpAllowedCount double: Defaults to 1.
LengthMin double
Name string
PasswordField string: Defaults to password.
PolicyPasswordId string: The ID of this resource.
SymbolCharset string: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
ZxcvbnScoreThreshold double: Defaults to 2.

AmountDigits float64
AmountLowercase float64
AmountSymbols float64
AmountUppercase float64
CheckHaveIBeenPwned bool: Defaults to false.
CheckStaticRules bool: Defaults to true.
CheckZxcvbn bool: Defaults to false.
ErrorMessage string
ExecutionLogging bool: Defaults to false.
HibpAllowedCount float64: Defaults to 1.
LengthMin float64
Name string
PasswordField string: Defaults to password.
PolicyPasswordId string: The ID of this resource.
SymbolCharset string: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
ZxcvbnScoreThreshold float64: Defaults to 2.

amountDigits Double
amountLowercase Double
amountSymbols Double
amountUppercase Double
checkHaveIBeenPwned Boolean: Defaults to false.
checkStaticRules Boolean: Defaults to true.
checkZxcvbn Boolean: Defaults to false.
errorMessage String
executionLogging Boolean: Defaults to false.
hibpAllowedCount Double: Defaults to 1.
lengthMin Double
name String
passwordField String: Defaults to password.
policyPasswordId String: The ID of this resource.
symbolCharset String: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
zxcvbnScoreThreshold Double: Defaults to 2.

amountDigits number
amountLowercase number
amountSymbols number
amountUppercase number
checkHaveIBeenPwned boolean: Defaults to false.
checkStaticRules boolean: Defaults to true.
checkZxcvbn boolean: Defaults to false.
errorMessage string
executionLogging boolean: Defaults to false.
hibpAllowedCount number: Defaults to 1.
lengthMin number
name string
passwordField string: Defaults to password.
policyPasswordId string: The ID of this resource.
symbolCharset string: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
zxcvbnScoreThreshold number: Defaults to 2.

amount_digits float
amount_lowercase float
amount_symbols float
amount_uppercase float
check_have_i_been_pwned bool: Defaults to false.
check_static_rules bool: Defaults to true.
check_zxcvbn bool: Defaults to false.
error_message str
execution_logging bool: Defaults to false.
hibp_allowed_count float: Defaults to 1.
length_min float
name str
password_field str: Defaults to password.
policy_password_id str: The ID of this resource.
symbol_charset str: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
zxcvbn_score_threshold float: Defaults to 2.

amountDigits Number
amountLowercase Number
amountSymbols Number
amountUppercase Number
checkHaveIBeenPwned Boolean: Defaults to false.
checkStaticRules Boolean: Defaults to true.
checkZxcvbn Boolean: Defaults to false.
errorMessage String
executionLogging Boolean: Defaults to false.
hibpAllowedCount Number: Defaults to 1.
lengthMin Number
name String
passwordField String: Defaults to password.
policyPasswordId String: The ID of this resource.
symbolCharset String: Defaults to !\"#$%&'()*+,-./:;<=>?@[\]^_{|}~`.
zxcvbnScoreThreshold Number: Defaults to 2.

Package Details

Repository: authentik goauthentik/terraform-provider-authentik
License
Notes: This Pulumi package is based on the authentik Terraform Provider.

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

authentik.PolicyPassword

On this page

On this page

Example Usage

Create PolicyPassword Resource

Constructor syntax

Parameters

Constructor example

PolicyPassword Resource Properties

Inputs

Outputs

Look up Existing PolicyPassword Resource

Package Details

On this page

On this page