DELETE SSH Servers Access

The DELETE /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./Servers/Access method is used to remove a mapping of Keyfactor Command users or service accounts to one or more Linux logons on one or more SSH servers. This method returns HTTP 200 OK on a success with details of the logons and remaining associated users, if applicable, for the specified SSH server(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 to which the server belongs and limited for users with only the ServerAdmin role. For more information, see SSH Permissions in the Keyfactor Command Reference Guide.

Tip:  Before deleting a logon to user mapping, be sure that you have switched the server from which you will removing your mapping (or its server group) to inventory and publish policy mode so that the key for the user will be removed from the server. If the server is in inventory only mode and you remove a mapping for it in Keyfactor Command, the mapping will be removed in Keyfactor Command only and the key for the user will not be removed from the server.

Table 518: DELETE SSH Servers Access Input Parameters

Name In Description
ServerId Body Required. The Keyfactor Command reference ID for the SSH server.
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 519: DELETE SSH Servers Access Response Data

Name Description
ServerId An integer indicating the Keyfactor Command reference ID for the SSH server.
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.