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. Query parameters enable filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. This method returns HTTP 200 OK on a success with details for the requested SSH logons.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/ssh/server_admin/
OR
/ssh/enterprise_admin/

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 Server Admin (/ssh/server_admin/) role. For more information, see SSH Permissions.

Table 754: 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 API 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: Using the Logons Search. The query fields supported for this endpoint 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. Very large values can result in long processing time.
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 755: 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 hostname of the SSH server on which the SSH logon resides. See SSH Server Operations for more information.
GroupName A string indicating the server group to which the server referenced by ServerName belongs. See SSH Server Group Operations 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:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed An API is 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.