Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. MfaPingid
HashiCorp Vault v6.3.0 published on Thursday, Aug 8, 2024 by Pulumi
pulumi/pulumi-vault

vault.MfaPingid

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.3.0 published on Thursday, Aug 8, 2024 by Pulumi
pulumi/pulumi-vault

    Provides a resource to manage PingID 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 config = new pulumi.Config();
const settingsFile = config.requireObject("settingsFile");
const userpass = new vault.AuthBackend("userpass", {
    type: "userpass",
    path: "userpass",
});
const myPingid = new vault.MfaPingid("my_pingid", {
    name: "my_pingid",
    mountAccessor: userpass.accessor,
    usernameFormat: "user@example.com",
    settingsFileBase64: settingsFile,
});

    import pulumi
import pulumi_vault as vault

config = pulumi.Config()
settings_file = config.require_object("settingsFile")
userpass = vault.AuthBackend("userpass",
    type="userpass",
    path="userpass")
my_pingid = vault.MfaPingid("my_pingid",
    name="my_pingid",
    mount_accessor=userpass.accessor,
    username_format="user@example.com",
    settings_file_base64=settings_file)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		settingsFile := cfg.RequireObject("settingsFile")
		userpass, err := vault.NewAuthBackend(ctx, "userpass", &vault.AuthBackendArgs{
			Type: pulumi.String("userpass"),
			Path: pulumi.String("userpass"),
		})
		if err != nil {
			return err
		}
		_, err = vault.NewMfaPingid(ctx, "my_pingid", &vault.MfaPingidArgs{
			Name:               pulumi.String("my_pingid"),
			MountAccessor:      userpass.Accessor,
			UsernameFormat:     pulumi.String("user@example.com"),
			SettingsFileBase64: pulumi.Any(settingsFile),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var settingsFile = config.RequireObject<dynamic>("settingsFile");
    var userpass = new Vault.AuthBackend("userpass", new()
    {
        Type = "userpass",
        Path = "userpass",
    });

    var myPingid = new Vault.MfaPingid("my_pingid", new()
    {
        Name = "my_pingid",
        MountAccessor = userpass.Accessor,
        UsernameFormat = "user@example.com",
        SettingsFileBase64 = settingsFile,
    });

});

    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.MfaPingid;
import com.pulumi.vault.MfaPingidArgs;
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) {
        final var config = ctx.config();
        final var settingsFile = config.get("settingsFile");
        var userpass = new AuthBackend("userpass", AuthBackendArgs.builder()
            .type("userpass")
            .path("userpass")
            .build());

        var myPingid = new MfaPingid("myPingid", MfaPingidArgs.builder()
            .name("my_pingid")
            .mountAccessor(userpass.accessor())
            .usernameFormat("user@example.com")
            .settingsFileBase64(settingsFile)
            .build());

    }
}

    configuration:
  settingsFile:
    type: dynamic
resources:
  userpass:
    type: vault:AuthBackend
    properties:
      type: userpass
      path: userpass
  myPingid:
    type: vault:MfaPingid
    name: my_pingid
    properties:
      name: my_pingid
      mountAccessor: ${userpass.accessor}
      usernameFormat: user@example.com
      settingsFileBase64: ${settingsFile}

    Create MfaPingid Resource

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

    Constructor syntax

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

@overload
def MfaPingid(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              mount_accessor: Optional[str] = None,
              settings_file_base64: Optional[str] = None,
              name: Optional[str] = None,
              namespace: Optional[str] = None,
              username_format: Optional[str] = None)
    func NewMfaPingid(ctx *Context, name string, args MfaPingidArgs, opts ...ResourceOption) (*MfaPingid, error)
    public MfaPingid(string name, MfaPingidArgs args, CustomResourceOptions? opts = null)
    public MfaPingid(String name, MfaPingidArgs args)
