Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. 1Password
  3. API Docs
  4. Item
1Password v1.1.4 published on Wednesday, Sep 4, 2024 by 1Password
1Password/pulumi-onepassword

onepassword.Item

Explore with Pulumi AI

onepassword logo
1Password v1.1.4 published on Wednesday, Sep 4, 2024 by 1Password
1Password/pulumi-onepassword

    A 1Password Item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as onepassword from "@1password/pulumi-onepassword";

const example = new onepassword.Item("example", {
    category: "login",
    passwordRecipe: {
        length: 40,
        symbols: false,
    },
    sections: [{
        fields: [{
            label: "Example field",
            type: "DATE",
            value: "2024-01-31",
        }],
        label: "Example section",
    }],
    title: "Example Item Title",
    vault: "your-vault-id",
});

    import pulumi
import pulumi_onepassword as onepassword

example = onepassword.Item("example",
    category="login",
    password_recipe={
        "length": 40,
        "symbols": False,
    },
    sections=[{
        "fields": [{
            "label": "Example field",
            "type": "DATE",
            "value": "2024-01-31",
        }],
        "label": "Example section",
    }],
    title="Example Item Title",
    vault="your-vault-id")

    package main

import (
	"github.com/1Password/pulumi-onepassword/sdk/go/onepassword"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := onepassword.NewItem(ctx, "example", &onepassword.ItemArgs{
			Category: pulumi.String("login"),
			PasswordRecipe: &onepassword.ItemPasswordRecipeArgs{
				Length:  pulumi.Int(40),
				Symbols: pulumi.Bool(false),
			},
			Sections: onepassword.ItemSectionArray{
				&onepassword.ItemSectionArgs{
					Fields: onepassword.ItemSectionFieldArray{
						&onepassword.ItemSectionFieldArgs{
							Label: pulumi.String("Example field"),
							Type:  pulumi.String("DATE"),
							Value: pulumi.String("2024-01-31"),
						},
					},
					Label: pulumi.String("Example section"),
				},
			},
			Title: pulumi.String("Example Item Title"),
			Vault: pulumi.String("your-vault-id"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Onepassword.Item("example", new()
    {
        Category = "login",
        PasswordRecipe = new Onepassword.Inputs.ItemPasswordRecipeArgs
        {
            Length = 40,
            Symbols = false,
        },
        Sections = new[]
        {
            new Onepassword.Inputs.ItemSectionArgs
            {
                Fields = new[]
                {
                    new Onepassword.Inputs.ItemSectionFieldArgs
                    {
                        Label = "Example field",
                        Type = "DATE",
                        Value = "2024-01-31",
                    },
                },
                Label = "Example section",
            },
        },
        Title = "Example Item Title",
        Vault = "your-vault-id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.onepassword.Item;
import com.pulumi.onepassword.ItemArgs;
import com.pulumi.onepassword.inputs.ItemPasswordRecipeArgs;
import com.pulumi.onepassword.inputs.ItemSectionArgs;
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) {
        var example = new Item("example", ItemArgs.builder()
            .category("login")
            .passwordRecipe(ItemPasswordRecipeArgs.builder()
                .length(40)
                .symbols(false)
                .build())
            .sections(ItemSectionArgs.builder()
                .fields(ItemSectionFieldArgs.builder()
                    .label("Example field")
                    .type("DATE")
                    .value("2024-01-31")
                    .build())
                .label("Example section")
                .build())
            .title("Example Item Title")
            .vault("your-vault-id")
            .build());

    }
}

    resources:
  example:
    type: onepassword:Item
    properties:
      category: login
      passwordRecipe:
        length: 40
        symbols: false
      sections:
        - fields:
            - label: Example field
              type: DATE
              value: 2024-01-31
          label: Example section
      title: Example Item Title
      vault: your-vault-id

    Create Item Resource

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

    Constructor syntax

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

@overload
def Item(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         vault: Optional[str] = None,
         port: Optional[str] = None,
         hostname: Optional[str] = None,
         note_value: Optional[str] = None,
         password: Optional[str] = None,
         password_recipe: Optional[ItemPasswordRecipeArgs] = None,
         category: Optional[str] = None,
         sections: Optional[Sequence[ItemSectionArgs]] = None,
         tags: Optional[Sequence[str]] = None,
         title: Optional[str] = None,
         type: Optional[str] = None,
         url: Optional[str] = None,
         username: Optional[str] = None,
         database: Optional[str] = None)
    func NewItem(ctx *Context, name string, args ItemArgs, opts ...ResourceOption) (*Item, error)
    public Item(string name, ItemArgs args, CustomResourceOptions? opts = null)
    public Item(String name, ItemArgs args)
public Item(String name, ItemArgs args, CustomResourceOptions options)

    type: onepassword:Item
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 ItemArgs
    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 ItemArgs
    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 ItemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ItemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ItemArgs
    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 itemResource = new Onepassword.Item("itemResource", new()
{
    Vault = "string",
    Port = "string",
    Hostname = "string",
    NoteValue = "string",
    Password = "string",
    PasswordRecipe = new Onepassword.Inputs.ItemPasswordRecipeArgs
    {
        Digits = false,
        Length = 0,
        Letters = false,
        Symbols = false,
    },
    Category = "string",
    Sections = new[]
    {
        new Onepassword.Inputs.ItemSectionArgs
        {
            Label = "string",
            Fields = new[]
            {
                new Onepassword.Inputs.ItemSectionFieldArgs
                {
                    Label = "string",
                    Id = "string",
                    PasswordRecipe = new Onepassword.Inputs.ItemSectionFieldPasswordRecipeArgs
                    {
                        Digits = false,
                        Length = 0,
                        Letters = false,
                        Symbols = false,
                    },
                    Purpose = "string",
                    Type = "string",
                    Value = "string",
                },
            },
            Id = "string",
        },
    },
    Tags = new[]
    {
        "string",
    },
    Title = "string",
    Type = "string",
    Url = "string",
    Username = "string",
    Database = "string",
});

    example, err := onepassword.NewItem(ctx, "itemResource", &onepassword.ItemArgs{
	Vault:     pulumi.String("string"),
	Port:      pulumi.String("string"),
	Hostname:  pulumi.String("string"),
	NoteValue: pulumi.String("string"),
	Password:  pulumi.String("string"),
	PasswordRecipe: &onepassword.ItemPasswordRecipeArgs{
		Digits:  pulumi.Bool(false),
		Length:  pulumi.Int(0),
		Letters: pulumi.Bool(false),
		Symbols: pulumi.Bool(false),
	},
	Category: pulumi.String("string"),
	Sections: onepassword.ItemSectionArray{
		&onepassword.ItemSectionArgs{
			Label: pulumi.String("string"),
			Fields: onepassword.ItemSectionFieldArray{
				&onepassword.ItemSectionFieldArgs{
					Label: pulumi.String("string"),
					Id:    pulumi.String("string"),
					PasswordRecipe: &onepassword.ItemSectionFieldPasswordRecipeArgs{
						Digits:  pulumi.Bool(false),
						Length:  pulumi.Int(0),
						Letters: pulumi.Bool(false),
						Symbols: pulumi.Bool(false),
					},
					Purpose: pulumi.String("string"),
					Type:    pulumi.String("string"),
					Value:   pulumi.String("string"),
				},
			},
			Id: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Title:    pulumi.String("string"),
	Type:     pulumi.String("string"),
	Url:      pulumi.String("string"),
	Username: pulumi.String("string"),
	Database: pulumi.String("string"),
})

    var itemResource = new Item("itemResource", ItemArgs.builder()
    .vault("string")
    .port("string")
    .hostname("string")
    .noteValue("string")
    .password("string")
    .passwordRecipe(ItemPasswordRecipeArgs.builder()
        .digits(false)
        .length(0)
        .letters(false)
        .symbols(false)
        .build())
    .category("string")
    .sections(ItemSectionArgs.builder()
        .label("string")
        .fields(ItemSectionFieldArgs.builder()
            .label("string")
            .id("string")
            .passwordRecipe(ItemSectionFieldPasswordRecipeArgs.builder()
                .digits(false)
                .length(0)
                .letters(false)
                .symbols(false)
                .build())
            .purpose("string")
            .type("string")
            .value("string")
            .build())
        .id("string")
        .build())
    .tags("string")
    .title("string")
    .type("string")
    .url("string")
    .username("string")
    .database("string")
    .build());

    item_resource = onepassword.Item("itemResource",
    vault="string",
    port="string",
    hostname="string",
    note_value="string",
    password="string",
    password_recipe=onepassword.ItemPasswordRecipeArgs(
        digits=False,
        length=0,
        letters=False,
        symbols=False,
    ),
    category="string",
    sections=[onepassword.ItemSectionArgs(
        label="string",
        fields=[onepassword.ItemSectionFieldArgs(
            label="string",
            id="string",
            password_recipe=onepassword.ItemSectionFieldPasswordRecipeArgs(
                digits=False,
                length=0,
                letters=False,
                symbols=False,
            ),
            purpose="string",
            type="string",
            value="string",
        )],
        id="string",
    )],
    tags=["string"],
    title="string",
    type="string",
    url="string",
    username="string",
    database="string")

    const itemResource = new onepassword.Item("itemResource", {
    vault: "string",
    port: "string",
    hostname: "string",
    noteValue: "string",
    password: "string",
    passwordRecipe: {
        digits: false,
        length: 0,
        letters: false,
        symbols: false,
    },
    category: "string",
    sections: [{
        label: "string",
        fields: [{
            label: "string",
            id: "string",
            passwordRecipe: {
                digits: false,
                length: 0,
                letters: false,
                symbols: false,
            },
            purpose: "string",
            type: "string",
            value: "string",
        }],
        id: "string",
    }],
    tags: ["string"],
    title: "string",
    type: "string",
    url: "string",
    username: "string",
    database: "string",
});

    type: onepassword:Item
properties:
    category: string
    database: string
    hostname: string
    noteValue: string
    password: string
    passwordRecipe:
        digits: false
        length: 0
        letters: false
        symbols: false
    port: string
    sections:
        - fields:
            - id: string
              label: string
              passwordRecipe:
                digits: false
                length: 0
                letters: false
                symbols: false
              purpose: string
              type: string
              value: string
          id: string
          label: string
    tags:
        - string
    title: string
    type: string
    url: string
    username: string
    vault: string

    Item Resource Properties

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

    Inputs

    The Item resource accepts the following input properties:

    Vault string
    The UUID of the vault the item is in.
    Category string
    The category of the item. One of ["login" "password" "database" "secure_note"]
    Database string
    (Only applies to the database category) The name of the database.
    Hostname string
    (Only applies to the database category) The address where the database can be found
    NoteValue string
    Secure Note value.
    Password string
    Password for this item.
    PasswordRecipe ItemPasswordRecipe
    The recipe used to generate a new value for a password.
    Port string
    (Only applies to the database category) The port the database is listening on.
    Sections List<ItemSection>
    A list of custom sections in an item
    Tags List<string>
    An array of strings of the tags assigned to the item.
    Title string
    The title of the item.
    Type string
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    Url string
    The primary URL for the item.
    Username string
    Username for this item.
    Vault string
    The UUID of the vault the item is in.
    Category string
    The category of the item. One of ["login" "password" "database" "secure_note"]
    Database string
    (Only applies to the database category) The name of the database.
    Hostname string
    (Only applies to the database category) The address where the database can be found
    NoteValue string
    Secure Note value.
    Password string
    Password for this item.
    PasswordRecipe ItemPasswordRecipeArgs
    The recipe used to generate a new value for a password.
    Port string
    (Only applies to the database category) The port the database is listening on.
    Sections []ItemSectionArgs
    A list of custom sections in an item
    Tags []string
    An array of strings of the tags assigned to the item.
    Title string
    The title of the item.
    Type string
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    Url string
    The primary URL for the item.
    Username string
    Username for this item.
    vault String
    The UUID of the vault the item is in.
    category String
    The category of the item. One of ["login" "password" "database" "secure_note"]
    database String
    (Only applies to the database category) The name of the database.
    hostname String
    (Only applies to the database category) The address where the database can be found
    noteValue String
    Secure Note value.
    password String
    Password for this item.
    passwordRecipe ItemPasswordRecipe
    The recipe used to generate a new value for a password.
    port String
    (Only applies to the database category) The port the database is listening on.
    sections List<ItemSection>
    A list of custom sections in an item
    tags List<String>
    An array of strings of the tags assigned to the item.
    title String
    The title of the item.
    type String
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    url String
    The primary URL for the item.
    username String
    Username for this item.
    vault string
    The UUID of the vault the item is in.
    category string
    The category of the item. One of ["login" "password" "database" "secure_note"]
    database string
    (Only applies to the database category) The name of the database.
    hostname string
    (Only applies to the database category) The address where the database can be found
    noteValue string
    Secure Note value.
    password string
    Password for this item.
    passwordRecipe ItemPasswordRecipe
    The recipe used to generate a new value for a password.
    port string
    (Only applies to the database category) The port the database is listening on.
    sections ItemSection[]
    A list of custom sections in an item
    tags string[]
    An array of strings of the tags assigned to the item.
    title string
    The title of the item.
    type string
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    url string
    The primary URL for the item.
    username string
    Username for this item.
    vault str
    The UUID of the vault the item is in.
    category str
    The category of the item. One of ["login" "password" "database" "secure_note"]
    database str
    (Only applies to the database category) The name of the database.
    hostname str
    (Only applies to the database category) The address where the database can be found
    note_value str
    Secure Note value.
    password str
    Password for this item.
    password_recipe ItemPasswordRecipeArgs
    The recipe used to generate a new value for a password.
    port str
    (Only applies to the database category) The port the database is listening on.
    sections Sequence[ItemSectionArgs]
    A list of custom sections in an item
    tags Sequence[str]
    An array of strings of the tags assigned to the item.
    title str
    The title of the item.
    type str
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    url str
    The primary URL for the item.
    username str
    Username for this item.
    vault String
    The UUID of the vault the item is in.
    category String
    The category of the item. One of ["login" "password" "database" "secure_note"]
    database String
    (Only applies to the database category) The name of the database.
    hostname String
    (Only applies to the database category) The address where the database can be found
    noteValue String
    Secure Note value.
    password String
    Password for this item.
    passwordRecipe Property Map
    The recipe used to generate a new value for a password.
    port String
    (Only applies to the database category) The port the database is listening on.
    sections List<Property Map>
    A list of custom sections in an item
    tags List<String>
    An array of strings of the tags assigned to the item.
    title String
    The title of the item.
    type String
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    url String
    The primary URL for the item.
    username String
    Username for this item.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Item resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    The UUID of the item. Item identifiers are unique within a specific vault.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    The UUID of the item. Item identifiers are unique within a specific vault.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    The UUID of the item. Item identifiers are unique within a specific vault.
    id string
    The provider-assigned unique ID for this managed resource.
    uuid string
    The UUID of the item. Item identifiers are unique within a specific vault.
    id str
    The provider-assigned unique ID for this managed resource.
    uuid str
    The UUID of the item. Item identifiers are unique within a specific vault.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    The UUID of the item. Item identifiers are unique within a specific vault.

    Look up Existing Item Resource

    Get an existing Item 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?: ItemState, opts?: CustomResourceOptions): Item
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category: Optional[str] = None,
        database: Optional[str] = None,
        hostname: Optional[str] = None,
        note_value: Optional[str] = None,
        password: Optional[str] = None,
        password_recipe: Optional[ItemPasswordRecipeArgs] = None,
        port: Optional[str] = None,
        sections: Optional[Sequence[ItemSectionArgs]] = None,
        tags: Optional[Sequence[str]] = None,
        title: Optional[str] = None,
        type: Optional[str] = None,
        url: Optional[str] = None,
        username: Optional[str] = None,
        uuid: Optional[str] = None,
        vault: Optional[str] = None) -> Item
    func GetItem(ctx *Context, name string, id IDInput, state *ItemState, opts ...ResourceOption) (*Item, error)
    public static Item Get(string name, Input<string> id, ItemState? state, CustomResourceOptions? opts = null)
    public static Item get(String name, Output<String> id, ItemState 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:
    Category string
    The category of the item. One of ["login" "password" "database" "secure_note"]
    Database string
    (Only applies to the database category) The name of the database.
    Hostname string
    (Only applies to the database category) The address where the database can be found
    NoteValue string
    Secure Note value.
    Password string
    Password for this item.
    PasswordRecipe ItemPasswordRecipe
    The recipe used to generate a new value for a password.
    Port string
    (Only applies to the database category) The port the database is listening on.
    Sections List<ItemSection>
    A list of custom sections in an item
    Tags List<string>
    An array of strings of the tags assigned to the item.
    Title string
    The title of the item.
    Type string
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    Url string
    The primary URL for the item.
    Username string
    Username for this item.
    Uuid string
    The UUID of the item. Item identifiers are unique within a specific vault.
    Vault string
    The UUID of the vault the item is in.
    Category string
    The category of the item. One of ["login" "password" "database" "secure_note"]
    Database string
    (Only applies to the database category) The name of the database.
    Hostname string
    (Only applies to the database category) The address where the database can be found
    NoteValue string
    Secure Note value.
    Password string
    Password for this item.
    PasswordRecipe ItemPasswordRecipeArgs
    The recipe used to generate a new value for a password.
    Port string
    (Only applies to the database category) The port the database is listening on.
    Sections []ItemSectionArgs
    A list of custom sections in an item
    Tags []string
    An array of strings of the tags assigned to the item.
    Title string
    The title of the item.
    Type string
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    Url string
    The primary URL for the item.
    Username string
    Username for this item.
    Uuid string
    The UUID of the item. Item identifiers are unique within a specific vault.
    Vault string
    The UUID of the vault the item is in.
    category String
    The category of the item. One of ["login" "password" "database" "secure_note"]
    database String
    (Only applies to the database category) The name of the database.
    hostname String
    (Only applies to the database category) The address where the database can be found
    noteValue String
    Secure Note value.
    password String
    Password for this item.
    passwordRecipe ItemPasswordRecipe
    The recipe used to generate a new value for a password.
    port String
    (Only applies to the database category) The port the database is listening on.
    sections List<ItemSection>
    A list of custom sections in an item
    tags List<String>
    An array of strings of the tags assigned to the item.
    title String
    The title of the item.
    type String
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    url String
    The primary URL for the item.
    username String
    Username for this item.
    uuid String
    The UUID of the item. Item identifiers are unique within a specific vault.
    vault String
    The UUID of the vault the item is in.
    category string
    The category of the item. One of ["login" "password" "database" "secure_note"]
    database string
    (Only applies to the database category) The name of the database.
    hostname string
    (Only applies to the database category) The address where the database can be found
    noteValue string
    Secure Note value.
    password string
    Password for this item.
    passwordRecipe ItemPasswordRecipe
    The recipe used to generate a new value for a password.
    port string
    (Only applies to the database category) The port the database is listening on.
    sections ItemSection[]
    A list of custom sections in an item
    tags string[]
    An array of strings of the tags assigned to the item.
    title string
    The title of the item.
    type string
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    url string
    The primary URL for the item.
    username string
    Username for this item.
    uuid string
    The UUID of the item. Item identifiers are unique within a specific vault.
    vault string
    The UUID of the vault the item is in.
    category str
    The category of the item. One of ["login" "password" "database" "secure_note"]
    database str
    (Only applies to the database category) The name of the database.
    hostname str
    (Only applies to the database category) The address where the database can be found
    note_value str
    Secure Note value.
    password str
    Password for this item.
    password_recipe ItemPasswordRecipeArgs
    The recipe used to generate a new value for a password.
    port str
    (Only applies to the database category) The port the database is listening on.
    sections Sequence[ItemSectionArgs]
    A list of custom sections in an item
    tags Sequence[str]
    An array of strings of the tags assigned to the item.
    title str
    The title of the item.
    type str
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    url str
    The primary URL for the item.
    username str
    Username for this item.
    uuid str
    The UUID of the item. Item identifiers are unique within a specific vault.
    vault str
    The UUID of the vault the item is in.
    category String
    The category of the item. One of ["login" "password" "database" "secure_note"]
    database String
    (Only applies to the database category) The name of the database.
    hostname String
    (Only applies to the database category) The address where the database can be found
    noteValue String
    Secure Note value.
    password String
    Password for this item.
    passwordRecipe Property Map
    The recipe used to generate a new value for a password.
    port String
    (Only applies to the database category) The port the database is listening on.
    sections List<Property Map>
    A list of custom sections in an item
    tags List<String>
    An array of strings of the tags assigned to the item.
    title String
    The title of the item.
    type String
    (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
    url String
    The primary URL for the item.
    username String
    Username for this item.
    uuid String
    The UUID of the item. Item identifiers are unique within a specific vault.
    vault String
    The UUID of the vault the item is in.

    Supporting Types

    ItemPasswordRecipe, ItemPasswordRecipeArgs

    Digits bool
    Use digits [0-9] when generating the password.
    Length int
    The length of the password to be generated.
    Letters bool
    Use letters [a-zA-Z] when generating the password.
    Symbols bool
    Use symbols [!@.-_*] when generating the password.
    Digits bool
    Use digits [0-9] when generating the password.
    Length int
    The length of the password to be generated.
    Letters bool
    Use letters [a-zA-Z] when generating the password.
    Symbols bool
    Use symbols [!@.-_*] when generating the password.
    digits Boolean
    Use digits [0-9] when generating the password.
    length Integer
    The length of the password to be generated.
    letters Boolean
    Use letters [a-zA-Z] when generating the password.
    symbols Boolean
    Use symbols [!@.-_*] when generating the password.
    digits boolean
    Use digits [0-9] when generating the password.
    length number
    The length of the password to be generated.
    letters boolean
    Use letters [a-zA-Z] when generating the password.
    symbols boolean
    Use symbols [!@.-_*] when generating the password.
    digits bool
    Use digits [0-9] when generating the password.
    length int
    The length of the password to be generated.
    letters bool
    Use letters [a-zA-Z] when generating the password.
    symbols bool
    Use symbols [!@.-_*] when generating the password.
    digits Boolean
    Use digits [0-9] when generating the password.
    length Number
    The length of the password to be generated.
    letters Boolean
    Use letters [a-zA-Z] when generating the password.
    symbols Boolean
    Use symbols [!@.-_*] when generating the password.

    ItemSection, ItemSectionArgs

    Label string
    The label for the section.
    Fields List<ItemSectionField>
    A list of custom fields in the section.
    Id string
    A unique identifier for the section.
    Label string
    The label for the section.
    Fields []ItemSectionField
    A list of custom fields in the section.
    Id string
    A unique identifier for the section.
    label String
    The label for the section.
    fields List<ItemSectionField>
    A list of custom fields in the section.
    id String
    A unique identifier for the section.
    label string
    The label for the section.
    fields ItemSectionField[]
    A list of custom fields in the section.
    id string
    A unique identifier for the section.
    label str
    The label for the section.
    fields Sequence[ItemSectionField]
    A list of custom fields in the section.
    id str
    A unique identifier for the section.
    label String
    The label for the section.
    fields List<Property Map>
    A list of custom fields in the section.
    id String
    A unique identifier for the section.

    ItemSectionField, ItemSectionFieldArgs

    Label string
    The label for the field.
    Id string
    A unique identifier for the field.
    PasswordRecipe ItemSectionFieldPasswordRecipe
    The recipe used to generate a new value for a password.
    Purpose string
    Purpose indicates this is a special field: a username, password, or notes field. One of ["USERNAME" "PASSWORD" "NOTES"]
    Type string
    The type of value stored in the field. One of ["STRING" "CONCEALED" "EMAIL" "URL" "OTP" "DATE" "MONTH_YEAR" "MENU"]
    Value string
    The value of the field.
    Label string
    The label for the field.
    Id string
    A unique identifier for the field.
    PasswordRecipe ItemSectionFieldPasswordRecipe
    The recipe used to generate a new value for a password.
    Purpose string
    Purpose indicates this is a special field: a username, password, or notes field. One of ["USERNAME" "PASSWORD" "NOTES"]
    Type string
    The type of value stored in the field. One of ["STRING" "CONCEALED" "EMAIL" "URL" "OTP" "DATE" "MONTH_YEAR" "MENU"]
    Value string
    The value of the field.
    label String
    The label for the field.
    id String
    A unique identifier for the field.
    passwordRecipe ItemSectionFieldPasswordRecipe
    The recipe used to generate a new value for a password.
    purpose String
    Purpose indicates this is a special field: a username, password, or notes field. One of ["USERNAME" "PASSWORD" "NOTES"]
    type String
    The type of value stored in the field. One of ["STRING" "CONCEALED" "EMAIL" "URL" "OTP" "DATE" "MONTH_YEAR" "MENU"]
    value String
    The value of the field.
    label string
    The label for the field.
    id string
    A unique identifier for the field.
    passwordRecipe ItemSectionFieldPasswordRecipe
    The recipe used to generate a new value for a password.
    purpose string
    Purpose indicates this is a special field: a username, password, or notes field. One of ["USERNAME" "PASSWORD" "NOTES"]
    type string
    The type of value stored in the field. One of ["STRING" "CONCEALED" "EMAIL" "URL" "OTP" "DATE" "MONTH_YEAR" "MENU"]
    value string
    The value of the field.
    label str
    The label for the field.
    id str
    A unique identifier for the field.
    password_recipe ItemSectionFieldPasswordRecipe
    The recipe used to generate a new value for a password.
    purpose str
    Purpose indicates this is a special field: a username, password, or notes field. One of ["USERNAME" "PASSWORD" "NOTES"]
    type str
    The type of value stored in the field. One of ["STRING" "CONCEALED" "EMAIL" "URL" "OTP" "DATE" "MONTH_YEAR" "MENU"]
    value str
    The value of the field.
    label String
    The label for the field.
    id String
    A unique identifier for the field.
    passwordRecipe Property Map
    The recipe used to generate a new value for a password.
    purpose String
    Purpose indicates this is a special field: a username, password, or notes field. One of ["USERNAME" "PASSWORD" "NOTES"]
    type String
    The type of value stored in the field. One of ["STRING" "CONCEALED" "EMAIL" "URL" "OTP" "DATE" "MONTH_YEAR" "MENU"]
    value String
    The value of the field.

    ItemSectionFieldPasswordRecipe, ItemSectionFieldPasswordRecipeArgs

    Digits bool
    Use digits [0-9] when generating the password.
    Length int
    The length of the password to be generated.
    Letters bool
    Use letters [a-zA-Z] when generating the password.
    Symbols bool
    Use symbols [!@.-_*] when generating the password.
    Digits bool
    Use digits [0-9] when generating the password.
    Length int
    The length of the password to be generated.
    Letters bool
    Use letters [a-zA-Z] when generating the password.
    Symbols bool
    Use symbols [!@.-_*] when generating the password.
    digits Boolean
    Use digits [0-9] when generating the password.
    length Integer
    The length of the password to be generated.
    letters Boolean
    Use letters [a-zA-Z] when generating the password.
    symbols Boolean
    Use symbols [!@.-_*] when generating the password.
    digits boolean
    Use digits [0-9] when generating the password.
    length number
    The length of the password to be generated.
    letters boolean
    Use letters [a-zA-Z] when generating the password.
    symbols boolean
    Use symbols [!@.-_*] when generating the password.
    digits bool
    Use digits [0-9] when generating the password.
    length int
    The length of the password to be generated.
    letters bool
    Use letters [a-zA-Z] when generating the password.
    symbols bool
    Use symbols [!@.-_*] when generating the password.
    digits Boolean
    Use digits [0-9] when generating the password.
    length Number
    The length of the password to be generated.
    letters Boolean
    Use letters [a-zA-Z] when generating the password.
    symbols Boolean
    Use symbols [!@.-_*] when generating the password.

    Import

    import an existing 1Password item

    $ pulumi import onepassword:index/item:Item myitem vaults/<vault uuid>/items/<item uuid>

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

    Package Details

    Repository
    onepassword 1Password/pulumi-onepassword
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the onepassword Terraform Provider.
    onepassword logo
    1Password v1.1.4 published on Wednesday, Sep 4, 2024 by 1Password
    1Password/pulumi-onepassword