HashiCorp Vault

v5.1.0 published on Thursday, Dec 30, 2021 by Pulumi

getAuthBackend

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Vault.GetAuthBackend.InvokeAsync(new Vault.GetAuthBackendArgs
        {
            Path = "userpass",
        }));
    }

}
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 {
		_, err := vault.LookupAuthBackend(ctx, &GetAuthBackendArgs{
			Path: "userpass",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_vault as vault

example = vault.get_auth_backend(path="userpass")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const example = pulumi.output(vault.getAuthBackend({
    path: "userpass",
}));

Using getAuthBackend

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAuthBackend(args: GetAuthBackendArgs, opts?: InvokeOptions): Promise<GetAuthBackendResult>
function getAuthBackendOutput(args: GetAuthBackendOutputArgs, opts?: InvokeOptions): Output<GetAuthBackendResult>
def get_auth_backend(path: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAuthBackendResult
def get_auth_backend_output(path: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAuthBackendResult]
func LookupAuthBackend(ctx *Context, args *LookupAuthBackendArgs, opts ...InvokeOption) (*LookupAuthBackendResult, error)
func LookupAuthBackendOutput(ctx *Context, args *LookupAuthBackendOutputArgs, opts ...InvokeOption) LookupAuthBackendResultOutput

> Note: This function is named LookupAuthBackend in the Go SDK.

public static class GetAuthBackend 
{
    public static Task<GetAuthBackendResult> InvokeAsync(GetAuthBackendArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthBackendResult> Invoke(GetAuthBackendInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Path string
The auth backend mount point.
Path string
The auth backend mount point.
path string
The auth backend mount point.
path str
The auth backend mount point.

getAuthBackend Result

The following output properties are available:

Accessor string
The accessor for this auth method
DefaultLeaseTtlSeconds int
The default lease duration in seconds.
Description string
A description of the auth method.
Id string
The provider-assigned unique ID for this managed resource.
ListingVisibility string
Specifies whether to show this mount in the UI-specific listing endpoint.
Local bool
Specifies if the auth method is local only.
MaxLeaseTtlSeconds int
The maximum lease duration in seconds.
Path string
Type string
The name of the auth method type.
Accessor string
The accessor for this auth method
DefaultLeaseTtlSeconds int
The default lease duration in seconds.
Description string
A description of the auth method.
Id string
The provider-assigned unique ID for this managed resource.
ListingVisibility string
Specifies whether to show this mount in the UI-specific listing endpoint.
Local bool
Specifies if the auth method is local only.
MaxLeaseTtlSeconds int
The maximum lease duration in seconds.
Path string
Type string
The name of the auth method type.
accessor string
The accessor for this auth method
defaultLeaseTtlSeconds number
The default lease duration in seconds.
description string
A description of the auth method.
id string
The provider-assigned unique ID for this managed resource.
listingVisibility string
Specifies whether to show this mount in the UI-specific listing endpoint.
local boolean
Specifies if the auth method is local only.
maxLeaseTtlSeconds number
The maximum lease duration in seconds.
path string
type string
The name of the auth method type.
accessor str
The accessor for this auth method
default_lease_ttl_seconds int
The default lease duration in seconds.
description str
A description of the auth method.
id str
The provider-assigned unique ID for this managed resource.
listing_visibility str
Specifies whether to show this mount in the UI-specific listing endpoint.
local bool
Specifies if the auth method is local only.
max_lease_ttl_seconds int
The maximum lease duration in seconds.
path str
type str
The name of the auth method type.

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.