POST SSH Server Groups Access

The POST /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/Access method is used to create a mapping of one or more Linux logons to Keyfactor Command users or service accounts for one or more SSH server groups. This method returns HTTP 200 OK on a success with details of the logons and associated users, if applicable, for the specified SSH server group(s).

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 and limited for users with only the ServerAdmin role. For more information, see SSH Permissions in the Keyfactor Command Reference Guide.

Tip:  Before creating a logon to user mapping, be sure that you have switched the server group to which you will add your mapping to inventory and publish policy mode so that the key for the user will be published to the servers in the group. If the server group is in inventory only mode and you add a mapping for it in Keyfactor Command, the mapping will appear in Keyfactor Command only and the key for the user will not be published out to the servers.

Table 538: POST SSH Server Groups Access Input Parameters

Name In Description
ServerGroupId Body Required. The Keyfactor Command reference ID for the SSH server group.
LogonUsers Body

Required. An array containing information for the Linux logon(s) to update. ClosedShow logon user information.

For example:

"LogonUsers": [
   {
      "LogonName": "johns",
      "Users": [
         "KEYEXAMPLE\\jsmith"
      ]
   }
]

Table 539: POST SSH Server Groups Access {id} Response Data

Name Description
ServerGroupId The Keyfactor Command reference GUID for the SSH server group.
LogonUsers

An array containing information for the Linux logons from the Linux server that have been stored in Keyfactor Command. ClosedShow logon user information.
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.