POST SSH Logons 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./Logons/Access operation associates one or more SSH keys with a Linux logon by mapping the logon to one or more users or service accounts. On success, the operation returns HTTP 200 OK with  a list of the users associated with the logon.

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

Table 874: POST SSH Logons Access Input Parameters

Name In Description
LogonId Body

Required. An integer indicating the Keyfactor Command reference ID for the SSH logon.

Use the GET SSH Logons operation to retrieve a list of all the SSH logons to determine the logon's ID.
UserIds Body

An array of integers indicating the Keyfactor Command reference IDs for the users and/or service accounts with which the logon should be associated, provided in the following format:

[4,7,19]

Use the GET SSH Users operation to retrieve a list of all the users (including service accounts) created in Keyfactor Command to determine a user's ID.

See SSH for more information about users and service accounts.

Table 875: POST SSH Logons Access Response Data

Name Description
LogonId An integer indicating the Keyfactor Command reference ID for the SSH logon.
LogonName

A string indicating the user's logon name on the Linux server.
Users

An array of objects providing information about the users mapped to the logon. ClosedShow 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.