GET SSH Logons

The GET /SSHClosed The SSH (secure shell) protocol provides for secure connections between computers. It provides several options for authentication, including public key, and protects the communications with strong encryption./Logons method is used to retrieve one or more Linux logons. Results can be limited to selected logons using filtering, and URL parameters can be used to specify paging and the level of information detail. This method returns HTTP 200 OK on a success with details for the requested SSH logons.

Tip:  The following permissions (see Security Overview) are required to use this feature:

SSH: ServerAdmin OR
SSH: EnterpriseAdmin

SSH actions are affected by ownership on the server group to which the server on which the logon exists belongs and limited for users with only the ServerAdmin role. For more information, see SSH Permissions in the Keyfactor Command Reference Guide.

Table 500: GET SSH Logons Input Parameters

Name In Description
queryString Query

A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the APIClosed A set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to the Keyfactor Command Reference Guide: Using the Logons Search. The query fields supported for this endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. are:

  • Id (Login ID)

  • LastLogon

  • Hostname (Logon Server Name)

  • LogonUserUsername

  • ServerId

  • UnmanagedKeyId

  • Username

pageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
returnLimit Query An integer that specifies how many results to return per page. The default is 50.
sortField Query A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is Username.
sortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 501: GET SSH Logons Response Data

Name Description
ID An integer indicating the Keyfactor Command reference ID for the SSH logon.
Username

A string indicating the user's logon name on the Linux server.
ServerId An integer indicating the Keyfactor Command reference ID of the server on which the SSH logon resides.
ServerName A string indicating the hostnameClosed The unique identifier that serves as name of a computer. It is sometimes presented as a fully qualified domain name (e.g. servername.keyexample.com) and sometimes just as a short name (e.g. servername). of the SSH server on which the SSH logon resides. See SSH Servers in the Keyfactor Command Reference Guide for more information.
GroupName A string indicating the server group to which the server referenced by ServerName belongs. See SSH Server Groups in the Keyfactor Command Reference Guide for more information.
ServerUnderManagement A Boolean indicating whether the server on which the SSH logon resides is in inventory only mode (false) or inventory and publish policy mode (true).
KeyCount An integer indicating the number of SSH keys associated with the Linux logons.
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.