pulumi-vault-kotlin/com.pulumi.vault.kotlin/MfaOktaArgs

MfaOktaArgs

data class MfaOktaArgs(val apiToken: Output<String>? = null, val baseUrl: Output<String>? = null, val mountAccessor: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val orgName: Output<String>? = null, val primaryEmail: Output<Boolean>? = null, val usernameFormat: Output<String>? = null) : ConvertibleToJava<MfaOktaArgs>

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",
});

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")

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",
    });
});

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
	})
}

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());
    }
}

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

Import

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

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

Constructors

MfaOktaArgs

constructor(apiToken: Output<String>? = null, baseUrl: Output<String>? = null, mountAccessor: Output<String>? = null, name: Output<String>? = null, namespace: Output<String>? = null, orgName: Output<String>? = null, primaryEmail: Output<Boolean>? = null, usernameFormat: Output<String>? = null)

Properties

apiToken

val apiToken: Output<String>? = null

(string: <required>) - Okta API key.

baseUrl

val baseUrl: Output<String>? = null

(string) - If set, will be used as the base domain for API requests. Examples are okta.com, oktapreview.com, and okta-emea.com.

mountAccessor

val mountAccessor: Output<String>? = null

(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

val name: Output<String>? = null

(string: <required>) – Name of the MFA method.

namespace

val namespace: Output<String>? = null

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

val orgName: Output<String>? = null

(string: <required>) - Name of the organization to be used in the Okta API.

primaryEmail

val primaryEmail: Output<Boolean>? = null

(string: <required>) - If set to true, the username will only match the primary email for the account.

usernameFormat

val usernameFormat: Output<String>? = null

(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:

Functions

toJava

open override fun toJava(): MfaOktaArgs