GET SSH Server Groups 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./ServerGroups/Access/{id} method is used to retrieve Linux logons for an SSH server group, along with any users or service accounts mapped to those logons, from Keyfactor Command for the specified server group GUID. 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.

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.

Table 782: GET SSH Server Groups Access {id} Input Parameters

Name In Description
id Path Required. A string indicating the Keyfactor Command reference GUID for the SSH server group for which to retrieve logon and user mappings.

Use the GET /SSH/ServerGroups method (see GET SSH Server Groups) to retrieve a list of all the SSH server groups to determine the server group's ID.

Table 783: GET 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 API Reference and Utility which provides a utility through which 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. 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 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. 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.