Docs Packages
  1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. MfaDuo
HashiCorp Vault v5.17.0 published on Thursday, Nov 9, 2023 by Pulumi
pulumi/pulumi-vault

vault.MfaDuo

Explore with Pulumi AI

vault logo
HashiCorp Vault v5.17.0 published on Thursday, Nov 9, 2023 by Pulumi
pulumi/pulumi-vault

    Provides a resource to manage Duo MFA.

    Note this feature is available only with Vault Enterprise.

    Example Usage

    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 myDuo = new Vault.MfaDuo("myDuo", new()
    {
        MountAccessor = userpass.Accessor,
        SecretKey = "8C7THtrIigh2rPZQMbguugt8IUftWhMRCOBzbuyz",
        IntegrationKey = "BIACEUEAXI20BNWTEYXT",
        ApiHostname = "api-2b5c39f5.duosecurity.com",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v5/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.NewMfaDuo(ctx, "myDuo", &vault.MfaDuoArgs{
			MountAccessor:  userpass.Accessor,
			SecretKey:      pulumi.String("8C7THtrIigh2rPZQMbguugt8IUftWhMRCOBzbuyz"),
			IntegrationKey: pulumi.String("BIACEUEAXI20BNWTEYXT"),
			ApiHostname:    pulumi.String("api-2b5c39f5.duosecurity.com"),
		})
		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.MfaDuo;
import com.pulumi.vault.MfaDuoArgs;
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 myDuo = new MfaDuo("myDuo", MfaDuoArgs.builder()        
            .mountAccessor(userpass.accessor())
            .secretKey("8C7THtrIigh2rPZQMbguugt8IUftWhMRCOBzbuyz")
            .integrationKey("BIACEUEAXI20BNWTEYXT")
            .apiHostname("api-2b5c39f5.duosecurity.com")
            .build());

    }
}

    import pulumi
import pulumi_vault as vault

userpass = vault.AuthBackend("userpass",
    type="userpass",
    path="userpass")
my_duo = vault.MfaDuo("myDuo",
    mount_accessor=userpass.accessor,
    secret_key="8C7THtrIigh2rPZQMbguugt8IUftWhMRCOBzbuyz",
    integration_key="BIACEUEAXI20BNWTEYXT",
    api_hostname="api-2b5c39f5.duosecurity.com")

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

const userpass = new vault.AuthBackend("userpass", {
    type: "userpass",
    path: "userpass",
});
const myDuo = new vault.MfaDuo("myDuo", {
    mountAccessor: userpass.accessor,
    secretKey: "8C7THtrIigh2rPZQMbguugt8IUftWhMRCOBzbuyz",
    integrationKey: "BIACEUEAXI20BNWTEYXT",
    apiHostname: "api-2b5c39f5.duosecurity.com",
});

    resources:
  userpass:
    type: vault:AuthBackend
    properties:
      type: userpass
      path: userpass
  myDuo:
    type: vault:MfaDuo
    properties:
      mountAccessor: ${userpass.accessor}
      secretKey: 8C7THtrIigh2rPZQMbguugt8IUftWhMRCOBzbuyz
      integrationKey: BIACEUEAXI20BNWTEYXT
      apiHostname: api-2b5c39f5.duosecurity.com

    Create MfaDuo Resource

    new MfaDuo(name: string, args: MfaDuoArgs, opts?: CustomResourceOptions);
    @overload
def MfaDuo(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           api_hostname: Optional[str] = None,
           integration_key: Optional[str] = None,
           mount_accessor: Optional[str] = None,
           name: Optional[str] = None,
           namespace: Optional[str] = None,
           push_info: Optional[str] = None,
           secret_key: Optional[str] = None,
           username_format: Optional[str] = None)
@overload
def MfaDuo(resource_name: str,
           args: MfaDuoArgs,
           opts: Optional[ResourceOptions] = None)
    func NewMfaDuo(ctx *Context, name string, args MfaDuoArgs, opts ...ResourceOption) (*MfaDuo, error)
    public MfaDuo(string name, MfaDuoArgs args, CustomResourceOptions? opts = null)
    public MfaDuo(String name, MfaDuoArgs args)
