1. Packages
  2. Bitwarden Provider
  3. API Docs
  4. getFolder
bitwarden 0.13.6 published on Thursday, Apr 17, 2025 by maxlaverse

bitwarden.getFolder

Explore with Pulumi AI

bitwarden logo
bitwarden 0.13.6 published on Thursday, Apr 17, 2025 by maxlaverse

    Use this data source to get information on an existing folder.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as bitwarden from "@pulumi/bitwarden";
    
    const terraform = bitwarden.getFolder({
        search: "Terraform",
    });
    // Example of usage of the data source:
    const administrativeUser = new bitwarden.ItemLogin("administrativeUser", {
        username: "admin",
        folderId: terraform.then(terraform => terraform.id),
    });
    
    import pulumi
    import pulumi_bitwarden as bitwarden
    
    terraform = bitwarden.get_folder(search="Terraform")
    # Example of usage of the data source:
    administrative_user = bitwarden.ItemLogin("administrativeUser",
        username="admin",
        folder_id=terraform.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/bitwarden/bitwarden"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		terraform, err := bitwarden.LookupFolder(ctx, &bitwarden.LookupFolderArgs{
    			Search: pulumi.StringRef("Terraform"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		// Example of usage of the data source:
    		_, err = bitwarden.NewItemLogin(ctx, "administrativeUser", &bitwarden.ItemLoginArgs{
    			Username: pulumi.String("admin"),
    			FolderId: pulumi.String(terraform.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Bitwarden = Pulumi.Bitwarden;
    
    return await Deployment.RunAsync(() => 
    {
        var terraform = Bitwarden.GetFolder.Invoke(new()
        {
            Search = "Terraform",
        });
    
        // Example of usage of the data source:
        var administrativeUser = new Bitwarden.ItemLogin("administrativeUser", new()
        {
            Username = "admin",
            FolderId = terraform.Apply(getFolderResult => getFolderResult.Id),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.bitwarden.BitwardenFunctions;
    import com.pulumi.bitwarden.inputs.GetFolderArgs;
    import com.pulumi.bitwarden.ItemLogin;
    import com.pulumi.bitwarden.ItemLoginArgs;
    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 terraform = BitwardenFunctions.getFolder(GetFolderArgs.builder()
                .search("Terraform")
                .build());
    
            // Example of usage of the data source:
            var administrativeUser = new ItemLogin("administrativeUser", ItemLoginArgs.builder()
                .username("admin")
                .folderId(terraform.applyValue(getFolderResult -> getFolderResult.id()))
                .build());
    
        }
    }
    
    resources:
      # Example of usage of the data source:
      administrativeUser:
        type: bitwarden:ItemLogin
        properties:
          username: admin
          folderId: ${terraform.id}
    variables:
      terraform:
        fn::invoke:
          function: bitwarden:getFolder
          arguments:
            search: Terraform
    

    Using getFolder

    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 getFolder(args: GetFolderArgs, opts?: InvokeOptions): Promise<GetFolderResult>
    function getFolderOutput(args: GetFolderOutputArgs, opts?: InvokeOptions): Output<GetFolderResult>
    def get_folder(filter_collection_id: Optional[str] = None,
                   filter_organization_id: Optional[str] = None,
                   id: Optional[str] = None,
                   search: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetFolderResult
    def get_folder_output(filter_collection_id: Optional[pulumi.Input[str]] = None,
                   filter_organization_id: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   search: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetFolderResult]
    func LookupFolder(ctx *Context, args *LookupFolderArgs, opts ...InvokeOption) (*LookupFolderResult, error)
    func LookupFolderOutput(ctx *Context, args *LookupFolderOutputArgs, opts ...InvokeOption) LookupFolderResultOutput

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

    public static class GetFolder 
    {
        public static Task<GetFolderResult> InvokeAsync(GetFolderArgs args, InvokeOptions? opts = null)
        public static Output<GetFolderResult> Invoke(GetFolderInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFolderResult> getFolder(GetFolderArgs args, InvokeOptions options)
    public static Output<GetFolderResult> getFolder(GetFolderArgs args, InvokeOptions options)
    
    fn::invoke:
      function: bitwarden:index/getFolder:getFolder
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FilterCollectionId string
    Filter search results by collection ID.
    FilterOrganizationId string
    Filter search results by organization ID.
    Id string
    Identifier.
    Search string
    Search items matching the search string.
    FilterCollectionId string
    Filter search results by collection ID.
    FilterOrganizationId string
    Filter search results by organization ID.
    Id string
    Identifier.
    Search string
    Search items matching the search string.
    filterCollectionId String
    Filter search results by collection ID.
    filterOrganizationId String
    Filter search results by organization ID.
    id String
    Identifier.
    search String
    Search items matching the search string.
    filterCollectionId string
    Filter search results by collection ID.
    filterOrganizationId string
    Filter search results by organization ID.
    id string
    Identifier.
    search string
    Search items matching the search string.
    filter_collection_id str
    Filter search results by collection ID.
    filter_organization_id str
    Filter search results by organization ID.
    id str
    Identifier.
    search str
    Search items matching the search string.
    filterCollectionId String
    Filter search results by collection ID.
    filterOrganizationId String
    Filter search results by organization ID.
    id String
    Identifier.
    search String
    Search items matching the search string.

    getFolder Result

    The following output properties are available:

    Name string
    Name.
    FilterCollectionId string
    Filter search results by collection ID.
    FilterOrganizationId string
    Filter search results by organization ID.
    Id string
    Identifier.
    Search string
    Search items matching the search string.
    Name string
    Name.
    FilterCollectionId string
    Filter search results by collection ID.
    FilterOrganizationId string
    Filter search results by organization ID.
    Id string
    Identifier.
    Search string
    Search items matching the search string.
    name String
    Name.
    filterCollectionId String
    Filter search results by collection ID.
    filterOrganizationId String
    Filter search results by organization ID.
    id String
    Identifier.
    search String
    Search items matching the search string.
    name string
    Name.
    filterCollectionId string
    Filter search results by collection ID.
    filterOrganizationId string
    Filter search results by organization ID.
    id string
    Identifier.
    search string
    Search items matching the search string.
    name str
    Name.
    filter_collection_id str
    Filter search results by collection ID.
    filter_organization_id str
    Filter search results by organization ID.
    id str
    Identifier.
    search str
    Search items matching the search string.
    name String
    Name.
    filterCollectionId String
    Filter search results by collection ID.
    filterOrganizationId String
    Filter search results by organization ID.
    id String
    Identifier.
    search String
    Search items matching the search string.

    Package Details

    Repository
    bitwarden maxlaverse/terraform-provider-bitwarden
    License
    Notes
    This Pulumi package is based on the bitwarden Terraform Provider.
    bitwarden logo
    bitwarden 0.13.6 published on Thursday, Apr 17, 2025 by maxlaverse