The SSH
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. component of the Keyfactor API 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. includes methods necessary to create, update, and delete SSH keys, logons, servers, server groups, and service accounts within Keyfactor Command.
Table 650: SSH Endpoints
|
Endpoint |
Method |
Description |
Link |
|---|---|---|---|
|
/Keys/Unmanaged/{id} |
DELETE |
Delete a discovered unmanaged SSH key for the specified ID. |
DELETE SSH Keys Unmanaged ID |
|
/Keys/Unmanaged/{id} |
GET |
Retrieve details for a discovered unmanaged SSH key for the specified ID. |
GET SSH Keys Unmanaged ID |
|
/Keys/MyKey |
GET |
Retrieve details for a user's SSH key generated through Keyfactor Command. |
GET SSH Keys My Key |
|
/Keys/MyKey |
POST |
Generate a new SSH key pair for a user through Keyfactor Command. |
POST SSH Keys My Key |
|
/Keys/MyKey |
PUT |
Update an SSH key for a user through Keyfactor Command. |
PUT SSH Keys My Key |
| /Keys/Unmanaged | DELETE | Delete one or more discovered unmanaged SSH keys based on a selection query. | DELETE SSH Keys Unmanaged |
| /Keys/Unmanaged | GET | Retrieve details for one or more discovered unmanaged SSH keys based on a selection query. | GET SSH Keys Unmanaged |
|
/Logons/{id} |
DELETE |
Deletes a Linux logon from Keyfactor Command. |
DELETE SSH Logons ID |
|
/Logons/{id} |
GET |
Returns information about a Linux logons. |
GET SSH Logons ID |
|
/Logons/ |
GET |
Returns information about one or more Linux logons. |
GET SSH Logons |
|
/Logons/ |
POST |
Creates a new Linux logon in Keyfactor Command and, for servers in inventory and publish policy mode, publishes it out to a Linux server. |
POST SSH Logons |
|
/Logons/Access |
POST |
Maps users and service accounts with a Linux logon to associate the SSH keys of the users with the Linux logon. |
POST SSH Logons Access |
|
/Servers/{id} |
DELETE |
Deletes the SSH server with the specified ID. | DELETE SSH Servers ID |
|
/Servers/{id} |
GET |
Returns the SSH server with the specified ID. | GET SSH Servers ID |
| /Servers/Access/{id} | GET | Retrieves Linux logons along with users and service accounts granted access to those logons for the specified SSH server. | GET SSH Servers Access ID |
|
/Servers/ |
GET |
Returns a list of a SSH servers configured in Keyfactor Command. | GET SSH Servers |
|
/Servers/ |
POST |
Creates a new SSH server. | POST SSH Servers |
|
/Servers/ |
PUT |
Updates an existing SSH server. | PUT SSH Servers |
| /Servers/Access | DELETE | Deletes Linux logon to user and service account mappings for an SSH server. | DELETE SSH Servers Access |
| /Servers/Access | POST | Creates Linux logon to user and service account mappings for an SSH server. | POST SSH Servers Access |
|
/ServerGroups/{id} |
DELETE |
Deletes the SSH server group with the specified ID. | DELETE SSH Server Groups ID |
|
/ServerGroups/{id} |
GET |
Returns the SSH server group with the specified ID. | GET SSH Server Groups ID |
| /ServerGroups/{name} | GET | Returns the SSH server group with the specified name. | GET SSH Server Groups Name |
| /ServerGroups/Access/{id} | GET | Retrieves Linux logons along with users and service accounts granted access to those logons for the specified SSH server group. | GET SSH Server Groups Access ID |
|
/ServerGroups/ |
GET |
Returns a list of a SSH server groups configured in Keyfactor Command. | GET SSH Server Groups |
|
/ServerGroups/ |
POST |
Creates a new SSH server group. | POST SSH Server Groups |
|
/ServerGroups/ |
PUT |
Updates an existing SSH server group. | PUT SSH Server Groups |
| /ServerGroups/Access | DELETE | Deletes Linux logon to user and service account mappings for an SSH server group. | DELETE SSH Server Groups Access |
| /ServerGroups/Access | POST | Creates Linux logon to user and service account mappings for an SSH server group. | POST SSH Server Groups Access |
|
/ServiceAccounts/{id} |
DELETE |
Deletes the SSH service account with the specified ID. | DELETE SSH Service Accounts ID |
| /ServiceAccounts/{id} | GET | Returns the SSH service account with the specified ID. | GET SSH Service Accounts ID |
| /ServiceAccounts/Key/{id} | GET | Returns the public key and optional private key of an SSH service account with the specified ID. | GET SSH Service Accounts Key ID |
|
/ServiceAccounts/ |
DELETE |
Deletes one or more SSH service accounts with the specified IDs. | DELETE SSH Service Accounts |
|
/ServiceAccounts/ |
GET |
Returns a list of SSH service accounts based on the specified filters. | GET SSH Service Accounts |
|
/ServiceAccounts/ |
POST |
Creates a new SSH service account. | POST SSH Service Accounts |
|
/ServiceAccounts/ |
PUT |
Updates an existing SSH service account. | PUT SSH Service Accounts |
| /ServiceAccounts/Rotate/{id} | POST | Generates a new key pair for an existing service account. | POST SSH Service Accounts Rotate ID |
|
/Users/{id} |
DELETE |
Deletes the SSH user with the specified ID. | DELETE SSH Users ID |
| /Users/{id} | GET | Returns the SSH user with the specified ID. | GET SSH Users ID |
|
/Users/ |
GET |
Returns a list of SSH users based on the specified filters. | GET SSH Users |
|
/Users/ |
POST |
Creates a new SSH user. | POST SSH Users |
|
/Users/ |
PUT |
Updates an existing SSH user. | PUT SSH Users |
| /Users/Access | POST | Creates a mapping from the SSH user to one or more Linux logons. | POST SSH Users Access |