Passbolt.Api 1.0.44

Passbolt.Api

Typed .NET client primitives for integrating with the Passbolt API in a safe, testable, and DI-friendly way. Targets the Passbolt REST API v2 (the JSON endpoints, e.g. /resources.json).

Installation

dotnet add package Passbolt.Api

Quick Start

using Passbolt.Api;

var options = new PassboltClientOptions
{
    Uri = new Uri("https://passbolt.example.com"),
    Username = "user@example.com",
    Password = "password",
    PrivateKeyBlock = "-----BEGIN PGP PRIVATE KEY BLOCK-----\n..."
};

using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30));
using var client = new PassboltClient(options);

// Get server status
var status = await client.Status.GetStatusAsync(cts.Token);
Console.WriteLine($"Passbolt status: {status.Status}");

// List all resources
var resources = await client.Resources.GetAllAsync(cts.Token);
foreach (var resource in resources.Value)
{
    Console.WriteLine($"Resource: {resource.Name} (ID: {resource.Id})");
}

API responses are wrapped in a Response<T> envelope — the payload is on .Value, with metadata on .Header.

Command-line tool (Passbolt.Cli)

The same client also ships as a cross-platform command-line tool, installable as a .NET global tool:

dotnet tool install --global Passbolt.Cli

This installs a passbolt command. Configure it once (the passphrase is never stored):

passbolt configure --server https://passbolt.example.com --username user@example.com --private-key-file ~/.passbolt/private.asc

Connection settings resolve in the order option → environment variable → config file, with the private key falling back to ~/.passbolt/private.asc. Environment variables: PASSBOLT_SERVER, PASSBOLT_USERNAME, PASSBOLT_PASSWORD, PASSBOLT_PRIVATE_KEY_FILE.

# Server + identity
passbolt status
passbolt whoami

# Browse (add --json to any command for machine-readable output)
passbolt resource list
passbolt resource get <id>
passbolt user list
passbolt group get <id>
passbolt folder list
passbolt role list
passbolt permission list --resource <id>

# Manage (non-secret writes)
passbolt user create --email new@example.com --first-name Ada --last-name Lovelace
passbolt user update <id> --last-name Byron
passbolt group create --name "Engineering" --manager <user-id>
passbolt group add-member <group-id> --user <user-id> --admin
passbolt folder create --name "Shared" --parent <folder-id>
passbolt resource update <id> --name "New name" --uri https://example.com
passbolt resource delete <id> --yes

# Governance: flag resources with fewer than two owners or no group owner
passbolt audit ownership
passbolt audit ownership --min-owners 2 --json

Command coverage

Not yet supported: creating a resource, rotating a resource's secret, and sharing (which re-encrypts the secret for new recipients) all require encrypting the secret to each recipient's PGP public key. That secret-encryption capability is being added to Passbolt.Api first — see issue #31.

Every command accepts --server/-s, --username/-u, --password/-p, --private-key-file/-k, --config/-c and --json/-j. In --json mode stdout carries only JSON (status text goes to stderr), so it pipes cleanly into jq.

Features

Library

• Strongly-typed PassboltClient for intuitive API access
• Refit-backed REST API interface for seamless HTTP endpoint mapping
• Built-in support for Passbolt's PGP authentication flow
• Async/await support throughout
• Dependency injection compatible design

CLI (Passbolt.Cli)

• Installable as a .NET global tool (passbolt)
• Cobra-style subcommands with rich help
• Human-friendly tables and clean --json for scripting/jq
• Config file + environment variables + per-command options
• Ownership audit that flags under-owned resources — a governance view not offered by the reference Go CLI

Quality

• Built with TreatWarningsAsErrors
• Nullable reference types enabled
• XML documentation generated
• CI validates restore, build, test, and package output

Supported Endpoints

Core Entities

• Status: Server status and healthcheck information
• Users: CRUD operations and listing for user management
• Groups: CRUD operations and listing for group management
• Resources: CRUD operations, listing, searching by name/URI, and resource sharing
• Folders: CRUD operations and listing for folder management

Related Features

• Comments: Create, read, and delete comments on resources
• Permissions: Query and filter permissions by resource or user
• Roles: List available roles and retrieve role details
• Avatars: Retrieve user profile images
• Me: Access current authenticated user's profile information

Links

• NuGet: https://www.nuget.org/packages/Passbolt.Api
• GitHub: https://github.com/panoramicdata/Passbolt.Api
• Issues: https://github.com/panoramicdata/Passbolt.Api/issues

Acknowledgements & related projects

• Passbolt — the open-source password manager this client talks to. 💙
• passbolt/go-passbolt and passbolt/go-passbolt-cli — the excellent, mature Go SDK and CLI. They're the reference implementation we learned from, and remain the go-to for Go users. Passbolt.Api/Passbolt.Cli exist to give the .NET ecosystem a first-class, idiomatic option — with a bit of friendly cross-language rivalry. 🤝

Trademarks & disclaimer

Passbolt and the Passbolt logo are registered trademarks of Passbolt S.A. This project is community maintained and is not affiliated with, endorsed by, or sponsored by Passbolt S.A.

The Passbolt name appears in this repository, in the package identifiers and in this documentation only nominatively — to describe compatibility with the Passbolt API — consistent with Passbolt's Trademark Guidelines. No official status is claimed or implied, and no Passbolt S.A. branding, logo or visual identity is used.

License

MIT - see LICENSE.