Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. FlowVaultConnection
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.FlowVaultConnection

Explore with Pulumi AI

auth0 logo
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

    With this resource, you can create and manage flow vault connections for a tenant.

    Example Usage

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

// Example:
const myConnection = new auth0.FlowVaultConnection("my_connection", {
    appId: "AUTH0",
    name: "Auth0 M2M Connection",
    setup: {
        client_id: "******************",
        client_secret: "*********************************",
        domain: "*****************************",
        type: "OAUTH_APP",
    },
});

    import pulumi
import pulumi_auth0 as auth0

# Example:
my_connection = auth0.FlowVaultConnection("my_connection",
    app_id="AUTH0",
    name="Auth0 M2M Connection",
    setup={
        "client_id": "******************",
        "client_secret": "*********************************",
        "domain": "*****************************",
        "type": "OAUTH_APP",
    })

    package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Example:
		_, err := auth0.NewFlowVaultConnection(ctx, "my_connection", &auth0.FlowVaultConnectionArgs{
			AppId: pulumi.String("AUTH0"),
			Name:  pulumi.String("Auth0 M2M Connection"),
			Setup: pulumi.StringMap{
				"client_id":     pulumi.String("******************"),
				"client_secret": pulumi.String("*********************************"),
				"domain":        pulumi.String("*****************************"),
				"type":          pulumi.String("OAUTH_APP"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Example:
    var myConnection = new Auth0.FlowVaultConnection("my_connection", new()
    {
        AppId = "AUTH0",
        Name = "Auth0 M2M Connection",
        Setup = 
        {
            { "client_id", "******************" },
            { "client_secret", "*********************************" },
            { "domain", "*****************************" },
            { "type", "OAUTH_APP" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.FlowVaultConnection;
import com.pulumi.auth0.FlowVaultConnectionArgs;
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) {
        // Example:
        var myConnection = new FlowVaultConnection("myConnection", FlowVaultConnectionArgs.builder()
            .appId("AUTH0")
            .name("Auth0 M2M Connection")
            .setup(Map.ofEntries(
                Map.entry("client_id", "******************"),
                Map.entry("client_secret", "*********************************"),
                Map.entry("domain", "*****************************"),
                Map.entry("type", "OAUTH_APP")
            ))
            .build());

    }
}

    resources:
  # Example:
  myConnection:
    type: auth0:FlowVaultConnection
    name: my_connection
    properties:
      appId: AUTH0
      name: Auth0 M2M Connection
      setup:
        client_id: '******************'
        client_secret: '*********************************'
        domain: '*****************************'
        type: OAUTH_APP

    Create FlowVaultConnection Resource

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

    Constructor syntax

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

@overload
def FlowVaultConnection(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        app_id: Optional[str] = None,
                        account_name: Optional[str] = None,
                        environment: Optional[str] = None,
                        fingerprint: Optional[str] = None,
                        name: Optional[str] = None,
                        ready: Optional[bool] = None,
                        setup: Optional[Mapping[str, str]] = None)
    func NewFlowVaultConnection(ctx *Context, name string, args FlowVaultConnectionArgs, opts ...ResourceOption) (*FlowVaultConnection, error)
    public FlowVaultConnection(string name, FlowVaultConnectionArgs args, CustomResourceOptions? opts = null)
    public FlowVaultConnection(String name, FlowVaultConnectionArgs args)
public FlowVaultConnection(String name, FlowVaultConnectionArgs args, CustomResourceOptions options)

    type: auth0:FlowVaultConnection
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 FlowVaultConnectionArgs
    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 FlowVaultConnectionArgs
    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 FlowVaultConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FlowVaultConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FlowVaultConnectionArgs
    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 flowVaultConnectionResource = new Auth0.FlowVaultConnection("flowVaultConnectionResource", new()
{
    AppId = "string",
    AccountName = "string",
    Environment = "string",
    Fingerprint = "string",
    Name = "string",
    Ready = false,
    Setup = 
    {
        { "string", "string" },
    },
});

    example, err := auth0.NewFlowVaultConnection(ctx, "flowVaultConnectionResource", &auth0.FlowVaultConnectionArgs{
	AppId:       pulumi.String("string"),
	AccountName: pulumi.String("string"),
	Environment: pulumi.String("string"),
	Fingerprint: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Ready:       pulumi.Bool(false),
	Setup: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var flowVaultConnectionResource = new FlowVaultConnection("flowVaultConnectionResource", FlowVaultConnectionArgs.builder()
    .appId("string")
    .accountName("string")
    .environment("string")
    .fingerprint("string")
    .name("string")
    .ready(false)
    .setup(Map.of("string", "string"))
    .build());

    flow_vault_connection_resource = auth0.FlowVaultConnection("flowVaultConnectionResource",
    app_id="string",
    account_name="string",
    environment="string",
    fingerprint="string",
    name="string",
    ready=False,
    setup={
        "string": "string",
    })

    const flowVaultConnectionResource = new auth0.FlowVaultConnection("flowVaultConnectionResource", {
    appId: "string",
    accountName: "string",
    environment: "string",
    fingerprint: "string",
    name: "string",
    ready: false,
    setup: {
        string: "string",
    },
});

    type: auth0:FlowVaultConnection
properties:
    accountName: string
    appId: string
    environment: string
    fingerprint: string
    name: string
    ready: false
    setup:
        string: string

    FlowVaultConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FlowVaultConnection resource accepts the following input properties:

    AppId string
    App identifier of the vault connection.
    AccountName string
    Custom account name of the vault connection.
    Environment string
    Environment of the vault connection.
    Fingerprint string
    Fingerprint of the vault connection.
    Name string
    Name of the vault connection.
    Ready bool
    Indicates if the vault connection is configured.
    Setup Dictionary<string, string>
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    AppId string
    App identifier of the vault connection.
    AccountName string
    Custom account name of the vault connection.
    Environment string
    Environment of the vault connection.
    Fingerprint string
    Fingerprint of the vault connection.
    Name string
    Name of the vault connection.
    Ready bool
    Indicates if the vault connection is configured.
    Setup map[string]string
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    appId String
    App identifier of the vault connection.
    accountName String
    Custom account name of the vault connection.
    environment String
    Environment of the vault connection.
    fingerprint String
    Fingerprint of the vault connection.
    name String
    Name of the vault connection.
    ready Boolean
    Indicates if the vault connection is configured.
    setup Map<String,String>
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    appId string
    App identifier of the vault connection.
    accountName string
    Custom account name of the vault connection.
    environment string
    Environment of the vault connection.
    fingerprint string
    Fingerprint of the vault connection.
    name string
    Name of the vault connection.
    ready boolean
    Indicates if the vault connection is configured.
    setup {[key: string]: string}
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    app_id str
    App identifier of the vault connection.
    account_name str
    Custom account name of the vault connection.
    environment str
    Environment of the vault connection.
    fingerprint str
    Fingerprint of the vault connection.
    name str
    Name of the vault connection.
    ready bool
    Indicates if the vault connection is configured.
    setup Mapping[str, str]
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    appId String
    App identifier of the vault connection.
    accountName String
    Custom account name of the vault connection.
    environment String
    Environment of the vault connection.
    fingerprint String
    Fingerprint of the vault connection.
    name String
    Name of the vault connection.
    ready Boolean
    Indicates if the vault connection is configured.
    setup Map<String>
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FlowVaultConnection 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 FlowVaultConnection Resource

    Get an existing FlowVaultConnection 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?: FlowVaultConnectionState, opts?: CustomResourceOptions): FlowVaultConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        app_id: Optional[str] = None,
        environment: Optional[str] = None,
        fingerprint: Optional[str] = None,
        name: Optional[str] = None,
        ready: Optional[bool] = None,
        setup: Optional[Mapping[str, str]] = None) -> FlowVaultConnection
    func GetFlowVaultConnection(ctx *Context, name string, id IDInput, state *FlowVaultConnectionState, opts ...ResourceOption) (*FlowVaultConnection, error)
    public static FlowVaultConnection Get(string name, Input<string> id, FlowVaultConnectionState? state, CustomResourceOptions? opts = null)
    public static FlowVaultConnection get(String name, Output<String> id, FlowVaultConnectionState 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:
    AccountName string
    Custom account name of the vault connection.
    AppId string
    App identifier of the vault connection.
    Environment string
    Environment of the vault connection.
    Fingerprint string
    Fingerprint of the vault connection.
    Name string
    Name of the vault connection.
    Ready bool
    Indicates if the vault connection is configured.
    Setup Dictionary<string, string>
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    AccountName string
    Custom account name of the vault connection.
    AppId string
    App identifier of the vault connection.
    Environment string
    Environment of the vault connection.
    Fingerprint string
    Fingerprint of the vault connection.
    Name string
    Name of the vault connection.
    Ready bool
    Indicates if the vault connection is configured.
    Setup map[string]string
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    accountName String
    Custom account name of the vault connection.
    appId String
    App identifier of the vault connection.
    environment String
    Environment of the vault connection.
    fingerprint String
    Fingerprint of the vault connection.
    name String
    Name of the vault connection.
    ready Boolean
    Indicates if the vault connection is configured.
    setup Map<String,String>
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    accountName string
    Custom account name of the vault connection.
    appId string
    App identifier of the vault connection.
    environment string
    Environment of the vault connection.
    fingerprint string
    Fingerprint of the vault connection.
    name string
    Name of the vault connection.
    ready boolean
    Indicates if the vault connection is configured.
    setup {[key: string]: string}
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    account_name str
    Custom account name of the vault connection.
    app_id str
    App identifier of the vault connection.
    environment str
    Environment of the vault connection.
    fingerprint str
    Fingerprint of the vault connection.
    name str
    Name of the vault connection.
    ready bool
    Indicates if the vault connection is configured.
    setup Mapping[str, str]
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)
    accountName String
    Custom account name of the vault connection.
    appId String
    App identifier of the vault connection.
    environment String
    Environment of the vault connection.
    fingerprint String
    Fingerprint of the vault connection.
    name String
    Name of the vault connection.
    ready Boolean
    Indicates if the vault connection is configured.
    setup Map<String>
    Configuration of the vault connection. (Mapping information must be provided as key/value pairs)

    Import

    This resource can be imported using the flow vault connection ID.

    Example:

    $ pulumi import auth0:index/flowVaultConnection:FlowVaultConnection my_connection "ac_42HT5oiobDyUs8ASwEEWK0"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-auth0