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 operation creates a mapping of one or more Linux logons to Keyfactor Command users or service accounts for one or more SSH server groups. On success, the operation returns HTTP 200 OK with  details of the logons and associated users, if applicable, for the specified SSH server groups.

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.

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 908: POST SSH Server Groups Access Input Parameters

Name In Description
ServerGroupId Body Required. A string indicating the Keyfactor Command reference GUID for the SSH server group.
LogonUsers Body

Required. An array of objects containing information for the Linux logons to update. ClosedShow logon user information.

For example:

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

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

Name Description
ServerGroupId A string indicating the Keyfactor Command reference GUID for the SSH server group.
LogonUsers

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