public MfaDuo(String name, MfaDuoArgs args, CustomResourceOptions options)

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

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

    ApiHostname string

    (string: <required>) - API hostname for Duo.

    IntegrationKey string

    (string: <required>) - Integration key for Duo.

    MountAccessor 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.

    SecretKey string

    (string: <required>) - Secret key for Duo.

    Name string

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

    Namespace 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.

    PushInfo string

    (string) - Push information for Duo.

    UsernameFormat 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
    ApiHostname string

    (string: <required>) - API hostname for Duo.

    IntegrationKey string

    (string: <required>) - Integration key for Duo.

    MountAccessor 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.

    SecretKey string

    (string: <required>) - Secret key for Duo.

    Name string

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

    Namespace 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.

    PushInfo string

    (string) - Push information for Duo.

    UsernameFormat 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
    apiHostname String

    (string: <required>) - API hostname for Duo.

    integrationKey String

    (string: <required>) - Integration key for Duo.

    mountAccessor 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.

    secretKey String

    (string: <required>) - Secret key for Duo.

    name String

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

    namespace 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.

    pushInfo String

    (string) - Push information for Duo.

    usernameFormat 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
    apiHostname string

    (string: <required>) - API hostname for Duo.

    integrationKey string

    (string: <required>) - Integration key for Duo.

    mountAccessor 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.

    secretKey string

    (string: <required>) - Secret key for Duo.

    name string

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

    namespace 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.

    pushInfo string

    (string) - Push information for Duo.

    usernameFormat 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_hostname str

    (string: <required>) - API hostname for Duo.

    integration_key str

    (string: <required>) - Integration key for Duo.

    mount_accessor 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.

    secret_key str

    (string: <required>) - Secret key for Duo.

    name str

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

    namespace 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.

    push_info str

    (string) - Push information for Duo.

    username_format 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
    apiHostname String

    (string: <required>) - API hostname for Duo.

    integrationKey String

    (string: <required>) - Integration key for Duo.

    mountAccessor 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.

    secretKey String

    (string: <required>) - Secret key for Duo.

    name String

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

    namespace 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.

    pushInfo String

    (string) - Push information for Duo.

    usernameFormat 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 MfaDuo 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 MfaDuo Resource

    Get an existing MfaDuo 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?: MfaDuoState, opts?: CustomResourceOptions): MfaDuo
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_hostname: Optional[str] = None,
        integration_key: Optional[str] = None,
        mount_accessor: Optional[str] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        push_info: Optional[str] = None,
        secret_key: Optional[str] = None,
        username_format: Optional[str] = None) -> MfaDuo
    func GetMfaDuo(ctx *Context, name string, id IDInput, state *MfaDuoState, opts ...ResourceOption) (*MfaDuo, error)
    public static MfaDuo Get(string name, Input<string> id, MfaDuoState? state, CustomResourceOptions? opts = null)
    public static MfaDuo get(String name, Output<String> id, MfaDuoState 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:
    ApiHostname string

    (string: <required>) - API hostname for Duo.

    IntegrationKey string

    (string: <required>) - Integration key for Duo.

    MountAccessor 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 string

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

    Namespace 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.

    PushInfo string

    (string) - Push information for Duo.

    SecretKey string

    (string: <required>) - Secret key for Duo.

    UsernameFormat 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
    ApiHostname string

    (string: <required>) - API hostname for Duo.

    IntegrationKey string

    (string: <required>) - Integration key for Duo.

    MountAccessor 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 string

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

    Namespace 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.

    PushInfo string

    (string) - Push information for Duo.

    SecretKey string

    (string: <required>) - Secret key for Duo.

    UsernameFormat 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
    apiHostname String

    (string: <required>) - API hostname for Duo.

    integrationKey String

    (string: <required>) - Integration key for Duo.

    mountAccessor 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 String

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

    namespace 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.

    pushInfo String

    (string) - Push information for Duo.

    secretKey String

    (string: <required>) - Secret key for Duo.

    usernameFormat 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
    apiHostname string

    (string: <required>) - API hostname for Duo.

    integrationKey string

    (string: <required>) - Integration key for Duo.

    mountAccessor 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 string

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

    namespace 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.

    pushInfo string

    (string) - Push information for Duo.

    secretKey string

    (string: <required>) - Secret key for Duo.

    usernameFormat 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_hostname str

    (string: <required>) - API hostname for Duo.

    integration_key str

    (string: <required>) - Integration key for Duo.

    mount_accessor 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 str

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

    namespace 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.

    push_info str

    (string) - Push information for Duo.

    secret_key str

    (string: <required>) - Secret key for Duo.

    username_format 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
    apiHostname String

    (string: <required>) - API hostname for Duo.

    integrationKey String

    (string: <required>) - Integration key for Duo.

    mountAccessor 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 String

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

    namespace 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.

    pushInfo String

    (string) - Push information for Duo.

    secretKey String

    (string: <required>) - Secret key for Duo.

    usernameFormat 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/mfaDuo:MfaDuo my_duo my_duo

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the vault Terraform Provider.

    vault logo
    HashiCorp Vault v5.17.0 published on Thursday, Nov 9, 2023 by Pulumi
    pulumi/pulumi-vault