Okta v3.21.0, Mar 15 23

okta.factor.Factor

Allows you to manage the activation of Okta MFA methods.

This resource allows you to manage Okta MFA methods.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.Factor.Factor("example", new()
    {
        ProviderId = "google_otp",
    });

});

package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/factor"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := factor.NewFactor(ctx, "example", &factor.FactorArgs{
			ProviderId: pulumi.String("google_otp"),
		})
		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.okta.factor.Factor;
import com.pulumi.okta.factor.FactorArgs;
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 example = new Factor("example", FactorArgs.builder()        
            .providerId("google_otp")
            .build());

    }
}

import pulumi
import pulumi_okta as okta

example = okta.factor.Factor("example", provider_id="google_otp")

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

const example = new okta.factor.Factor("example", {providerId: "google_otp"});

resources:
  example:
    type: okta:factor:Factor
    properties:
      providerId: google_otp

Create Factor Resource

new Factor(name: string, args: FactorArgs, opts?: CustomResourceOptions);

@overload
def Factor(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           active: Optional[bool] = None,
           provider_id: Optional[str] = None)
@overload
def Factor(resource_name: str,
           args: FactorArgs,
           opts: Optional[ResourceOptions] = None)

func NewFactor(ctx *Context, name string, args FactorArgs, opts ...ResourceOption) (*Factor, error)

public Factor(string name, FactorArgs args, CustomResourceOptions? opts = null)

public Factor(String name, FactorArgs args)
public Factor(String name, FactorArgs args, CustomResourceOptions options)

type: okta:factor:Factor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args FactorArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

ProviderId string: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".
Active bool: Whether to activate the provider, by default, it is set to true.

ProviderId string: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".
Active bool: Whether to activate the provider, by default, it is set to true.

providerId String: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".
active Boolean: Whether to activate the provider, by default, it is set to true.

providerId string: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".
active boolean: Whether to activate the provider, by default, it is set to true.

provider_id str: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".
active bool: Whether to activate the provider, by default, it is set to true.

providerId String: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".
active Boolean: Whether to activate the provider, by default, it is set to true.

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        provider_id: Optional[str] = None) -> Factor

func GetFactor(ctx *Context, name string, id IDInput, state *FactorState, opts ...ResourceOption) (*Factor, error)

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

public static Factor get(String name, Output<String> id, FactorState 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:

Active bool: Whether to activate the provider, by default, it is set to true.
ProviderId string: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".

Active bool: Whether to activate the provider, by default, it is set to true.
ProviderId string: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".

active Boolean: Whether to activate the provider, by default, it is set to true.
providerId String: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".

active boolean: Whether to activate the provider, by default, it is set to true.
providerId string: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".

active bool: Whether to activate the provider, by default, it is set to true.
provider_id str: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".

active Boolean: Whether to activate the provider, by default, it is set to true.
providerId String: The MFA provider name. Allowed values are "duo", "fido_u2f", "fido_webauthn", "google_otp", "okta_call", "okta_otp", "okta_password", "okta_push", "okta_question", "okta_sms", "okta_email", "rsa_token", "symantec_vip", "yubikey_token", or "hotp".

Package Details

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