1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. getAuthBackend
HashiCorp Vault v5.15.1 published on Tuesday, Sep 26, 2023 by Pulumi

vault.getAuthBackend

Explore with Pulumi AI

vault logo
HashiCorp Vault v5.15.1 published on Tuesday, Sep 26, 2023 by Pulumi

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Vault = Pulumi.Vault;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Vault.GetAuthBackend.Invoke(new()
        {
            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
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vault.VaultFunctions;
    import com.pulumi.vault.inputs.GetAuthBackendArgs;
    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 example = VaultFunctions.getAuthBackend(GetAuthBackendArgs.builder()
                .path("userpass")
                .build());
    
        }
    }
    
    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",
    }));
    
    variables:
      example:
        Fn::Invoke:
          Function: vault:getAuthBackend
          Arguments:
            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(namespace: Optional[str] = None,
                         path: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAuthBackendResult
    def get_auth_backend_output(namespace: Optional[pulumi.Input[str]] = None,
                         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)
    }
    public static CompletableFuture<GetAuthBackendResult> getAuthBackend(GetAuthBackendArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: vault:index/getAuthBackend:getAuthBackend
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Path string

    The auth backend mount point.

    Namespace string

    The namespace of the target resource. 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.

    Path string

    The auth backend mount point.

    Namespace string

    The namespace of the target resource. 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.

    path String

    The auth backend mount point.

    namespace String

    The namespace of the target resource. 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.

    path string

    The auth backend mount point.

    namespace string

    The namespace of the target resource. 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.

    path str

    The auth backend mount point.

    namespace str

    The namespace of the target resource. 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.

    path String

    The auth backend mount point.

    namespace String

    The namespace of the target resource. 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.

    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.

    Namespace string
    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.

    Namespace string
    accessor String

    The accessor for this auth method.

    defaultLeaseTtlSeconds Integer

    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 Integer

    The maximum lease duration in seconds.

    path String
    type String

    The name of the auth method type.

    namespace String
    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.

    namespace string
    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.

    namespace str
    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.

    namespace String

    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 v5.15.1 published on Tuesday, Sep 26, 2023 by Pulumi