1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. MfaOkta
HashiCorp Vault v6.7.0 published on Thursday, Apr 24, 2025 by Pulumi

vault.MfaOkta

Explore with Pulumi AI

Provides a resource to manage Okta MFA.

Note this feature is available only with Vault Enterprise.

Example Usage

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

const userpass = new vault.AuthBackend("userpass", {
    type: "userpass",
    path: "userpass",
});
const myOkta = new vault.MfaOkta("my_okta", {
    name: "my_okta",
    mountAccessor: userpass.accessor,
    usernameFormat: "user@example.com",
    orgName: "hashicorp",
    apiToken: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
});
Copy
import pulumi
import pulumi_vault as vault

userpass = vault.AuthBackend("userpass",
    type="userpass",
    path="userpass")
my_okta = vault.MfaOkta("my_okta",
    name="my_okta",
    mount_accessor=userpass.accessor,
    username_format="user@example.com",
    org_name="hashicorp",
    api_token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9")
Copy
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		userpass, err := vault.NewAuthBackend(ctx, "userpass", &vault.AuthBackendArgs{
			Type: pulumi.String("userpass"),
			Path: pulumi.String("userpass"),
		})
		if err != nil {
			return err
		}
		_, err = vault.NewMfaOkta(ctx, "my_okta", &vault.MfaOktaArgs{
			Name:           pulumi.String("my_okta"),
			MountAccessor:  userpass.Accessor,
			UsernameFormat: pulumi.String("user@example.com"),
			OrgName:        pulumi.String("hashicorp"),
			ApiToken:       pulumi.String("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var userpass = new Vault.AuthBackend("userpass", new()
    {
        Type = "userpass",
        Path = "userpass",
    });

    var myOkta = new Vault.MfaOkta("my_okta", new()
    {
        Name = "my_okta",
        MountAccessor = userpass.Accessor,
        UsernameFormat = "user@example.com",
        OrgName = "hashicorp",
        ApiToken = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.AuthBackend;
import com.pulumi.vault.AuthBackendArgs;
import com.pulumi.vault.MfaOkta;
import com.pulumi.vault.MfaOktaArgs;
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 userpass = new AuthBackend("userpass", AuthBackendArgs.builder()
            .type("userpass")
            .path("userpass")
            .build());

        var myOkta = new MfaOkta("myOkta", MfaOktaArgs.builder()
            .name("my_okta")
            .mountAccessor(userpass.accessor())
            .usernameFormat("user@example.com")
            .orgName("hashicorp")
            .apiToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9")
            .build());

    }
}
Copy
resources:
  userpass:
    type: vault:AuthBackend
    properties:
      type: userpass
      path: userpass
  myOkta:
    type: vault:MfaOkta
    name: my_okta
    properties:
      name: my_okta
      mountAccessor: ${userpass.accessor}
      usernameFormat: user@example.com
      orgName: hashicorp
      apiToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
Copy

Create MfaOkta Resource

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

Constructor syntax

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

@overload
def MfaOkta(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            api_token: Optional[str] = None,
            mount_accessor: Optional[str] = None,
            org_name: Optional[str] = None,
            base_url: Optional[str] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None,
            primary_email: Optional[bool] = None,
            username_format: Optional[str] = None)
func NewMfaOkta(ctx *Context, name string, args MfaOktaArgs, opts ...ResourceOption) (*MfaOkta, error)
public MfaOkta(string name, MfaOktaArgs args, CustomResourceOptions? opts = null)
public MfaOkta(String name, MfaOktaArgs args)
public MfaOkta(String name, MfaOktaArgs args, CustomResourceOptions options)
type: vault:MfaOkta
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MfaOktaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MfaOktaArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MfaOktaArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MfaOktaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MfaOktaArgs
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 vaultMfaOktaResource = new Vault.MfaOkta("vaultMfaOktaResource", new()
{
    ApiToken = "string",
    MountAccessor = "string",
    OrgName = "string",
    BaseUrl = "string",
    Name = "string",
    Namespace = "string",
    PrimaryEmail = false,
    UsernameFormat = "string",
});
Copy
example, err := vault.NewMfaOkta(ctx, "vaultMfaOktaResource", &vault.MfaOktaArgs{
	ApiToken:       pulumi.String("string"),
	MountAccessor:  pulumi.String("string"),
	OrgName:        pulumi.String("string"),
	BaseUrl:        pulumi.String("string"),
	Name:           pulumi.String("string"),
	Namespace:      pulumi.String("string"),
	PrimaryEmail:   pulumi.Bool(false),
	UsernameFormat: pulumi.String("string"),
})
Copy
var vaultMfaOktaResource = new com.pulumi.vault.MfaOkta("vaultMfaOktaResource", com.pulumi.vault.MfaOktaArgs.builder()
    .apiToken("string")
    .mountAccessor("string")
    .orgName("string")
    .baseUrl("string")
    .name("string")
    .namespace("string")
    .primaryEmail(false)
    .usernameFormat("string")
    .build());
Copy
vault_mfa_okta_resource = vault.MfaOkta("vaultMfaOktaResource",
    api_token="string",
    mount_accessor="string",
    org_name="string",
    base_url="string",
    name="string",
    namespace="string",
    primary_email=False,
    username_format="string")
Copy
const vaultMfaOktaResource = new vault.MfaOkta("vaultMfaOktaResource", {
    apiToken: "string",
    mountAccessor: "string",
    orgName: "string",
    baseUrl: "string",
    name: "string",
    namespace: "string",
    primaryEmail: false,
    usernameFormat: "string",
});
Copy
type: vault:MfaOkta
properties:
    apiToken: string
    baseUrl: string
    mountAccessor: string
    name: string
    namespace: string
    orgName: string
    primaryEmail: false
    usernameFormat: string
Copy

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

ApiToken
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - Okta API key.
MountAccessor
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
OrgName
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - Name of the organization to be used in the Okta API.
BaseUrl Changes to this property will trigger replacement. string
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
Name Changes to this property will trigger replacement. string
(string: <required>) – Name of the MFA method.
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
PrimaryEmail Changes to this property will trigger replacement. bool
(string: <required>) - If set to true, the username will only match the primary email for the account.
UsernameFormat Changes to this property will trigger replacement. string
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
ApiToken
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - Okta API key.
MountAccessor
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
OrgName
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - Name of the organization to be used in the Okta API.
BaseUrl Changes to this property will trigger replacement. string
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
Name Changes to this property will trigger replacement. string
(string: <required>) – Name of the MFA method.
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
PrimaryEmail Changes to this property will trigger replacement. bool
(string: <required>) - If set to true, the username will only match the primary email for the account.
UsernameFormat Changes to this property will trigger replacement. string
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
apiToken
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - Okta API key.
mountAccessor
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
orgName
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - Name of the organization to be used in the Okta API.
baseUrl Changes to this property will trigger replacement. String
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
name Changes to this property will trigger replacement. String
(string: <required>) – Name of the MFA method.
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
primaryEmail Changes to this property will trigger replacement. Boolean
(string: <required>) - If set to true, the username will only match the primary email for the account.
usernameFormat Changes to this property will trigger replacement. String
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
apiToken
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - Okta API key.
mountAccessor
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
orgName
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - Name of the organization to be used in the Okta API.
baseUrl Changes to this property will trigger replacement. string
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
name Changes to this property will trigger replacement. string
(string: <required>) – Name of the MFA method.
namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
primaryEmail Changes to this property will trigger replacement. boolean
(string: <required>) - If set to true, the username will only match the primary email for the account.
usernameFormat Changes to this property will trigger replacement. string
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
api_token
This property is required.
Changes to this property will trigger replacement.
str
(string: <required>) - Okta API key.
mount_accessor
This property is required.
Changes to this property will trigger replacement.
str
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
org_name
This property is required.
Changes to this property will trigger replacement.
str
(string: <required>) - Name of the organization to be used in the Okta API.
base_url Changes to this property will trigger replacement. str
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
name Changes to this property will trigger replacement. str
(string: <required>) – Name of the MFA method.
namespace Changes to this property will trigger replacement. str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
primary_email Changes to this property will trigger replacement. bool
(string: <required>) - If set to true, the username will only match the primary email for the account.
username_format Changes to this property will trigger replacement. str
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
apiToken
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - Okta API key.
mountAccessor
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
orgName
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - Name of the organization to be used in the Okta API.
baseUrl Changes to this property will trigger replacement. String
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
name Changes to this property will trigger replacement. String
(string: <required>) – Name of the MFA method.
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
primaryEmail Changes to this property will trigger replacement. Boolean
(string: <required>) - If set to true, the username will only match the primary email for the account.
usernameFormat Changes to this property will trigger replacement. String
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter

Outputs

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

Get an existing MfaOkta 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?: MfaOktaState, opts?: CustomResourceOptions): MfaOkta
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_token: Optional[str] = None,
        base_url: Optional[str] = None,
        mount_accessor: Optional[str] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        org_name: Optional[str] = None,
        primary_email: Optional[bool] = None,
        username_format: Optional[str] = None) -> MfaOkta
func GetMfaOkta(ctx *Context, name string, id IDInput, state *MfaOktaState, opts ...ResourceOption) (*MfaOkta, error)
public static MfaOkta Get(string name, Input<string> id, MfaOktaState? state, CustomResourceOptions? opts = null)
public static MfaOkta get(String name, Output<String> id, MfaOktaState state, CustomResourceOptions options)
resources:  _:    type: vault:MfaOkta    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ApiToken Changes to this property will trigger replacement. string
(string: <required>) - Okta API key.
BaseUrl Changes to this property will trigger replacement. string
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
MountAccessor Changes to this property will trigger replacement. string
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
Name Changes to this property will trigger replacement. string
(string: <required>) – Name of the MFA method.
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
OrgName Changes to this property will trigger replacement. string
(string: <required>) - Name of the organization to be used in the Okta API.
PrimaryEmail Changes to this property will trigger replacement. bool
(string: <required>) - If set to true, the username will only match the primary email for the account.
UsernameFormat Changes to this property will trigger replacement. string
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
ApiToken Changes to this property will trigger replacement. string
(string: <required>) - Okta API key.
BaseUrl Changes to this property will trigger replacement. string
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
MountAccessor Changes to this property will trigger replacement. string
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
Name Changes to this property will trigger replacement. string
(string: <required>) – Name of the MFA method.
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
OrgName Changes to this property will trigger replacement. string
(string: <required>) - Name of the organization to be used in the Okta API.
PrimaryEmail Changes to this property will trigger replacement. bool
(string: <required>) - If set to true, the username will only match the primary email for the account.
UsernameFormat Changes to this property will trigger replacement. string
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
apiToken Changes to this property will trigger replacement. String
(string: <required>) - Okta API key.
baseUrl Changes to this property will trigger replacement. String
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
mountAccessor Changes to this property will trigger replacement. String
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
name Changes to this property will trigger replacement. String
(string: <required>) – Name of the MFA method.
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
orgName Changes to this property will trigger replacement. String
(string: <required>) - Name of the organization to be used in the Okta API.
primaryEmail Changes to this property will trigger replacement. Boolean
(string: <required>) - If set to true, the username will only match the primary email for the account.
usernameFormat Changes to this property will trigger replacement. String
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
apiToken Changes to this property will trigger replacement. string
(string: <required>) - Okta API key.
baseUrl Changes to this property will trigger replacement. string
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
mountAccessor Changes to this property will trigger replacement. string
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
name Changes to this property will trigger replacement. string
(string: <required>) – Name of the MFA method.
namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
orgName Changes to this property will trigger replacement. string
(string: <required>) - Name of the organization to be used in the Okta API.
primaryEmail Changes to this property will trigger replacement. boolean
(string: <required>) - If set to true, the username will only match the primary email for the account.
usernameFormat Changes to this property will trigger replacement. string
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
api_token Changes to this property will trigger replacement. str
(string: <required>) - Okta API key.
base_url Changes to this property will trigger replacement. str
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
mount_accessor Changes to this property will trigger replacement. str
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
name Changes to this property will trigger replacement. str
(string: <required>) – Name of the MFA method.
namespace Changes to this property will trigger replacement. str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
org_name Changes to this property will trigger replacement. str
(string: <required>) - Name of the organization to be used in the Okta API.
primary_email Changes to this property will trigger replacement. bool
(string: <required>) - If set to true, the username will only match the primary email for the account.
username_format Changes to this property will trigger replacement. str
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter
apiToken Changes to this property will trigger replacement. String
(string: <required>) - Okta API key.
baseUrl Changes to this property will trigger replacement. String
(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.
mountAccessor Changes to this property will trigger replacement. String
(string: <required>) - The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.
name Changes to this property will trigger replacement. String
(string: <required>) – Name of the MFA method.
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
orgName Changes to this property will trigger replacement. String
(string: <required>) - Name of the organization to be used in the Okta API.
primaryEmail Changes to this property will trigger replacement. Boolean
(string: <required>) - If set to true, the username will only match the primary email for the account.
usernameFormat Changes to this property will trigger replacement. String
(string) - A format string for mapping Identity names to MFA method names. Values to substitute should be placed in {{}}. For example, "{{alias.name}}@example.com". If blank, the Alias's Name field will be used as-is. Currently-supported mappings:

  • alias.name: The name returned by the mount configured via the mount_accessor parameter
  • entity.name: The name configured for the Entity
  • alias.metadata.<key>: The value of the Alias's metadata parameter
  • entity.metadata.<key>: The value of the Entity's metadata parameter

Import

Mounts can be imported using the path, e.g.

$ pulumi import vault:index/mfaOkta:MfaOkta my_okta my_okta
Copy

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

Package Details

Repository
Vault pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.