Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. policy
  5. RulePassword
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

okta.policy.RulePassword

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

    Creates a Password Policy Rule.

    This resource allows you to create and configure a Password Policy Rule.

    Create RulePassword Resource

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

    Constructor syntax

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

@overload
def RulePassword(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 name: Optional[str] = None,
                 network_connection: Optional[str] = None,
                 network_excludes: Optional[Sequence[str]] = None,
                 network_includes: Optional[Sequence[str]] = None,
                 password_change: Optional[str] = None,
                 password_reset: Optional[str] = None,
                 password_unlock: Optional[str] = None,
                 policy_id: Optional[str] = None,
                 priority: Optional[int] = None,
                 status: Optional[str] = None,
                 users_excludeds: Optional[Sequence[str]] = None)
    func NewRulePassword(ctx *Context, name string, args *RulePasswordArgs, opts ...ResourceOption) (*RulePassword, error)
    public RulePassword(string name, RulePasswordArgs? args = null, CustomResourceOptions? opts = null)
    public RulePassword(String name, RulePasswordArgs args)
public RulePassword(String name, RulePasswordArgs args, CustomResourceOptions options)

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

    Example

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

    var rulePasswordResource = new Okta.Policy.RulePassword("rulePasswordResource", new()
{
    Name = "string",
    NetworkConnection = "string",
    NetworkExcludes = new[]
    {
        "string",
    },
    NetworkIncludes = new[]
    {
        "string",
    },
    PasswordChange = "string",
    PasswordReset = "string",
    PasswordUnlock = "string",
    PolicyId = "string",
    Priority = 0,
    Status = "string",
    UsersExcludeds = new[]
    {
        "string",
    },
});

    example, err := policy.NewRulePassword(ctx, "rulePasswordResource", &policy.RulePasswordArgs{
	Name:              pulumi.String("string"),
	NetworkConnection: pulumi.String("string"),
	NetworkExcludes: pulumi.StringArray{
		pulumi.String("string"),
	},
	NetworkIncludes: pulumi.StringArray{
		pulumi.String("string"),
	},
	PasswordChange: pulumi.String("string"),
	PasswordReset:  pulumi.String("string"),
	PasswordUnlock: pulumi.String("string"),
	PolicyId:       pulumi.String("string"),
	Priority:       pulumi.Int(0),
	Status:         pulumi.String("string"),
	UsersExcludeds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var rulePasswordResource = new RulePassword("rulePasswordResource", RulePasswordArgs.builder()        
    .name("string")
    .networkConnection("string")
    .networkExcludes("string")
    .networkIncludes("string")
    .passwordChange("string")
    .passwordReset("string")
    .passwordUnlock("string")
    .policyId("string")
    .priority(0)
    .status("string")
    .usersExcludeds("string")
    .build());

    rule_password_resource = okta.policy.RulePassword("rulePasswordResource",
    name="string",
    network_connection="string",
    network_excludes=["string"],
    network_includes=["string"],
    password_change="string",
    password_reset="string",
    password_unlock="string",
    policy_id="string",
    priority=0,
    status="string",
    users_excludeds=["string"])

    const rulePasswordResource = new okta.policy.RulePassword("rulePasswordResource", {
    name: "string",
    networkConnection: "string",
    networkExcludes: ["string"],
    networkIncludes: ["string"],
    passwordChange: "string",
    passwordReset: "string",
    passwordUnlock: "string",
    policyId: "string",
    priority: 0,
    status: "string",
    usersExcludeds: ["string"],
});

    type: okta:policy:RulePassword
properties:
    name: string
    networkConnection: string
    networkExcludes:
        - string
    networkIncludes:
        - string
    passwordChange: string
    passwordReset: string
    passwordUnlock: string
    policyId: string
    priority: 0
    status: string
    usersExcludeds:
        - string

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

    Name string
    Policy Rule Name. Type "string"
    NetworkConnection string
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    NetworkExcludes List<string>
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    NetworkIncludes List<string>
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    PasswordChange string
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    PasswordReset string
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    PasswordUnlock string
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    PolicyId string
    Policy ID.
    Priority int
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    Status string
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    UsersExcludeds List<string>
    The users to exclude. Type "set(string)"
    Name string
    Policy Rule Name. Type "string"
    NetworkConnection string
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    NetworkExcludes []string
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    NetworkIncludes []string
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    PasswordChange string
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    PasswordReset string
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    PasswordUnlock string
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    PolicyId string
    Policy ID.
    Priority int
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    Status string
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    UsersExcludeds []string
    The users to exclude. Type "set(string)"
    name String
    Policy Rule Name. Type "string"
    networkConnection String
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    networkExcludes List<String>
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    networkIncludes List<String>
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    passwordChange String
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordReset String
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordUnlock String
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    policyId String
    Policy ID.
    priority Integer
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    status String
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    usersExcludeds List<String>
    The users to exclude. Type "set(string)"
    name string
    Policy Rule Name. Type "string"
    networkConnection string
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    networkExcludes string[]
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    networkIncludes string[]
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    passwordChange string
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordReset string
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordUnlock string
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    policyId string
    Policy ID.
    priority number
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    status string
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    usersExcludeds string[]
    The users to exclude. Type "set(string)"
    name str
    Policy Rule Name. Type "string"
    network_connection str
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    network_excludes Sequence[str]
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    network_includes Sequence[str]
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    password_change str
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    password_reset str
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    password_unlock str
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    policy_id str
    Policy ID.
    priority int
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    status str
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    users_excludeds Sequence[str]
    The users to exclude. Type "set(string)"
    name String
    Policy Rule Name. Type "string"
    networkConnection String
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    networkExcludes List<String>
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    networkIncludes List<String>
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    passwordChange String
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordReset String
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordUnlock String
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    policyId String
    Policy ID.
    priority Number
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    status String
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    usersExcludeds List<String>
    The users to exclude. Type "set(string)"

    Outputs

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

    Get an existing RulePassword 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?: RulePasswordState, opts?: CustomResourceOptions): RulePassword
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        network_connection: Optional[str] = None,
        network_excludes: Optional[Sequence[str]] = None,
        network_includes: Optional[Sequence[str]] = None,
        password_change: Optional[str] = None,
        password_reset: Optional[str] = None,
        password_unlock: Optional[str] = None,
        policy_id: Optional[str] = None,
        priority: Optional[int] = None,
        status: Optional[str] = None,
        users_excludeds: Optional[Sequence[str]] = None) -> RulePassword
    func GetRulePassword(ctx *Context, name string, id IDInput, state *RulePasswordState, opts ...ResourceOption) (*RulePassword, error)
    public static RulePassword Get(string name, Input<string> id, RulePasswordState? state, CustomResourceOptions? opts = null)
    public static RulePassword get(String name, Output<String> id, RulePasswordState 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:
    Name string
    Policy Rule Name. Type "string"
    NetworkConnection string
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    NetworkExcludes List<string>
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    NetworkIncludes List<string>
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    PasswordChange string
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    PasswordReset string
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    PasswordUnlock string
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    PolicyId string
    Policy ID.
    Priority int
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    Status string
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    UsersExcludeds List<string>
    The users to exclude. Type "set(string)"
    Name string
    Policy Rule Name. Type "string"
    NetworkConnection string
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    NetworkExcludes []string
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    NetworkIncludes []string
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    PasswordChange string
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    PasswordReset string
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    PasswordUnlock string
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    PolicyId string
    Policy ID.
    Priority int
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    Status string
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    UsersExcludeds []string
    The users to exclude. Type "set(string)"
    name String
    Policy Rule Name. Type "string"
    networkConnection String
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    networkExcludes List<String>
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    networkIncludes List<String>
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    passwordChange String
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordReset String
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordUnlock String
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    policyId String
    Policy ID.
    priority Integer
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    status String
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    usersExcludeds List<String>
    The users to exclude. Type "set(string)"
    name string
    Policy Rule Name. Type "string"
    networkConnection string
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    networkExcludes string[]
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    networkIncludes string[]
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    passwordChange string
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordReset string
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordUnlock string
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    policyId string
    Policy ID.
    priority number
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    status string
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    usersExcludeds string[]
    The users to exclude. Type "set(string)"
    name str
    Policy Rule Name. Type "string"
    network_connection str
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    network_excludes Sequence[str]
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    network_includes Sequence[str]
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    password_change str
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    password_reset str
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    password_unlock str
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    policy_id str
    Policy ID.
    priority int
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    status str
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    users_excludeds Sequence[str]
    The users to exclude. Type "set(string)"
    name String
    Policy Rule Name. Type "string"
    networkConnection String
    Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK". Type "string"
    networkExcludes List<String>
    The network zones to exclude. Conflicts with network_includes. Type "list(string)"
    networkIncludes List<String>
    The network zones to include. Conflicts with network_excludes. Type "list(string)"
    passwordChange String
    Allow or deny a user to change their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordReset String
    Allow or deny a user to reset their password: "ALLOW" or "DENY". By default, it is "ALLOW". Type "string"
    passwordUnlock String
    Allow or deny a user to unlock: "ALLOW" or "DENY". By default, it is "DENY", Type "string"
    policyId String
    Policy ID.
    priority Number
    Policy Rule Priority, this attribute can be set to a valid priority. To avoid endless diff situation we error if an invalid priority is provided. API defaults it to the last (lowest) if not there. Type "number"
    status String
    Policy Rule Status: "ACTIVE" or "INACTIVE". Type "string"
    usersExcludeds List<String>
    The users to exclude. Type "set(string)"

    Import

    A Policy Rule can be imported via the Policy and Rule ID.

    $ pulumi import okta:policy/rulePassword:RulePassword example &#60;policy id&#62;/&#60;rule id&#62;

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

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-okta