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:
| Heading | Data Type | Description |
|---|---|---|
| PasswordListID | Integer | Unique identifier for the Password List Read-only: 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 (All files are stored in the /images/lookupimages folder for the Passwordstate web install). |
| Guide | String (NA) | Any associated instructions (guide) for how the Password List should be used (Can contain HTML characters). |
| AllowExport | Boolean | Indicates whether users are able to export Passwords from the Password List through the web interface. |
| PrivatePasswordList | Boolean | Indicates whether the Password List is Private only to the user who created the Password List. |
| TimeBasedAccessRequired | Boolean | Indicates whether Time-based Access settings are required when applying new permissions to this Password List. |
| NoApprovers | String | The number of approvers require to approve access to the Password List. |
| DisableNotifications | Boolean | If email notifications for the Password List like Copy To Clipboard, Password Updated, etc, are disabled. |
| PasswordStrengthPolicyID | Integer | The ID value representing the Password Strength Policy settings associated with this Password List (derived from the PasswordStrengthPolicies table). |
| PasswordGeneratorID | Integer | The ID value representing the Password Generator settings associated with this Password List (derived from the PasswordGenerators table). |
| CodePage | String () | Indicates the character-set associated with the Password List (used when importing and exporting data from the List). Reference for code page options can be found here - Code Page Identifiers. |
| PreventPasswordReuse | Integer | If a value other than 0 (zero) is specified, the user will not be able to re-use the last (x) number of Password values for a given Password object. |
| AuthenticationType | Integer | Indicates whether an additional authentications step is required prior to users being able to access the Password objects stored in the Password List. Possible values are: |
| 0 - None Required | ||
| 1 - Use Separate Password | ||
| 2 - Use Active Directory Authentication | ||
| 3 - Use ScramblePad Authentication | ||
| 4 - Use Forms Based Authentication | ||
| AuthenticationPerSession | Boolean | When set to true, any addition Authentication settings specified above will only need to be satisfied once during the users web session. If set to False, every access to the Password List will require re-authentication. |
| PreventExpiryDateModification | Boolean | When set to true, only Administrators of the Password List will be able to make modifications to the ExpiryDate field for Password objects. |
| ResetExpiryDate | Integer | Indicates the number of days which will be added to the ExpiryDate field for Passwords when the Password object is updated (specify 0 means the ExpiryDate field will not be updated). |
| PreventDragDrop | Boolean | When set to true, only Administrators of the Password List are able drag-n-drop the Password List around in the Navigation Tree |
| PreventBadPasswordUse | Boolean | When set to true, the user will not be able to saving Password if a 'Bad Password' is detected (Bad Passwords settings and values are controlled by the Security Administrators of Passwordstate). |
| ProvideAccessReason | Boolean | Indicates whether the user must manually specify the reason why they need access to a Password resource - will prompt them for input via they web interface when they wish to view/edit/update the Password. |
| TreePath | String (NA) | Represents the hierarchical tree structure the Password List is organized within. Read-only: Calculated field. |
| TotalPasswords | Integer | Represents the total number of Passwords stored in the Password List. Read-only: Calculated field. |
| GeneratorName | String (NA) | The name of the Password Generator associated with the Password List (derived from the PasswordStrengthPolicies table). Read-only: Data extracted from different table. |
| PolicyName | String (NA) | The name of the Password Strength Policy associated with the Password List (derived from the PasswordStrengthPolicies table). Read-only: Data extracted from different table. |
| PasswordResetEnabled | Boolean | Indicates whether the passwords stored in the Password List can be configured to perform resets on remote systems. |
| ForcePasswordGenerator | Boolean | Indicates the selected Password Generator Policy for the Password List is the only one which can be used to generate random passwords |
| HidePasswords | String | Indicates that password values in the User Interface will be hidden, so they cannot be viewed or copied to the clipboard. This setting is based on the Permissions the User has to the Password List or Password Record, with the following example value meaning that the password is not hidden for View access, is hidden for Modify access, and is not hidden for Admin access - false:true:false |
| ShowGuide | Boolean | If set to True, the Guide will popup in the User Interface every time a user accesses the Password List. |
| EnablePasswordResetSchedule | Boolean | Provides the default value for enabling a schedule for resets for all new password records added to the Password List. |
| PasswordResetSchedule | String (NA) | Provides the default value for the schedule of password resets for all new password records added to the Password List. |
| AddToExpiryDate | Integer | Provides the default value for adding (x) number of days or months to the ExpiryDate field for all new password records added to the Password List. Use the field AddToExpiryDateInterval below to specify Days or Months. |
| AddToExpiryDateInterval | Integer | Provides the default value for specify Days or Months in conjunction with the field AddToExpiryDate above, when new password records added to the Password List. |
| OneTimePasswords | Boolean | When enabled, the password record will show additional fields for generating One-Time Passwords, as per the TOTP standard. |