GET SSH Servers Access 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./Servers/Access/{id} method is used to retrieve Linux logons for an SSH server, along with any users or service accounts mapped to those logons, from Keyfactor Command for the specified server ID. This method returns HTTP 200 OK on a success with details of the logons and associated users, if applicable, for the specified SSH server.

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

Table 690: GET SSH Servers Access {id} Input Parameters

Name In Description
id Path Required. An integer indicating the Keyfactor Command reference ID for the SSH server for which to retrieve logon and user mappings.

Use the GET /SSH/Servers method (see GET SSH Servers) to retrieve a list of all the SSH servers to determine the server's ID.

Table 691: GET SSH Servers Access {id} Response Data

Name Description
ServerId An integer indicating the Keyfactor Command reference ID for the SSH server.
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 API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.