Basic Parameters
| Parameter | Description |
|---|---|
| Apply Permission For Security Group By ID | The ID of the security group that will be given permission to the newly created password list. |
| Apply Permission For Security Group By Name | The name of the security group that will be given permission to the newly created password list. |
| Apply Permissions | Select whether to apply permissions for a user or a security group. |
| Apply Permissions For User By ID | The ID of the user who will be granted permissions to the newly created password list. |
| Copy Permissions From Password List By ID | The ID of an existing password list to copy it’s permissions settings to the new password list. |
| Copy Permissions From Template By ID | The ID of an existing password template to copy it’s permissions settings to the new password list. |
| Description | The description of the new password list to create. |
| Folder ID | The ID of the folder or password list where the password list will be stored. Note: If not specified, the password list will be created in the root of the navigation tree - which is equivalent to the value of 0. |
| Guide | Instructions or notes describing the intended purpose or usage guidelines for the password list. |
| Link To Template | Select to link the password list to an existing password list template. Note: If you select this option, then you must use the Copy Settings From Template By ID parameterand not use the Copy Settings From Password List By ID parameter. |
| Password List Name | The name of the new password list to create. |
| Permissions | Apply permissions for a newly created password list. |
| Permissions Method | Choose the method used to set permissions to the password list. |
| Private Password List | Set to true to create a private password list instead of a shared one. |
| Site ID | The site location where the password list will be stored. All SiteIDs can be referenced on the screen Administration -> Remote Site Administration -> Remote Site Locations Note: If not specified, the default location ‘Internal’ will be used - which is equivalent to the value of 0. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Copy Settings From Password List By ID | The ID of an existing password list from to copy settings and field configurations from. |
| Copy Settings From Template By ID | The ID of an existing password template from to copy settings and field configurations from. |
| Image File Name | A file name of an image to associate with the password list. Note: All image file names can be found in Administration -> Passwordstate Administration -> Images and Account Types. |
Example Output
[
{
"PasswordListID": 27,
"PasswordList": "Web Site's",
"Description": "Various web sites on the net",
"ImageFileName": "website.png",
"Guide": "",
"AllowExport": true,
"PrivatePasswordList": false,
"TimeBasedAccessRequired": false,
"NoApprovers": "1",
"DisableNotifications": false,
"PasswordStrengthPolicyID": 7,
"PasswordGeneratorID": 1,
"CodePage": "Unicode (UTF-8)",
"PreventPasswordReuse": 5,
"AuthenticationType": "None Required",
"AuthenticationPerSession": false,
"PreventExpiryDateModification": false,
"SetExpiryDate": 0,
"ResetExpiryDate": 0,
"PreventDragDrop": true,
"PreventBadPasswordUse": true,
"ProvideAccessReason": true,
"TreePath": "\\ISP Accounts",
"TotalPasswords": 23,
"GeneratorName": "Default Password Generator",
"PolicyName": "SQL Server Policy",
"PasswordResetEnabled": false,
"ForcePasswordGenerator": false,
"HidePasswords": "false:false:false",
"ShowGuide": false,
"EnablePasswordResetSchedule": false,
"PasswordResetSchedule": "05:30",
"AddToExpiryDate": 120,
"AddToExpiryDateInterval": "Days",
"OneTimePasswords": false
}
]