Docs Packages
  1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. identity
  5. MfaPingid
HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-vault

vault.identity.MfaPingid

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-vault

    Resource for configuring the pingid MFA method.

    Example Usage

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

const example = new vault.identity.MfaPingid("example", {settingsFileBase64: "CnVzZV9iYXNlNjR[...]HBtCg=="});

    import pulumi
import pulumi_vault as vault

example = vault.identity.MfaPingid("example", settings_file_base64="CnVzZV9iYXNlNjR[...]HBtCg==")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identity.NewMfaPingid(ctx, "example", &identity.MfaPingidArgs{
			SettingsFileBase64: pulumi.String("CnVzZV9iYXNlNjR[...]HBtCg=="),
		})
		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 example = new Vault.Identity.MfaPingid("example", new()
    {
        SettingsFileBase64 = "CnVzZV9iYXNlNjR[...]HBtCg==",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.identity.MfaPingid;
import com.pulumi.vault.identity.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) {
        var example = new MfaPingid("example", MfaPingidArgs.builder()
            .settingsFileBase64("CnVzZV9iYXNlNjR[...]HBtCg==")
            .build());

    }
}

    resources:
  example:
    type: vault:identity:MfaPingid
    properties:
      settingsFileBase64: CnVzZV9iYXNlNjR[...]HBtCg==

    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,
              settings_file_base64: 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:identity: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 mfaPingidResource = new Vault.Identity.MfaPingid("mfaPingidResource", new()
{
    SettingsFileBase64 = "string",
    Namespace = "string",
    UsernameFormat = "string",
});

    example, err := identity.NewMfaPingid(ctx, "mfaPingidResource", &identity.MfaPingidArgs{
	SettingsFileBase64: pulumi.String("string"),
	Namespace:          pulumi.String("string"),
	UsernameFormat:     pulumi.String("string"),
})

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

    mfa_pingid_resource = vault.identity.MfaPingid("mfaPingidResource",
    settings_file_base64="string",
    namespace="string",
    username_format="string")

    const mfaPingidResource = new vault.identity.MfaPingid("mfaPingidResource", {
    settingsFileBase64: "string",
    namespace: "string",
    usernameFormat: "string",
});

    type: vault:identity:MfaPingid
