RuleMfa

Creates an MFA Policy Rule.

This resource allows you to create and configure an MFA Policy Rule.

Create a RuleMfa Resource

new RuleMfa(name: string, args: RuleMfaArgs, opts?: CustomResourceOptions);

def RuleMfa(resource_name, opts=None, enroll=None, name=None, network_connection=None, network_excludes=None, network_includes=None, policyid=None, priority=None, status=None, users_excludeds=None, __props__=None);

func NewRuleMfa(ctx *Context, name string, args RuleMfaArgs, opts ...ResourceOption) (*RuleMfa, error)

public RuleMfa(string name, RuleMfaArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RuleMfaArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

RuleMfa Resource Properties

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

Inputs

The RuleMfa resource accepts the following input properties:

Policyid string: Policy ID.
Enroll string: When a user should be prompted for MFA. It can be "CHALLENGE", "LOGIN", or "NEVER".
Name string: Policy Rule Name.
NetworkConnection string: Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK".
NetworkExcludes List<string>: The network zones to exclude. Conflicts with network_includes.
NetworkIncludes List<string>: The network zones to include. Conflicts with network_excludes.
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.
Status string: Policy Rule Status: "ACTIVE" or "INACTIVE".
UsersExcludeds List<string>: Set of User IDs to Exclude

Policyid string: Policy ID.
Enroll string: When a user should be prompted for MFA. It can be "CHALLENGE", "LOGIN", or "NEVER".
Name string: Policy Rule Name.
NetworkConnection string: Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK".
NetworkExcludes []string: The network zones to exclude. Conflicts with network_includes.
NetworkIncludes []string: The network zones to include. Conflicts with network_excludes.
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.
Status string: Policy Rule Status: "ACTIVE" or "INACTIVE".
UsersExcludeds []string: Set of User IDs to Exclude

policyid string: Policy ID.
enroll string: When a user should be prompted for MFA. It can be "CHALLENGE", "LOGIN", or "NEVER".
name string: Policy Rule Name.
networkConnection string: Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK".
networkExcludes string[]: The network zones to exclude. Conflicts with network_includes.
networkIncludes string[]: The network zones to include. Conflicts with network_excludes.
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.
status string: Policy Rule Status: "ACTIVE" or "INACTIVE".
usersExcludeds string[]: Set of User IDs to Exclude

policyid str: Policy ID.
enroll str: When a user should be prompted for MFA. It can be "CHALLENGE", "LOGIN", or "NEVER".
name str: Policy Rule Name.
network_connection str: Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK".
network_excludes List[str]: The network zones to exclude. Conflicts with network_includes.
network_includes List[str]: The network zones to include. Conflicts with network_excludes.
priority float: 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.
status str: Policy Rule Status: "ACTIVE" or "INACTIVE".
users_excludeds List[str]: Set of User IDs to Exclude

Outputs

All input properties are implicitly available as output properties. Additionally, the RuleMfa 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing RuleMfa Resource

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

static get(resource_name, id, opts=None, enroll=None, name=None, network_connection=None, network_excludes=None, network_includes=None, policyid=None, priority=None, status=None, users_excludeds=None, __props__=None);

func GetRuleMfa(ctx *Context, name string, id IDInput, state *RuleMfaState, opts ...ResourceOption) (*RuleMfa, error)

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

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.

The following state arguments are supported:

Enroll string: When a user should be prompted for MFA. It can be "CHALLENGE", "LOGIN", or "NEVER".
Name string: Policy Rule Name.
NetworkConnection string: Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK".
NetworkExcludes List<string>: The network zones to exclude. Conflicts with network_includes.
NetworkIncludes List<string>: The network zones to include. Conflicts with network_excludes.
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.
Status string: Policy Rule Status: "ACTIVE" or "INACTIVE".
UsersExcludeds List<string>: Set of User IDs to Exclude

Enroll string: When a user should be prompted for MFA. It can be "CHALLENGE", "LOGIN", or "NEVER".
Name string: Policy Rule Name.
NetworkConnection string: Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK".
NetworkExcludes []string: The network zones to exclude. Conflicts with network_includes.
NetworkIncludes []string: The network zones to include. Conflicts with network_excludes.
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.
Status string: Policy Rule Status: "ACTIVE" or "INACTIVE".
UsersExcludeds []string: Set of User IDs to Exclude

enroll string: When a user should be prompted for MFA. It can be "CHALLENGE", "LOGIN", or "NEVER".
name string: Policy Rule Name.
networkConnection string: Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK".
networkExcludes string[]: The network zones to exclude. Conflicts with network_includes.
networkIncludes string[]: The network zones to include. Conflicts with network_excludes.
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.
status string: Policy Rule Status: "ACTIVE" or "INACTIVE".
usersExcludeds string[]: Set of User IDs to Exclude

enroll str: When a user should be prompted for MFA. It can be "CHALLENGE", "LOGIN", or "NEVER".
name str: Policy Rule Name.
network_connection str: Network selection mode: "ANYWHERE", "ZONE", "ON_NETWORK", or "OFF_NETWORK".
network_excludes List[str]: The network zones to exclude. Conflicts with network_includes.
network_includes List[str]: The network zones to include. Conflicts with network_excludes.
policyid str: Policy ID.
priority float: 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.
status str: Policy Rule Status: "ACTIVE" or "INACTIVE".
users_excludeds List[str]: Set of User IDs to Exclude

Package Details

Repository: https://github.com/pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud