Docs Packages
  1. Packages
  2. Zitadel
  3. API Docs
  4. LockoutPolicy
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

zitadel.LockoutPolicy

Explore with Pulumi AI

zitadel logo
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

    Resource representing the custom lockout policy of an organization.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumiverse.Zitadel;

return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.LockoutPolicy("default", new()
    {
        OrgId = data.Zitadel_org.Default.Id,
        MaxPasswordAttempts = 5,
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zitadel.NewLockoutPolicy(ctx, "default", &zitadel.LockoutPolicyArgs{
			OrgId:               pulumi.Any(data.Zitadel_org.Default.Id),
			MaxPasswordAttempts: pulumi.Int(5),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zitadel.LockoutPolicy;
import com.pulumi.zitadel.LockoutPolicyArgs;
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 default_ = new LockoutPolicy("default", LockoutPolicyArgs.builder()        
            .orgId(data.zitadel_org().default().id())
            .maxPasswordAttempts("5")
            .build());

    }
}

    import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.LockoutPolicy("default",
    org_id=data["zitadel_org"]["default"]["id"],
    max_password_attempts=5)

    import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumiverse/zitadel";

const _default = new zitadel.LockoutPolicy("default", {
    orgId: data.zitadel_org["default"].id,
    maxPasswordAttempts: 5,
});

    resources:
  default:
    type: zitadel:LockoutPolicy
    properties:
      orgId: ${data.zitadel_org.default.id}
      maxPasswordAttempts: '5'

    Create LockoutPolicy Resource

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

    Constructor syntax

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

@overload
def LockoutPolicy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  max_password_attempts: Optional[int] = None,
                  org_id: Optional[str] = None)
    func NewLockoutPolicy(ctx *Context, name string, args LockoutPolicyArgs, opts ...ResourceOption) (*LockoutPolicy, error)
    public LockoutPolicy(string name, LockoutPolicyArgs args, CustomResourceOptions? opts = null)
    public LockoutPolicy(String name, LockoutPolicyArgs args)
public LockoutPolicy(String name, LockoutPolicyArgs args, CustomResourceOptions options)

    type: zitadel:LockoutPolicy
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 LockoutPolicyArgs
    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 LockoutPolicyArgs
    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 LockoutPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LockoutPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LockoutPolicyArgs
    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 lockoutPolicyResource = new Zitadel.LockoutPolicy("lockoutPolicyResource", new()
{
    MaxPasswordAttempts = 0,
    OrgId = "string",
});

    example, err := zitadel.NewLockoutPolicy(ctx, "lockoutPolicyResource", &zitadel.LockoutPolicyArgs{
	MaxPasswordAttempts: pulumi.Int(0),
	OrgId:               pulumi.String("string"),
})

    var lockoutPolicyResource = new LockoutPolicy("lockoutPolicyResource", LockoutPolicyArgs.builder()
    .maxPasswordAttempts(0)
    .orgId("string")
    .build());

    lockout_policy_resource = zitadel.LockoutPolicy("lockoutPolicyResource",
    max_password_attempts=0,
    org_id="string")

    const lockoutPolicyResource = new zitadel.LockoutPolicy("lockoutPolicyResource", {
    maxPasswordAttempts: 0,
    orgId: "string",
});

    type: zitadel:LockoutPolicy
properties:
    maxPasswordAttempts: 0
    orgId: string

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

    MaxPasswordAttempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    OrgId string
    ID of the organization
    MaxPasswordAttempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    OrgId string
    ID of the organization
    maxPasswordAttempts Integer
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    orgId String
    ID of the organization
    maxPasswordAttempts number
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    orgId string
    ID of the organization
    max_password_attempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    org_id str
    ID of the organization
    maxPasswordAttempts Number
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    orgId String
    ID of the organization

    Outputs

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

    Get an existing LockoutPolicy 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?: LockoutPolicyState, opts?: CustomResourceOptions): LockoutPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        max_password_attempts: Optional[int] = None,
        org_id: Optional[str] = None) -> LockoutPolicy
    func GetLockoutPolicy(ctx *Context, name string, id IDInput, state *LockoutPolicyState, opts ...ResourceOption) (*LockoutPolicy, error)
    public static LockoutPolicy Get(string name, Input<string> id, LockoutPolicyState? state, CustomResourceOptions? opts = null)
    public static LockoutPolicy get(String name, Output<String> id, LockoutPolicyState 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:
    MaxPasswordAttempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    OrgId string
    ID of the organization
    MaxPasswordAttempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    OrgId string
    ID of the organization
    maxPasswordAttempts Integer
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    orgId String
    ID of the organization
    maxPasswordAttempts number
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    orgId string
    ID of the organization
    max_password_attempts int
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    org_id str
    ID of the organization
    maxPasswordAttempts Number
    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correct or the password is reset.
    orgId String
    ID of the organization

    Import

    terraform The resource can be imported using the ID format <[org_id]>, e.g.

     $ pulumi import zitadel:index/lockoutPolicy:LockoutPolicy imported '123456789012345678'

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
    pulumiverse/pulumi-zitadel