Password Lists ​
The Password List is the basic object around which many operations in Passwordstate are centered. A Password List represents a collection of related password objects, and has many associated settings which can modify the behavior of interacting with the Password List.
Password Lists have a rich set of metadata associated with them, some of which are exposed via the API. Here are the accessible fields on a Password List:
| Fields | Data Type | Description | Read-Only |
|---|---|---|---|
| PasswordListID | Integer | Unique identifier for the Password List | The time at which the Password List was created. |
| PasswordList | String (200) | A title to describe the nature of the Password List | |
| Description | String (255) | A longer verbose description of the nature of the Password List | |
| ImageFileName | String (50) | The filename of an image associated with the Password Lists | |
| Guide | String (NA) | Any associated instructions (guide) for how the Password List should be used | |
| AllowExport | Boolean | Indicates whether users are able to export Passwords from the Password List | |
| PrivatePasswordList | Boolean | Indicates whether the Password List is Private only to the user who created it | |
| TimeBasedAccessRequired | Boolean | Indicates whether Time-based Access settings are required for new permissions | |
| NoApprovers | String | The number of approvers required to approve access to the Password List | |
| DisableNotifications | Boolean | If email notifications for the Password List are disabled | |
| PasswordStrengthPolicyID | Integer | The ID value representing the Password Strength Policy settings | |
| PasswordGeneratorID | Integer | The ID value representing the Password Generator settings | |
| CodePage | String | Indicates the character-set associated with the Password List | |
| PreventPasswordReuse | Integer | Number of previous Password values that cannot be reused | |
| AuthenticationType | Integer | Indicates whether an additional authentication step is required | |
| AuthenticationPerSession | Boolean | When true, additional authentication is required only once per session | |
| PreventExpiryDateModification | Boolean | When true, only Administrators can modify the ExpiryDate field | |
| ResetExpiryDate | Integer | Number of days added to ExpiryDate when Password object is updated | |
| PreventDragDrop | Boolean | When true, only Administrators can drag-n-drop the Password List in the Navigation Tree | |
| PreventBadPasswordUse | Boolean | When true, users cannot save Passwords if a 'Bad Password' is detected | |
| ProvideAccessReason | Boolean | Indicates whether users must specify a reason for accessing a Password resource | |
| TreePath | String (NA) | Represents the hierarchical tree structure the Password List is organized within | Calculated field |
| TotalPasswords | Integer | Represents the total number of Passwords stored in the Password List | Calculated field |
| GeneratorName | String (NA) | The name of the Password Generator associated with the Password List | Data extracted from different table |
| PolicyName | String (NA) | The name of the Password Strength Policy associated with the Password List | Data extracted from different table |
| PasswordResetEnabled | Boolean | Indicates whether passwords can be configured to perform resets on remote systems | |
| ForcePasswordGenerator | Boolean | Indicates if the selected Password Generator Policy is the only one that can be used | |
| HidePasswords | String | Indicates that password values in the User Interface will be hidden | |
| ShowGuide | Boolean | If true, the Guide will popup every time a user accesses the Password List | |
| EnablePasswordResetSchedule | Boolean | Default value for enabling a schedule for resets for new password records | |
| PasswordResetSchedule | String (NA) | Default value for the schedule of password resets for new password records | |
| AddToExpiryDate | Integer | Default value for adding days or months to ExpiryDate for new password records | |
| AddToExpiryDateInterval | Integer | Specifies Days or Months for AddToExpiryDate field | |
| OneTimePasswords | Boolean | When enabled, shows additional fields for generating One-Time Passwords (TOTP standard) |