Manage vaults using 1Password SDKs - 1Password Developer Docs

Beta The Vaults class provides methods for managing vaults in 1Password. The SDK can only get information about vaults that the authenticated user or service account has access to.

Requirements

To use this feature, you’ll need to install the 1Password SDK from the beta branch:

Go
JavaScript
Python

go get github.com/1password/onepassword-sdk-go@v0.4.0-beta.1

npm install @1password/sdk@0.4.0-beta.1

pip install onepassword-sdk==0.4.0b1

Get a vault overview

You can use Vaults.GetOverview to retrieve high-level metadata about a specific vault.

Go
JavaScript
Python

The following example uses the vaultID variable to specify the unique identifier (ID) of the vault to fetch.

// Get vault overview
vaultOverview, err := client.Vaults().GetOverview(context.Background(), vaultID)
if err != nil {
	panic(err)
}
fmt.Printf("Vault overview: %v\n", vaultOverview)

The following example uses the vaultId variable to specify the unique identifier (ID) of the vault to fetch.

// Get vault overview
const vaultOverview = await client.vaults.getOverview(vaultId);
console.log(JSON.stringify(vaultOverview));

The following example uses the vault_id variable to specify the unique identifier (ID) of the vault to fetch.

# Get vault overview
vaultOverview = await client.vaults.get_overview(vault_id)
print(vaultOverview)

Get vault details

You can use Vaults.Get to retrieve the complete object for a specific vault.

Go
JavaScript
Python

The following example gets the full details for the vault you fetched in the previous step.

// Get vault details
vault, err := client.Vaults().Get(context.Background(), vaultOverview.ID, onepassword.VaultGetParams{})
if err != nil {
	panic(err)
}
fmt.Printf("Vault details: %v\n", vault)

The following example gets the full details for the vault you fetched in the previous step.

// Get vault details
const vault = await client.vaults.get(vaultOverview.id, {accessors: false});
console.log(JSON.stringify(vault));

The following example gets the full details for the vault you fetched in the previous step.

# Get vault details
vault = await client.vaults.get(vaultOverview.id, VaultGetParams(accessors=False))
print(vault)

SDKs

​Requirements

​Get a vault overview

​Get vault details

Requirements

Get a vault overview

Get vault details