public MfaPingid(String name, MfaPingidArgs args, CustomResourceOptions options)

    type: vault:MfaPingid
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MfaPingidArgs
    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 MfaPingidArgs
    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 MfaPingidArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MfaPingidArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MfaPingidArgs
    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 vaultMfaPingidResource = new Vault.MfaPingid("vaultMfaPingidResource", new()
{
    MountAccessor = "string",
    SettingsFileBase64 = "string",
    Name = "string",
    Namespace = "string",
    UsernameFormat = "string",
});

    example, err := vault.NewMfaPingid(ctx, "vaultMfaPingidResource", &vault.MfaPingidArgs{
	MountAccessor:      pulumi.String("string"),
	SettingsFileBase64: pulumi.String("string"),
	Name:               pulumi.String("string"),
	Namespace:          pulumi.String("string"),
	UsernameFormat:     pulumi.String("string"),
})

    var vaultMfaPingidResource = new MfaPingid("vaultMfaPingidResource", MfaPingidArgs.builder()
    .mountAccessor("string")
    .settingsFileBase64("string")
    .name("string")
    .namespace("string")
    .usernameFormat("string")
    .build());

    vault_mfa_pingid_resource = vault.MfaPingid("vaultMfaPingidResource",
    mount_accessor="string",
    settings_file_base64="string",
    name="string",
    namespace="string",
    username_format="string")

    const vaultMfaPingidResource = new vault.MfaPingid("vaultMfaPingidResource", {
    mountAccessor: "string",
    settingsFileBase64: "string",
    name: "string",
    namespace: "string",
    usernameFormat: "string",
});

    type: vault:MfaPingid
