1. Packages
  2. Bitwarden Provider
  3. API Docs
  4. OrgCollection
bitwarden 0.13.5 published on Monday, Apr 14, 2025 by maxlaverse

bitwarden.OrgCollection

Explore with Pulumi AI

Manages an organization collection.

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
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.GetOrganizationArgs;
import com.pulumi.bitwarden.OrgCollection;
import com.pulumi.bitwarden.OrgCollectionArgs;
import com.pulumi.bitwarden.inputs.OrgCollectionMemberArgs;
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.getOrganization(GetOrganizationArgs.builder()
            .search("Terraform")
            .build());

        var infrastructure = new OrgCollection("infrastructure", OrgCollectionArgs.builder()
            .organizationId(terraform.applyValue(getOrganizationResult -> getOrganizationResult.id()))
            .build());

        var generated = new OrgCollection("generated", OrgCollectionArgs.builder()
            .organizationId(terraform.applyValue(getOrganizationResult -> getOrganizationResult.id()))
            .members(OrgCollectionMemberArgs.builder()
                .email("devops@example.com")
                .build())
            .build());

    }
}
Copy
resources:
  infrastructure:
    type: bitwarden:OrgCollection
    properties:
      organizationId: ${terraform.id}
  generated:
    type: bitwarden:OrgCollection
    properties:
      organizationId: ${terraform.id}
      members:
        - email: devops@example.com
variables:
  terraform:
    fn::invoke:
      function: bitwarden:getOrganization
      arguments:
        search: Terraform
Copy

Create OrgCollection Resource

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

Constructor syntax

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

@overload
def OrgCollection(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  organization_id: Optional[str] = None,
                  members: Optional[Sequence[OrgCollectionMemberArgs]] = None,
                  name: Optional[str] = None,
                  org_collection_id: Optional[str] = None)
func NewOrgCollection(ctx *Context, name string, args OrgCollectionArgs, opts ...ResourceOption) (*OrgCollection, error)
public OrgCollection(string name, OrgCollectionArgs args, CustomResourceOptions? opts = null)
public OrgCollection(String name, OrgCollectionArgs args)
public OrgCollection(String name, OrgCollectionArgs args, CustomResourceOptions options)
type: bitwarden:OrgCollection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OrgCollectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OrgCollectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OrgCollectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OrgCollectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OrgCollectionArgs
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 orgCollectionResource = new Bitwarden.OrgCollection("orgCollectionResource", new()
{
    OrganizationId = "string",
    Members = new[]
    {
        new Bitwarden.Inputs.OrgCollectionMemberArgs
        {
            Id = "string",
            HidePasswords = false,
            ReadOnly = false,
        },
    },
    Name = "string",
    OrgCollectionId = "string",
});
Copy
example, err := bitwarden.NewOrgCollection(ctx, "orgCollectionResource", &bitwarden.OrgCollectionArgs{
OrganizationId: pulumi.String("string"),
Members: .OrgCollectionMemberArray{
&.OrgCollectionMemberArgs{
Id: pulumi.String("string"),
HidePasswords: pulumi.Bool(false),
ReadOnly: pulumi.Bool(false),
},
},
Name: pulumi.String("string"),
OrgCollectionId: pulumi.String("string"),
})
Copy
var orgCollectionResource = new OrgCollection("orgCollectionResource", OrgCollectionArgs.builder()
    .organizationId("string")
    .members(OrgCollectionMemberArgs.builder()
        .id("string")
        .hidePasswords(false)
        .readOnly(false)
        .build())
    .name("string")
    .orgCollectionId("string")
    .build());
Copy
org_collection_resource = bitwarden.OrgCollection("orgCollectionResource",
    organization_id="string",
    members=[{
        "id": "string",
        "hide_passwords": False,
        "read_only": False,
    }],
    name="string",
    org_collection_id="string")
Copy
const orgCollectionResource = new bitwarden.OrgCollection("orgCollectionResource", {
    organizationId: "string",
    members: [{
        id: "string",
        hidePasswords: false,
        readOnly: false,
    }],
    name: "string",
    orgCollectionId: "string",
});
Copy
type: bitwarden:OrgCollection
properties:
    members:
        - hidePasswords: false
          id: string
          readOnly: false
    name: string
    orgCollectionId: string
    organizationId: string
Copy

