Skip to main content

list

The list command retrieves an array of objects from your safe:

bsafe list (items|folders|collections|organizations|org-collections|org-members) [options]

Options for the list command are filters used to dictate what will be returned, including:

  • --url <url>

  • --folderid <folderid>

  • --collectionid <collectionid>

  • --organizationid <organizationid>

  • --trash

Any filter will accept null or notnull. Combining multiple filters in one command will perform a logical OR operation; for example, the following command returns items that are not in a folder or collection.

bsafe list items --folderid null --collectionid null

Additionally, you can search for specific objects using --search <search-term>. Combining filter and search in one command will perform a logical AND operation. For example, the following command searches for items with the string github in the specified folder:

bsafe list items --search github --folderid 9742101e-68b8-4a07-b5b1-9578b5f88e
In this section: