GET SSH Server Groups ID

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./ServerGroups/{id} operation retrieves an SSH server group with the specified GUID from Keyfactor Command. On success, the operation returns HTTP 200 OK with  details for the specified SSH server group.

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 and limited for users with only the Server Admin (/ssh/server_admin/) role. For more information, see SSH Permissions.

Table 894: GET SSH Server Groups {id} Input Parameters

Name In Description
id Path Required. A string indicating the Keyfactor Command reference GUID for the SSH server group to be retrieved.

Use the GET SSH Server Groups operation to retrieve a list of all the SSH server groups to determine the server group's GUID.

Table 895: GET SSH Server Groups {id} Response Data

Name

Description
ID A string indicating the Keyfactor Command reference GUID for the SSH server group. This GUID is automatically set by Keyfactor Command.
Owner

An object indicating the Active Directory user who owns the server group. See SSH Server Group Operations for more information. ClosedShow owner details.
GroupName A string indicating the name of the SSH server group.
SyncSchedule

An object providing the inventory schedule for the SSH server group. The schedule can be off (unset) or one of the supported values. ClosedShow schedule details.

For example:

Copy 
"SyncSchedule": {
   "Weekly": {
      "Days": [
         "Monday",
         "Wednesday",
         "Friday"
      ],
      "Time": "2022-11-20T14:00:00Z"
   }
}
UnderManagement A Boolean indicating whether the SSH server group is in inventory only mode (False) or inventory and publish policy mode (True).
ServerCount An integer indicating the number of SSH servers that belong to the server group.
Tip:  See 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.