list_keys Method

Lists keys in the currently-selected vault.

Syntax

def list_keys() -> None: ...

Remarks

This method lists the keys in the currently-selected vault. If the GetDeleted configuration setting is enabled, it lists the soft-deleted keys in the vault instead.

Calling this method will fire the on_key_list event once for each key, and will also populate the Key* properties. However, note that by default the following properties will not be populated, since the server does not return full information for keys when listing them. The include_key_details property can be enabled to have the class attempt to retrieve full information for each key; refer to its documentation for more information.

• key_ops
• key_type
• key_public_key
• key_version_id

If there are still more keys available to list when this method returns, the key_marker property will be populated. Continue to call this method until key_marker is empty to accumulate all pages of results in the Key* properties.

The MaxKeys configuration setting can be used to control the maximum number of results to return at once.