MfaPingid

class MfaPingid : KotlinCustomResource

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<any>("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)
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 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
})
}
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}

Import

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

$ pulumi import vault:index/mfaPingid:MfaPingid my_pingid my_pingid

Properties

Link copied to clipboard
val adminUrl: Output<String>

(string) – Admin URL computed by Vault

Link copied to clipboard

(string) – Authenticator URL computed by Vault

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val idpUrl: Output<String>

(string) – IDP URL computed by Vault

Link copied to clipboard
val mountAccessor: Output<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.

Link copied to clipboard
val name: Output<String>

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

Link copied to clipboard
val namespace: Output<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.

Link copied to clipboard
val namespaceId: Output<String>

(string) – Namespace ID computed by Vault

Link copied to clipboard
val orgAlias: Output<String>

(string) – Org Alias computed by Vault

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

(string: <required>) - A base64-encoded third-party settings file retrieved from PingID's configuration page.

Link copied to clipboard
val type: Output<String>

(string) – Type of configuration computed by Vault

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val usernameFormat: Output<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:

Link copied to clipboard
val useSignature: Output<Boolean>

(string) – If set to true, enables use of PingID signature. Computed by Vault