-
-
Notifications
You must be signed in to change notification settings - Fork 6
Features Secrets
Tuck edited this page Jun 28, 2026
·
1 revision
Store, retrieve, and list secrets using the system keyring (Secret Service API / D-Bus).
List available secret collections in the keyring.
deskbrid secrets.list_collectionsNo parameters.
Response:
{
"type": "response",
"status": "ok",
"data": [
{"name": "login", "label": "Login", "locked": false},
{"name": "default", "label": "Default", "locked": false}
]
}Retrieve a secret by its attributes (key-value pairs).
| Parameter | Type | Description |
|---|---|---|
attributes |
map[string,string] | Keyring attributes to match |
deskbrid secrets.get_secret '{"attributes": {"service": "deskbrid", "account": "user"}}'{
"type": "secrets.get_secret",
"attributes": {
"service": "deskbrid",
"account": "user"
}
}Response:
{
"type": "response",
"status": "ok",
"data": {
"attributes": {"service": "deskbrid", "account": "user"},
"secret": "my-api-key-12345",
"label": "Deskbrid API Key",
"collection": "login"
}
}Store a new secret in the keyring.
| Parameter | Type | Description |
|---|---|---|
attributes |
map[string,string] | Keyring attributes |
secret |
string | The secret value to store |
label |
string? | Human-readable label (optional) |
collection |
string? | Collection name (optional, default login) |
deskbrid secrets.store_secret '{"attributes": {"service": "github", "account": "user"}, "secret": "ghp_abc123", "label": "GitHub Token"}'{
"type": "secrets.store_secret",
"attributes": {"service": "github", "account": "user"},
"secret": "ghp_abc123",
"label": "GitHub Token",
"collection": "login"
}from deskbrid import Deskbrid
client = Deskbrid()
# Store a secret
client.secrets_store_secret(
attributes={"service": "my-app", "username": "bot"},
secret="supersecret123",
label="My App Bot Token"
)
# Retrieve
result = client.secrets_get_secret(
attributes={"service": "my-app", "username": "bot"}
)
print(f"Found: {result['label']} = {result['secret'][:4]}...")- D-Bus Secret Service (
org.freedesktop.secrets) — supported by GNOME Keyring, KDE Wallet, KeePassXC, andsecret-tool. - The
secret-toolCLI utility (libsecret) may be used as fallback.
- Secrets are stored encrypted in the system keyring, not in Deskbrid's config.
- Access to the keyring requires the user's keyring to be unlocked.
- Confirmation mode may require approval for secret read/write operations.
Experimental — v1.0.0 feature.
- Accessibility
- Apps
- Audio
- Backlight (LED driver)
- Bluetooth
- Clipboard
- Color Picker
- Desktop Portal
- Desktop Settings
- Files
- Hotkeys
- Input
- Keyboard Layouts
- Media (MPRIS)
- Monitors
- Network
- Notifications
- Print (CUPS)
- Screenshots
- Screen Recording
- Screencast
- Self-Update
- System
- System Tray
- Systemd Units & Timers
- Terminals (PTY)
- Windows & Workspaces