Help Search


The API allows you to create, delete, and update your passwords. You can retrieve individual passwords as well as a list of all your passwords.

In passbolt, passwords are split into two different entities: Resources and Secrets. Passwords metadata are internally known as Resources and are represented as one object containing the name, username, the URL amongst other fields.

The actual password is part of the Secrets entity. It can be accessed via the Resource object association or individually. In any case the access will be logged in the system.

The Resource object

Attribute Type Description Format
id String Unique ID of the resource in UUID format. UUID
created String Datetime when the resource was created ISO 8601Datetime format
created_by String UUID of the user who created the resource UUID
creator Object Object containing the user details of the creator Check User object
deleted Boolean Whether the resource has been deleted true/false
description String Resource description
favorite Object Favorite details of the resource Check Favorite object
modified String Datetime when the resource was last modified ISO 8601 Datetime format
modified_by String UUID of the user who last modified the resource UUID
modifier Object Object containing the user details of the modifier Check User object
name String Resource Name
permission Object Permission details as applied on the resource Check Permission object
uri String URL/URI for this login
username String Username to be used for this login

Last updated

This article was last updated on April 23rd, 2019.

If you are familiar with the high level API concepts and only looking for the endpoint implementation details, there is a repository with the latest OpenAPI 2.0 specifications (compatible with Swagger).

OpenAPI Specs