properties:
    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:

    SettingsFileBase64 string
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    Namespace string
    Target namespace. (requires Enterprise)
    UsernameFormat string
    A template string for mapping Identity names to MFA methods.
    SettingsFileBase64 string
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    Namespace string
    Target namespace. (requires Enterprise)
    UsernameFormat string
    A template string for mapping Identity names to MFA methods.
    settingsFileBase64 String
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    namespace String
    Target namespace. (requires Enterprise)
    usernameFormat String
    A template string for mapping Identity names to MFA methods.
    settingsFileBase64 string
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    namespace string
    Target namespace. (requires Enterprise)
    usernameFormat string
    A template string for mapping Identity names to MFA methods.
    settings_file_base64 str
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    namespace str
    Target namespace. (requires Enterprise)
    username_format str
    A template string for mapping Identity names to MFA methods.
    settingsFileBase64 String
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    namespace String
    Target namespace. (requires Enterprise)
    usernameFormat String
    A template string for mapping Identity names to MFA methods.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MfaPingid resource produces the following output properties:

    AdminUrl string
    The admin URL, derived from "settings_file_base64"
    AuthenticatorUrl string
    A unique identifier of the organization, derived from "settings_file_base64"
    Id string
    The provider-assigned unique ID for this managed resource.
    IdpUrl string
    The IDP URL, derived from "settings_file_base64"
    MethodId string
    Method ID.
    MountAccessor string
    Mount accessor.
    Name string
    Method name.
    NamespaceId string
    Method's namespace ID.
    NamespacePath string
    Method's namespace path.
    OrgAlias string
    The name of the PingID client organization, derived from "settings_file_base64"
    Type string
    MFA type.
    UseSignature bool
    Use signature value, derived from "settings_file_base64"
    Uuid string
    Resource UUID.
    AdminUrl string
    The admin URL, derived from "settings_file_base64"
    AuthenticatorUrl string
    A unique identifier of the organization, derived from "settings_file_base64"
    Id string
    The provider-assigned unique ID for this managed resource.
    IdpUrl string
    The IDP URL, derived from "settings_file_base64"
    MethodId string
    Method ID.
    MountAccessor string
    Mount accessor.
    Name string
    Method name.
    NamespaceId string
    Method's namespace ID.
    NamespacePath string
    Method's namespace path.
    OrgAlias string
    The name of the PingID client organization, derived from "settings_file_base64"
    Type string
    MFA type.
    UseSignature bool
    Use signature value, derived from "settings_file_base64"
    Uuid string
    Resource UUID.
    adminUrl String
    The admin URL, derived from "settings_file_base64"
    authenticatorUrl String
    A unique identifier of the organization, derived from "settings_file_base64"
    id String
    The provider-assigned unique ID for this managed resource.
    idpUrl String
    The IDP URL, derived from "settings_file_base64"
    methodId String
    Method ID.
    mountAccessor String
    Mount accessor.
    name String
    Method name.
    namespaceId String
    Method's namespace ID.
    namespacePath String
    Method's namespace path.
    orgAlias String
    The name of the PingID client organization, derived from "settings_file_base64"
    type String
    MFA type.
    useSignature Boolean
    Use signature value, derived from "settings_file_base64"
    uuid String
    Resource UUID.
    adminUrl string
    The admin URL, derived from "settings_file_base64"
    authenticatorUrl string
    A unique identifier of the organization, derived from "settings_file_base64"
    id string
    The provider-assigned unique ID for this managed resource.
    idpUrl string
    The IDP URL, derived from "settings_file_base64"
    methodId string
    Method ID.
    mountAccessor string
    Mount accessor.
    name string
    Method name.
    namespaceId string
    Method's namespace ID.
    namespacePath string
    Method's namespace path.
    orgAlias string
    The name of the PingID client organization, derived from "settings_file_base64"
    type string
    MFA type.
    useSignature boolean
    Use signature value, derived from "settings_file_base64"
    uuid string
    Resource UUID.
    admin_url str
    The admin URL, derived from "settings_file_base64"
    authenticator_url str
    A unique identifier of the organization, derived from "settings_file_base64"
    id str
    The provider-assigned unique ID for this managed resource.
    idp_url str
    The IDP URL, derived from "settings_file_base64"
    method_id str
    Method ID.
    mount_accessor str
    Mount accessor.
    name str
    Method name.
    namespace_id str
    Method's namespace ID.
    namespace_path str
    Method's namespace path.
    org_alias str
    The name of the PingID client organization, derived from "settings_file_base64"
    type str
    MFA type.
    use_signature bool
    Use signature value, derived from "settings_file_base64"
    uuid str
    Resource UUID.
    adminUrl String
    The admin URL, derived from "settings_file_base64"
    authenticatorUrl String
    A unique identifier of the organization, derived from "settings_file_base64"
    id String
    The provider-assigned unique ID for this managed resource.
    idpUrl String
    The IDP URL, derived from "settings_file_base64"
    methodId String
    Method ID.
    mountAccessor String
    Mount accessor.
    name String
    Method name.
    namespaceId String
    Method's namespace ID.
    namespacePath String
    Method's namespace path.
    orgAlias String
    The name of the PingID client organization, derived from "settings_file_base64"
    type String
    MFA type.
    useSignature Boolean
    Use signature value, derived from "settings_file_base64"
    uuid String
    Resource UUID.

    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,
        method_id: Optional[str] = None,
        mount_accessor: Optional[str] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        namespace_id: Optional[str] = None,
        namespace_path: 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,
        uuid: 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
    The admin URL, derived from "settings_file_base64"
    AuthenticatorUrl string
    A unique identifier of the organization, derived from "settings_file_base64"
    IdpUrl string
    The IDP URL, derived from "settings_file_base64"
    MethodId string
    Method ID.
    MountAccessor string
    Mount accessor.
    Name string
    Method name.
    Namespace string
    Target namespace. (requires Enterprise)
    NamespaceId string
    Method's namespace ID.
    NamespacePath string
    Method's namespace path.
    OrgAlias string
    The name of the PingID client organization, derived from "settings_file_base64"
    SettingsFileBase64 string
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    Type string
    MFA type.
    UseSignature bool
    Use signature value, derived from "settings_file_base64"
    UsernameFormat string
    A template string for mapping Identity names to MFA methods.
    Uuid string
    Resource UUID.
    AdminUrl string
    The admin URL, derived from "settings_file_base64"
    AuthenticatorUrl string
    A unique identifier of the organization, derived from "settings_file_base64"
    IdpUrl string
    The IDP URL, derived from "settings_file_base64"
    MethodId string
    Method ID.
    MountAccessor string
    Mount accessor.
    Name string
    Method name.
    Namespace string
    Target namespace. (requires Enterprise)
    NamespaceId string
    Method's namespace ID.
    NamespacePath string
    Method's namespace path.
    OrgAlias string
    The name of the PingID client organization, derived from "settings_file_base64"
    SettingsFileBase64 string
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    Type string
    MFA type.
    UseSignature bool
    Use signature value, derived from "settings_file_base64"
    UsernameFormat string
    A template string for mapping Identity names to MFA methods.
    Uuid string
    Resource UUID.
    adminUrl String
    The admin URL, derived from "settings_file_base64"
    authenticatorUrl String
    A unique identifier of the organization, derived from "settings_file_base64"
    idpUrl String
    The IDP URL, derived from "settings_file_base64"
    methodId String
    Method ID.
    mountAccessor String
    Mount accessor.
    name String
    Method name.
    namespace String
    Target namespace. (requires Enterprise)
    namespaceId String
    Method's namespace ID.
    namespacePath String
    Method's namespace path.
    orgAlias String
    The name of the PingID client organization, derived from "settings_file_base64"
    settingsFileBase64 String
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    type String
    MFA type.
    useSignature Boolean
    Use signature value, derived from "settings_file_base64"
    usernameFormat String
    A template string for mapping Identity names to MFA methods.
    uuid String
    Resource UUID.
    adminUrl string
    The admin URL, derived from "settings_file_base64"
    authenticatorUrl string
    A unique identifier of the organization, derived from "settings_file_base64"
    idpUrl string
    The IDP URL, derived from "settings_file_base64"
    methodId string
    Method ID.
    mountAccessor string
    Mount accessor.
    name string
    Method name.
    namespace string
    Target namespace. (requires Enterprise)
    namespaceId string
    Method's namespace ID.
    namespacePath string
    Method's namespace path.
    orgAlias string
    The name of the PingID client organization, derived from "settings_file_base64"
    settingsFileBase64 string
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    type string
    MFA type.
    useSignature boolean
    Use signature value, derived from "settings_file_base64"
    usernameFormat string
    A template string for mapping Identity names to MFA methods.
    uuid string
    Resource UUID.
    admin_url str
    The admin URL, derived from "settings_file_base64"
    authenticator_url str
    A unique identifier of the organization, derived from "settings_file_base64"
    idp_url str
    The IDP URL, derived from "settings_file_base64"
    method_id str
    Method ID.
    mount_accessor str
    Mount accessor.
    name str
    Method name.
    namespace str
    Target namespace. (requires Enterprise)
    namespace_id str
    Method's namespace ID.
    namespace_path str
    Method's namespace path.
    org_alias str
    The name of the PingID client organization, derived from "settings_file_base64"
    settings_file_base64 str
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    type str
    MFA type.
    use_signature bool
    Use signature value, derived from "settings_file_base64"
    username_format str
    A template string for mapping Identity names to MFA methods.
    uuid str
    Resource UUID.
    adminUrl String
    The admin URL, derived from "settings_file_base64"
    authenticatorUrl String
    A unique identifier of the organization, derived from "settings_file_base64"
    idpUrl String
    The IDP URL, derived from "settings_file_base64"
    methodId String
    Method ID.
    mountAccessor String
    Mount accessor.
    name String
    Method name.
    namespace String
    Target namespace. (requires Enterprise)
    namespaceId String
    Method's namespace ID.
    namespacePath String
    Method's namespace path.
    orgAlias String
    The name of the PingID client organization, derived from "settings_file_base64"
    settingsFileBase64 String
    A base64-encoded third-party settings contents as retrieved from PingID's configuration page.
    type String
    MFA type.
    useSignature Boolean
    Use signature value, derived from "settings_file_base64"
    usernameFormat String
    A template string for mapping Identity names to MFA methods.
    uuid String
    Resource UUID.

    Import

    Resource can be imported using its uuid field, e.g.

    $ pulumi import vault:identity/mfaPingid:MfaPingid example 0d89c36a-4ff5-4d70-8749-bb6a5598aeec

    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.2.0 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-vault