PUT SSH Server Groups

The PUT /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 operation updates an existing SSH server groups defined in Keyfactor Command. On success, the operation returns HTTP 200 OK with  details for the updated 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.

Important:  This operation replaces the entire record. Any fields not included in the request are cleared or set to their default values.

To avoid unintended data loss, first perform a GET to retrieve the existing record, update only the required fields, and then submit the full set of values in the PUT request.

Table 904: PUT SSH Server Groups Input Parameters

Name In

Description
ID Body A string indicating the Keyfactor Command reference GUID for the SSH server group. This GUID is automatically set by Keyfactor Command.
OwnerName Body Required. A string indicating the Active Directory user who owns the server group (in DOMAIN\\username format). The owner can only be set by a Keyfactor Command user with the SSH Enterprise Admin role. See SSH Server Group Operations for more information.
Tip:  Notice that the field name and structure returned on a GET is not the same as that used on a POST and PUT for the server group owner.
GroupName Body Required. A string indicating the name of the SSH server group.
SyncSchedule Body

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"
   }
}

The default is unset.
UnderManagement Body A Boolean indicating whether the SSH server group is in inventory only mode (False) or inventory and publish policy mode (True). The default is False.

Table 905: PUT SSH Server Groups Response Data

Name In

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

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

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 Body A Boolean indicating whether the SSH server group is in inventory only mode (False) or inventory and publish policy mode (True).
ServerCount Body 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.