OrgCollection 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 OrgCollection resource accepts the following input properties:

OrganizationId This property is required. string
Identifier of the organization.
Members List<OrgCollectionMember>
[Experimental] Member of a collection.
Name string
Name.
OrgCollectionId string
Identifier.
OrganizationId This property is required. string
Identifier of the organization.
Members []OrgCollectionMemberArgs
[Experimental] Member of a collection.
Name string
Name.
OrgCollectionId string
Identifier.
organizationId This property is required. String
Identifier of the organization.
members List<OrgCollectionMember>
[Experimental] Member of a collection.
name String
Name.
orgCollectionId String
Identifier.
organizationId This property is required. string
Identifier of the organization.
members OrgCollectionMember[]
[Experimental] Member of a collection.
name string
Name.
orgCollectionId string
Identifier.
organization_id This property is required. str
Identifier of the organization.
members Sequence[OrgCollectionMemberArgs]
[Experimental] Member of a collection.
name str
Name.
org_collection_id str
Identifier.
organizationId This property is required. String
Identifier of the organization.
members List<Property Map>
[Experimental] Member of a collection.
name String
Name.
orgCollectionId String
Identifier.

Outputs

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

Get an existing OrgCollection 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?: OrgCollectionState, opts?: CustomResourceOptions): OrgCollection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        members: Optional[Sequence[OrgCollectionMemberArgs]] = None,
        name: Optional[str] = None,
        org_collection_id: Optional[str] = None,
        organization_id: Optional[str] = None) -> OrgCollection
func GetOrgCollection(ctx *Context, name string, id IDInput, state *OrgCollectionState, opts ...ResourceOption) (*OrgCollection, error)
public static OrgCollection Get(string name, Input<string> id, OrgCollectionState? state, CustomResourceOptions? opts = null)
public static OrgCollection get(String name, Output<String> id, OrgCollectionState state, CustomResourceOptions options)
resources:  _:    type: bitwarden:OrgCollection    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Members List<OrgCollectionMember>
[Experimental] Member of a collection.
Name string
Name.
OrgCollectionId string
Identifier.
OrganizationId string
Identifier of the organization.
Members []OrgCollectionMemberArgs
[Experimental] Member of a collection.
Name string
Name.
OrgCollectionId string
Identifier.
OrganizationId string
Identifier of the organization.
members List<OrgCollectionMember>
[Experimental] Member of a collection.
name String
Name.
orgCollectionId String
Identifier.
organizationId String
Identifier of the organization.
members OrgCollectionMember[]
[Experimental] Member of a collection.
name string
Name.
orgCollectionId string
Identifier.
organizationId string
Identifier of the organization.
members Sequence[OrgCollectionMemberArgs]
[Experimental] Member of a collection.
name str
Name.
org_collection_id str
Identifier.
organization_id str
Identifier of the organization.
members List<Property Map>
[Experimental] Member of a collection.
name String
Name.
orgCollectionId String
Identifier.
organizationId String
Identifier of the organization.

Supporting Types

OrgCollectionMember
, OrgCollectionMemberArgs

Id This property is required. string
Identifier.
HidePasswords bool
[Experimental] Hide passwords.
ReadOnly bool
[Experimental] Read/Write permissions.
Id This property is required. string
Identifier.
HidePasswords bool
[Experimental] Hide passwords.
ReadOnly bool
[Experimental] Read/Write permissions.
id This property is required. String
Identifier.
hidePasswords Boolean
[Experimental] Hide passwords.
readOnly Boolean
[Experimental] Read/Write permissions.
id This property is required. string
Identifier.
hidePasswords boolean
[Experimental] Hide passwords.
readOnly boolean
[Experimental] Read/Write permissions.
id This property is required. str
Identifier.
hide_passwords bool
[Experimental] Hide passwords.
read_only bool
[Experimental] Read/Write permissions.
id This property is required. String
Identifier.
hidePasswords Boolean
[Experimental] Hide passwords.
readOnly Boolean
[Experimental] Read/Write permissions.

Import

$ pulumi import bitwarden:index/orgCollection:OrgCollection example <organization_id>/<collection_id>
Copy

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

Package Details

Repository
bitwarden maxlaverse/terraform-provider-bitwarden
License
Notes
This Pulumi package is based on the bitwarden Terraform Provider.