properties:
    mountAccessor: string
    name: string
    namespace: string
    settingsFileBase64: string
    usernameFormat: string

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

    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.
    SettingsFileBase64 string
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    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.
    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
    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.
    SettingsFileBase64 string
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    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.
    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
    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.
    settingsFileBase64 String
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    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.
    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
    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.
    settingsFileBase64 string
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    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.
    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
    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.
    settings_file_base64 str
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    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.
    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
    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.
    settingsFileBase64 String
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    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.
    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 MfaPingid resource produces the following output properties:

    AdminUrl string
    (string) – Admin URL computed by Vault
    AuthenticatorUrl string
    (string) – Authenticator URL computed by Vault
    Id string
    The provider-assigned unique ID for this managed resource.
    IdpUrl string
    (string) – IDP URL computed by Vault
    NamespaceId string
    (string) – Namespace ID computed by Vault
    OrgAlias string
    (string) – Org Alias computed by Vault
    Type string
    (string) – Type of configuration computed by Vault
    UseSignature bool
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    AdminUrl string
    (string) – Admin URL computed by Vault
    AuthenticatorUrl string
    (string) – Authenticator URL computed by Vault
    Id string
    The provider-assigned unique ID for this managed resource.
    IdpUrl string
    (string) – IDP URL computed by Vault
    NamespaceId string
    (string) – Namespace ID computed by Vault
    OrgAlias string
    (string) – Org Alias computed by Vault
    Type string
    (string) – Type of configuration computed by Vault
    UseSignature bool
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    adminUrl String
    (string) – Admin URL computed by Vault
    authenticatorUrl String
    (string) – Authenticator URL computed by Vault
    id String
    The provider-assigned unique ID for this managed resource.
    idpUrl String
    (string) – IDP URL computed by Vault
    namespaceId String
    (string) – Namespace ID computed by Vault
    orgAlias String
    (string) – Org Alias computed by Vault
    type String
    (string) – Type of configuration computed by Vault
    useSignature Boolean
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    adminUrl string
    (string) – Admin URL computed by Vault
    authenticatorUrl string
    (string) – Authenticator URL computed by Vault
    id string
    The provider-assigned unique ID for this managed resource.
    idpUrl string
    (string) – IDP URL computed by Vault
    namespaceId string
    (string) – Namespace ID computed by Vault
    orgAlias string
    (string) – Org Alias computed by Vault
    type string
    (string) – Type of configuration computed by Vault
    useSignature boolean
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    admin_url str
    (string) – Admin URL computed by Vault
    authenticator_url str
    (string) – Authenticator URL computed by Vault
    id str
    The provider-assigned unique ID for this managed resource.
    idp_url str
    (string) – IDP URL computed by Vault
    namespace_id str
    (string) – Namespace ID computed by Vault
    org_alias str
    (string) – Org Alias computed by Vault
    type str
    (string) – Type of configuration computed by Vault
    use_signature bool
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    adminUrl String
    (string) – Admin URL computed by Vault
    authenticatorUrl String
    (string) – Authenticator URL computed by Vault
    id String
    The provider-assigned unique ID for this managed resource.
    idpUrl String
    (string) – IDP URL computed by Vault
    namespaceId String
    (string) – Namespace ID computed by Vault
    orgAlias String
    (string) – Org Alias computed by Vault
    type String
    (string) – Type of configuration computed by Vault
    useSignature Boolean
    (string) – If set to true, enables use of PingID signature. Computed by Vault

    Look up Existing MfaPingid Resource

    Get an existing MfaPingid 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?: MfaPingidState, opts?: CustomResourceOptions): MfaPingid
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_url: Optional[str] = None,
        authenticator_url: Optional[str] = None,
        idp_url: Optional[str] = None,
        mount_accessor: Optional[str] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        namespace_id: Optional[str] = None,
        org_alias: Optional[str] = None,
        settings_file_base64: Optional[str] = None,
        type: Optional[str] = None,
        use_signature: Optional[bool] = None,
        username_format: Optional[str] = None) -> MfaPingid
    func GetMfaPingid(ctx *Context, name string, id IDInput, state *MfaPingidState, opts ...ResourceOption) (*MfaPingid, error)
    public static MfaPingid Get(string name, Input<string> id, MfaPingidState? state, CustomResourceOptions? opts = null)
    public static MfaPingid get(String name, Output<String> id, MfaPingidState 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:
    AdminUrl string
    (string) – Admin URL computed by Vault
    AuthenticatorUrl string
    (string) – Authenticator URL computed by Vault
    IdpUrl string
    (string) – IDP URL computed by Vault
    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.
    NamespaceId string
    (string) – Namespace ID computed by Vault
    OrgAlias string
    (string) – Org Alias computed by Vault
    SettingsFileBase64 string
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    Type string
    (string) – Type of configuration computed by Vault
    UseSignature bool
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    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
    AdminUrl string
    (string) – Admin URL computed by Vault
    AuthenticatorUrl string
    (string) – Authenticator URL computed by Vault
    IdpUrl string
    (string) – IDP URL computed by Vault
    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.
    NamespaceId string
    (string) – Namespace ID computed by Vault
    OrgAlias string
    (string) – Org Alias computed by Vault
    SettingsFileBase64 string
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    Type string
    (string) – Type of configuration computed by Vault
    UseSignature bool
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    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
    adminUrl String
    (string) – Admin URL computed by Vault
    authenticatorUrl String
    (string) – Authenticator URL computed by Vault
    idpUrl String
    (string) – IDP URL computed by Vault
    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.
    namespaceId String
    (string) – Namespace ID computed by Vault
    orgAlias String
    (string) – Org Alias computed by Vault
    settingsFileBase64 String
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    type String
    (string) – Type of configuration computed by Vault
    useSignature Boolean
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    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
    adminUrl string
    (string) – Admin URL computed by Vault
    authenticatorUrl string
    (string) – Authenticator URL computed by Vault
    idpUrl string
    (string) – IDP URL computed by Vault
    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.
    namespaceId string
    (string) – Namespace ID computed by Vault
    orgAlias string
    (string) – Org Alias computed by Vault
    settingsFileBase64 string
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    type string
    (string) – Type of configuration computed by Vault
    useSignature boolean
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    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
    admin_url str
    (string) – Admin URL computed by Vault
    authenticator_url str
    (string) – Authenticator URL computed by Vault
    idp_url str
    (string) – IDP URL computed by Vault
    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.
    namespace_id str
    (string) – Namespace ID computed by Vault
    org_alias str
    (string) – Org Alias computed by Vault
    settings_file_base64 str
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    type str
    (string) – Type of configuration computed by Vault
    use_signature bool
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    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
    adminUrl String
    (string) – Admin URL computed by Vault
    authenticatorUrl String
    (string) – Authenticator URL computed by Vault
    idpUrl String
    (string) – IDP URL computed by Vault
    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.
    namespaceId String
    (string) – Namespace ID computed by Vault
    orgAlias String
    (string) – Org Alias computed by Vault
    settingsFileBase64 String
    (string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.
    type String
    (string) – Type of configuration computed by Vault
    useSignature Boolean
    (string) – If set to true, enables use of PingID signature. Computed by Vault
    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/mfaPingid:MfaPingid my_pingid my_pingid

    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.
    vault logo
    HashiCorp Vault v6.3.0 published on Thursday, Aug 8, 2024 by Pulumi
    pulumi/pulumi-vault