Remote Session Credentials ​
Multiple methods are available with the API to query Remote Session Credentials which already exist in Passwordstate, or to add/update/delete Remote Session Credentials records, and/or permissions.
Remote Session Credential records in Passwordstate are used for the Remote Session Launcher features, allowing users to launch remote sessions and log in to hosts automatically without manual authentication.
To manage Remote Session Credential records via the API, you must be using the 'Remote Session Credentials' API Key from the screen Administration -> System Settings -> API tab. APIKey can be specified either in the Header Request, or in the HTTP body.
| Heading | Data Type | Mandatory | Description |
|---|---|---|---|
| CredentialID | Integer | The database ID for the Remote Session Credential entry | |
| Description | String (255) | Yes | A description for the Remote Session Credential entry |
| HostName | String (1000) | No | A wildcard match for Host Names you wish to use the Remote Session Credential with. Examples are: win2k12server1 (single host), or wildcard matches like win2k12* or ServerName*Win. Multiple hosts matches can be comma separated. |
| HostNameExclude | String (1000) | No | Similar to HostName field above, but this parameter will exclude certain Hosts from being used with the Remote Session Credential |
| HostType | String | No | The Host Types you wish to use with the Remote Session Credential i.e. Firewall, Linux, Out-of-Band-Management, Router, Switch, Unix, Windows |
| OperatingSystem | String | No | The Operating System types you wish to use with the Remote Session Credential - see the screen Administration -> Host Types & Operating Systems for a full list |
| RemoteConnectionType | String (50) | No | The Remote Connection Type you wish to use with the Remote Session Credential i.e. RDP, SSH, Teamviewer, Telnet, VNC, SQL |
| PasswordID | Integer | No | The PasswordID value of the password record you wish to use to login with for the Remote Session Credential |
| SiteID | Integer | No | The SiteID the Remote Session Credential record belongs to (SiteID of 0 for site of type Internal). |