Host Folders Overview ​
Multiple methods are available with the API to query for Host Folders which are already added to Passwordstate, or to add/delete Host Folder records, and/or permissions.
Host Folder records in Passwordstate are primarily used for the Remote Session Launcher features. Granting access to Host Folders does not specifically give the user access to launch remote sessions - the user must have appropriate access rights to Password records, or Remote Session Credentials.
| Heading | Data Type | Mandatory | Description |
|---|---|---|---|
| FolderID | Integer | The database ID for the Host Folder entry | |
| FolderName | String (200) | Yes | The name of the Host Folder |
| PropagatePermissions | Boolean | No | Indicates whether the Folder will be configured to propagate permission down to any nested folders |
| Description | String (255) | No | A description for the Host Folder |
| HostNameMatch | String | No | Used to add appropriate Host records under the Host Folder during the creation of the Folder i.e. any matching Host records based on the Host Name field**** |
| TagMatch | String | No | Used to add appropriate Host records under the Host Folder during the creation of the Folder i.e. any matching Host records based on the Tag field |
| HostType | String | No | Used to add appropriate Host records under the Host Folder during the creation of the Folder i.e. any matching Host records based on the Host Type field |
| OperatingSystems | String | No | Used to add appropriate Host records under the Host Folder during the creation of the Folder i.e. any matching Host records based on the Operating System field |
| DatabaseServerType | String (200) | No | Used to add appropriate Host records under the Host Folder during the creation of the Folder i.e. any matching Host records based on the Database Server Type field |
| Guide | String | No | Any description to explain the purpose of the Host Folder record |
| NestUnderFolderID | Integer | No | You can specify a FolderID, of another Host Folder, that you would like the newly created Host Folder to be nested beneath. If you want the Host Folder to be created in the root of the Hosts tree, then you can specify the value of "0", or omit this parameter altogether |
| SiteID | Integer | No | The SiteID the Host Folder record belongs to (SiteID of 0 for site of type Internal). |