OnePassword.NET 2.3.3

OnePassword.NET - 1Password CLI Wrapper

This library serves as a .NET wrapper for the 1Password command-line tool op.exe ( Download | Documentation ).

References

This library targets .NET 6.0, .NET 7.0, and .NET 8.0.

Dependencies

This library has no dependencies.

Quick Start

Creating an instance of the manager

var onePassword = new OnePasswordManager();

Adding your account and signing in for the first time

var domain = "my.1password.com";
var email = "your@email.com";
var secretKey = "A3-YOUR-SECRET-KEY";
var password = "yourpassword";

onePassword.AddAccount(domain, email, secretKey, password);
onePassword.SignIn(password);

Signing in for subsequent connections

onePassword.UseAccount(domain);
onePassword.SignIn(password);

Using Service Accounts

To signin using a Service Account, a token must be provided as part of the options.

var onePassword = new OnePasswordManager(options => {
    options.ServiceAccountToken = "yourtoken";
});

Subsequently, the following commands are not used or supported when using service accounts.

• GetAccounts, GetAccount, AddAccount, UseAccount, ForgetAccount
• SignIn, SignOut

For more information, see the documentation on 1Password Service Accounts.

var onePassword = new OnePasswordManager(serviceAccountToken: token);

Getting all vaults

var vaults = onePassword.GetVaults();

Selecting a specific vault

var vault = vaults.First(x => x.Name == "Private");

Creating an item using a template

var serverTemplate = onePassword.GetTemplate(Category.Server);

serverTemplate.Title = "Your Item's Title";
serverTemplate.Fields.First(x => x.Label == "username").Value = "secretuser";
serverTemplate.Fields.First(x => x.Label == "password").Value = "secretpass";

var serverItem = onePassword.CreateItem(serverTemplate, vault);

Note: If you want to reuse the same template for several items, make sure you clone the instance to avoid reference issues.

var server1 = serverTemplate.Clone();
var server2 = serverTemplate.Clone();

Getting all items in a vault

var items = onePassword.GetItems(vault);

Selecting a specific item

var item = items.First(x => x.Title == "Your Item's Title");

Editing a specific item

item.Fields.First(x => x.Label == "password").Value = "newpass";
onePassword.EditItem(item, vault);

Archiving an item

onePassword.ArchiveItem(item, vault);

Deleting an item

onePassword.DeleteItem(item, vault);

Signing out

onePassword.SignOut();

Running tests

Due to the fact that this library acts as a wrapper for the CLI and in order for tests to have any significant value, the majority of tests are integration tests which must run against an active 1Password account (preferably a Business account).

Effects on the active account

The integration tests will sign in to the specified account, then create and update a test group, a test user (optional), and a test vault. Items will then be created and update in the test vault. Finally, the test vault, user, and group will be deleted. Note: If the integration tests fail, test data may remain in the specified account.

Configuration

The integration tests are configured using the environment variables which are prefixed with OPT_ (OnePassword Tests). Environment variables which are integers must contain only numbers and those which are booleans must contain true or false as a string.