Lists the configured authentication methods that can be used in a connection. Each connection policy uses an authentication policy to determine how the client can authenticate to the target server. Separate authentication methods can be used on the client and the server-side of the connection.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/authentication_policies
Header name | Description | Required | Values |
---|---|---|---|
session_id | Contains the authentication token of the user | Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists SSH authentication policies.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/authentication_policies
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/authentication_policies<object-id>
The following is a sample response received when listing SSH authentication policies. For details of the meta object, see Message format.
{ "items": [ { "key": "-200", "meta": { "href": "/api/configuration/ssh/authentication_policies/-200" } }, { "key": "1895203635707e3340262f", "meta": { "href": "/api/configuration/ssh/authentication_policies/1895203635707e3340262f" } } ], "meta": { "first": "/api/configuration/ssh/authentication_policies", "href": "/api/configuration/ssh/authentication_policies", "last": "/api/configuration/ssh/settings_policies", "next": "/api/configuration/ssh/channel_policies", "parent": "/api/configuration/ssh", "previous": null, "transaction": "/api/transaction" } }
When retrieving the endpoint of a specific policy, the response is the following.
{ "body": { "mode": { "gateway_authentication": { "selection": "none" }, "gssapi": false, "relayed_methods": { "certificate": { "selection": "disabled" }, "keyboard_interactive": true, "password": true, "public_key": { "selection": "disabled" } } }, "name": "base" }, "key": "-200", "meta": { "first": "/api/configuration/ssh/authentication_policies/-200", "href": "/api/configuration/ssh/authentication_policies/-200", "last": "/api/configuration/ssh/authentication_policies/1895203635707e3340262f", "next": "/api/configuration/ssh/authentication_policies/1895203635707e3340262f", "parent": "/api/configuration/ssh/authentication_policies", "previous": null, "transaction": "/api/transaction" } }
Element | Type | Description | ||
---|---|---|---|---|
key | string | Top level element, contains the ID of the policy. | ||
body | Top level element | Contains the elements of the policy. | ||
mode | Top level element | Contains the configuration of the policy. | ||
gateway_authentication | Top level item | Client-side gateway authentication settings. The value of selection defines which authentication method is used. | ||
relayed_methods | Top level element | Server-side authentication settings. | ||
gssapi | boolean | Deprecated setting. | ||
name | string | The name of the object. This name is also displayed on the Safeguard for Privileged Sessions web interface. It cannot contain whitespace. |
Elements of gateway_authentication | Type | Description | ||
---|---|---|---|---|
selection | string |
Defines the authentication method for client-side gateway authentication. Possible values are:
| ||
certificate | Top level item |
Configures authentication with an X.509 certificate. The enabled child element is required for this option. To enable it, you must also configure the trusted_ca child element. | ||
enabled | boolean |
Possible values:
| ||
trusted_ca | string |
References the key of the trusted CA. You can configure trusted CAs at the /api/configuration/policies/trusted_ca_lists/ endpoint. To modify or add a trusted CA, use the value of the returned key as the value of the trusted_ca element, and remove any child elements (including the key). | ||
password | boolean |
Authentication based on username and password. Set it to true to enable password-based client-side authentication. | ||
public_key | Top level item |
Authentication based on public-private encryption keypairs. | ||
|
enabled |
|
boolean |
Set it to true to enable public key-based client-side authentication. |
user_database | string |
References the key of the local user database. You can configure local user databases at the /api/configuration/policies/user_databases/ endpoint. To modify or add a local user database, use the value of the returned key as the value of the user_database element, and remove any child elements (including the key). | ||
servers | Top level list |
Defines the properties of the RADIUS servers used for client-side authentication. A valid list item consists of the address, port and shared_secret elements. | ||
address | Top level element | Defines the address of a RADIUS server. | ||
selection | string |
Required child of the address element. Possible values are:
| ||
value | string | The IP or the FQDN address of the RADIUS server. | ||
port | int | The port number of the RADIUS server. | ||
shared_secret | string |
References the key of the shared secret for the RADIUS server. You can configure shared secrets at the /api/configuration/passwords/ endpoint. To modify or add a shared secret, use the value of the returned key as the value of the shared_secret element, and remove any child elements (including the key). | ||
authentication_protocol | Top level item |
RADIUS setting. Set to pap to use the Password Authentication Protocol. To use the Challenge-Handshake Authentication Protocol, set it to chap. |
Elements of relayed_authentication | Type | Description | |
---|---|---|---|
certificate | Top level item |
Authentication based on X.509 certificates. Use the selection child element to disable or configure authentication using X.509 certificates on the remote server. | |
selection | string |
| |
X509_identity | string |
References the private key and certificate used for authenticating on the remote server. You can configure X.509 certificates and keys at the /api/configuration/x509/ endpoint. To modify or add an X.509 certificate and private key, use the value of the returned key as the value of the X509_identity element, and remove any child elements (including the key). | |
signing_CA | string |
References the Certificate Authority (CA) used for signing certificates. You can configure signing CAs at the /api/configuration/policies/signing_cas/ endpoint. To modify or add a signing CA, use the value of the returned key as the value of the X509_identity element, and remove any child elements (including the key). | |
keyboard_interactive | boolean |
Authentication based on exchanging messages between the user and the server. This method includes authentication schemes like S/Key or TIS authentication. Depending on the configuration of the SSH server, might have to be used together with password-based authentication. Set to true to enable interactive authentication on the remote server. | |
password | boolean |
Authentication based on username and password. Set to true to enable password-based authentication on the remote server. | |
public_key | Top level item |
Authentication based on public-private encryption keypairs. Use the selection child element to disable or configure authentication using public-private keypairs on the remote server. | |
selection | string |
Configures authenticaton on the remote server using public-private keypairs. The following values are possible:
| |
private_key | string |
References the key of the private key used for authenticating with a public-private keypair on the remote server. You can configure private keys at the /api/configuration/private_keys/ endpoint. To modify or add a private key, use the value of the returned key as the value of the private_key element, and remove any child elements (including the key). |
Password authentication against LDAP on the client side, and using a username and password on the remote server:
{ "mode": { "gateway_authentication": { "certificate": { "enabled": false }, "password": true, "public_key": { "enabled": false }, "selection": "ldap" }, "gssapi": false, "relayed_methods": { "certificate": { "selection": "disabled" }, "keyboard_interactive": false, "password": true, "public_key": { "selection": "disabled" } } }, "name": "Passwords" }
Password authentication against a local user database on Safeguard for Privileged Sessions, and using a username and password on the remote server. You can find the key of the local user database is available at the /api/configuration/policies/user_databases/ endpoint.
{ "mode": { "gateway_authentication": { "certificate": { "enabled": false }, "password": true, "public_key": { "enabled": false }, "selection": "local", "user_database": <key-of-the-local-usr-db> }, "gssapi": false, "relayed_methods": { "certificate": { "selection": "disabled" }, "keyboard_interactive": false, "password": true, "public_key": { "selection": "disabled" } } }, "name": "Local_usr_db" }
Authenticating against an RADIUS server on the client side, and using a username and password on the remote server. You can configure the key of the shared secret at the /api/configuration/passwords/ endpoint. The IP of the RADIUS server is used.
{ "mode": { "gateway_authentication": { "selection": "radius", "servers": [ { "address": { "selection": "ip", "value": "<radius-server-ip>" }, "port": 1812, "shared_secret": <key-of-shared-secret> } ] }, "gssapi": false, "relayed_methods": { "certificate": { "selection": "disabled" }, "keyboard_interactive": false, "password": true, "public_key": { "selection": "disabled" } } }, "name": "RADIUS" }
Using X.509 certificates against an LDAP server on the client-side, and forwarding it for authentication on the server-side. The key of the trusted Certificate Authority (CA) is available at the /api/configuration/policies/trusted_ca_lists endpoint.
{ "mode": { "gateway_authentication": { "certificate": { "enabled": true, "trusted_ca": <key-of-trusted-ca> }, "password": false, "public_key": { "enabled": false }, "selection": "ldap" }, "gssapi": false, "relayed_methods": { "certificate": { "selection": "agent" }, "keyboard_interactive": false, "password": false, "public_key": { "selection": "disabled" } } }, "name": "X509_forwarding" }
Using X.509 certificates against an LDAP server on the client-side, and generating X.509 certificate and key on the fly for authentication on the server-side. The generated keys are uploaded to the LDAP server, so that Safeguard for Privileged Sessions can authenticate the user on the remote server. The key of the trusted Certificate Authority (CA) is available at the /api/configuration/policies/trusted_ca_lists/ endpoint. The key of the signing Certificate Authority (CA) is available at the /api/configuration/policies/signing_cas/ endpoint.
{ "mode": { "gateway_authentication": { "certificate": { "enabled": true, "trusted_ca": <key-of-trusted-ca> }, "password": false, "public_key": { "enabled": false }, "selection": "ldap" }, "gssapi": false, "relayed_methods": { "certificate": { "selection": "publish_to_ldap", "signing_ca": <key-of-signing-ca> }, "keyboard_interactive": false, "password": false, "public_key": { "selection": "disabled" } } }, "name": "X509" }
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
Code | Description | Notes |
---|---|---|
201 | Created | The new resource was successfully created. |
400 | InvalidQuery | The requested filter or its value is invalid. |
401 | Unauthenticated | The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
To add an SSH authentication policy, you have to:
For details, see Open a transaction.
POST the JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/authentication_policies/ endpoint. You can find a detailed description of the available parameters listed in SSH authentication policies. The elements of gateway_authentication are listed in SSH authentication policies. The elements of relayed_authentication are listed in SSH authentication policies.
If the POST request is successful, the response includes the key of the new policy. For example:
{ "key": "6f924f39-e4c9-4b0f-8018-8842e2115ebd", "meta": { "href": "/api/configuration/ssh/authentication_policies/6f924f39-e4c9-4b0f-8018-8842e2115ebd", "parent": "/api/configuration/ssh/authentication_policies", "transaction": "/api/transaction" } }
For details, see Commit a transaction.
To modify an SSH authentication policy, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/authentication_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in SSH authentication policies. The elements of gateway_authentication are listed in SSH authentication policies. The elements of relayed_authentication are listed in SSH authentication policies.
For details, see Commit a transaction.
List of options that affect all SSH connections.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/options
Header name | Description | Required | Values |
---|---|---|---|
session_id | Contains the authentication token of the user | Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists global SSH options.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/options
The following is a sample response received when listing global SSH options. For details of the meta object, see Introduction.
{ "body": { "audit": { "cleanup": { "channel_database_cleanup_days": 600, "enabled": true }, "timestamping": { "selection": "local", "signing_interval": 30 } }, "gssapi": { "enabled": false }, "service": { "enabled": true, "log_level": 4 } }, "key": "options", "meta": { "first": "/api/configuration/ssh/authentication_policies", "href": "/api/configuration/ssh/options", "last": "/api/configuration/ssh/settings_policies", "next": "/api/configuration/ssh/settings_policies", "parent": "/api/configuration/ssh", "previous": "/api/configuration/ssh/connections", "transaction": "/api/transaction" } }
Element | Type | Description | ||
---|---|---|---|---|
key | Top level item | Contains the ID of the endpoint. | ||
body | Top level item | Contains the elements of the global SSH options. | ||
audit | Top level item | Contains settings for timestamping and cleanup. | ||
service | Top level item | Global setting to enable SSH connections, and specify the logging detail. | ||
enabled | boolean | Set to true to enable SSH connections. | ||
log_level | int | Defines the logging detail of SSH connections. | ||
gssapi | Top level item | Deprecated setting. |
Elements of audit | Type | Description | ||
---|---|---|---|---|
cleanup | Top level item | Global retention settings for SSH connection metadata. To configure retention time for a specific connection policy, use the archive_cleanup_policy element at the endpoint of the policy instead. | ||
channel_database_cleanup_days | int | Global retention time for the metadata of SSH connections, in days. Must exceed the retention time of the archiving policy (or policies) used for SSH connections, and the connection-specific database cleanup times (if configured). | ||
enabled | boolean | To enable the global cleanup of SSH connection metadata, set this element to true. | ||
timestamping | Top level item | Global timestamping settings for SSH connections. | ||
selection | string |
Configures local or remote timestamping.
| ||
server_url | string |
Required for remote timestamping. The URL of the timestamping server. Note that HTTPS and password-protected connections are not supported. | ||
oid | Top level item | The Object Identifier of the policy used for timestamping. | ||
enabled | boolean |
Required for remote timestamping. Set to true to configure the Object Identifier of the timestamping policy on the timestamping remote server. | ||
policy_oid | string |
Required if the oid is enabled. The Object Identifier of the timestamping policy on the remote timestamping server. | ||
signing_interval | int | Time interval for timestamping open connections, in seconds. |
Set Safeguard for Privileged Sessions as the timestamping server:
{ "audit": { "cleanup": { "enabled": false }, "timestamping": { "selection": "local", "signing_interval": 30 } }, "gssapi": { "enabled": false }, "service": { "enabled": true, "log_level": 4 } }
Enable cleanup, and set it to occur every 10 days:
{ "audit": { "cleanup": { "channel_database_cleanup_days": 10, "enabled": true }, "timestamping": { "selection": "local", "signing_interval": 30 } }, "gssapi": { "enabled": false }, "service": { "enabled": true, "log_level": 4 } }
Change timestamping to a remote server, without specifying a timestamping policy:
{ "audit": { "cleanup": { "channel_database_cleanup_days": 10, "enabled": true }, "timestamping": { "oid": { "enabled": false }, "selection": "remote", "server_url": "<url-of-timestamping-server>", "signing_interval": 30 } }, "gssapi": { "enabled": false }, "service": { "enabled": true, "log_level": 4 } }
Change timestamping to a remote server, and specify the 1.2.3 timestamping policy:
{ "audit": { "cleanup": { "channel_database_cleanup_days": 10, "enabled": true }, "timestamping": { "oid": { "enabled": true, "policy_oid": "1.2.3" }, "selection": "remote", "server_url": "<url-of-timestamping-server>", "signing_interval": 30 } }, "gssapi": { "enabled": false }, "service": { "enabled": true, "log_level": 4 } }
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
Code | Description | Notes |
---|---|---|
201 | Created | The new resource was successfully created. |
400 | InvalidQuery | The requested filter or its value is invalid. |
401 | Unauthenticated | The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
To modify global SSH settings, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/options endpoint. You can find a detailed description of the available parameters listed in Global SSH options. The elements of the audit item are described in Global SSH options.
For details, see Commit a transaction.
SSH settings policies define protocol-level settings (algorithms, greetings and banners, timeout). You can create multiple policies, and choose the appropriate one for each SSH connection.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/settings_policies
Header name | Description | Required | Values |
---|---|---|---|
session_id | Contains the authentication token of the user | Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists SSH settings policies.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/settings_policies
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/settings_policies/<policy-id>
The following is a sample response received when listing SSH settings policies. For details of the meta object, see Introduction.
{ "items": [ { "key": "-300", "meta": { "href": "/api/configuration/ssh/settings_policies/-300" } }, { "key": "236283841571912b948b88", "meta": { "href": "/api/configuration/ssh/settings_policies/236283841571912b948b88" } } ], "meta": { "first": "/api/configuration/ssh/authentication_policies", "href": "/api/configuration/ssh/settings_policies", "last": "/api/configuration/ssh/settings_policies", "next": null, "parent": "/api/configuration/ssh", "previous": "/api/configuration/ssh/options", "transaction": "/api/transaction" } }
When retrieving the endpoint of a specific policy, the response is the following.
{ "body": { "client_side_algorithms": { "cipher": [ "aes128-ctr", "aes192-ctr", "aes256-ctr" ], "compression": [ "none" ], "kex": [ "diffie-hellman-group14-sha1" ], "mac": [ "hmac-sha2-256", "hmac-sha2-512" ] }, "greeting": "Welcome!", "name": "API_SSH_Setting", "preconnect_channel_check": true, "server_side_algorithms": { "cipher": [ "aes128-ctr", "aes192-ctr", "aes256-ctr" ], "compression": [ "none" ], "kex": [ "diffie-hellman-group14-sha1" ], "mac": [ "hmac-sha2-256", "hmac-sha2-512" ] }, "software_version": "SSH", "strict_mode": true, "timeout": 600, "userauth_banner": "This is a monitored connection." }, "key": "236283841571912b948b88", "meta": { "first": "/api/configuration/ssh/settings_policies/-300", "href": "/api/configuration/ssh/settings_policies/236283841571912b948b88", "last": "/api/configuration/ssh/settings_policies/236283841571912b948b88", "next": null, "parent": "/api/configuration/ssh/settings_policies", "previous": "/api/configuration/ssh/settings_policies/-300", "transaction": "/api/transaction" } }
Element | Type | Description | ||
---|---|---|---|---|
key | string | Top level element, contains the ID of the policy. | ||
body | Top level element (string) | The elements of the SSH settings policy. | ||
client_side_algorithms | Top level element (list) | Lists the permitted client-side encryption parameters. | ||
cipher | list | Lists the permitted client-side cipher algorithms. | ||
compression | list | Lists the permitted client-side compression algorithms. | ||
kex | list | Lists the permitted client-side KEX algorithms. | ||
mac | list | Lists the permitted client-side MAC algorithms. | ||
greeting | string | Greeting message for the connection. | ||
name | string | Name of the SSH settings policy. | ||
preconnect_channel_check | boolean |
Before establishing the server-side connection, Safeguard for Privileged Sessions can evaluate the connection and channel policies to determine if the connection might be permitted at all. The server-side connection is established only if the evaluated policies permit the client to access the server. To enable this function, set the parameter to true. | ||
server_side_algorithms | Top level element (list) | Lists the permitted server-side encryption parameters. | ||
cipher | list | Lists the permitted server-side cipher algorithms. | ||
compression | list | Lists the permitted server-side compression algorithms. | ||
kex | list | Lists the permitted server-side KEX algorithms. | ||
mac | list | Lists the permitted server-side MAC algorithms. | ||
software_version | string | Specifies additional text to append to the SSH protocol banner sent by the server upon connection. | ||
strict_mode | boolean |
When this option is enabled, Safeguard for Privileged Sessions rejects connections that use unrealistic parameters (for example, terminals of thousand by thousand characters) and port-forwarding connections where the address in the port-forwarding request and the channel-opening request does not match. Note that this can interfere with certain client or server applications. Strict mode is allowed by default. To turn it off, set the parameter to false. | ||
timeout | int | Connection timeout, in seconds. Note that the Safeguard for Privileged Sessions web UI displays the same value in milliseconds. | ||
userauth_banner | string | You can display a banner message to the clients before authentication (as specified in RFC 4252 — The Secure Shell (SSH) Authentication Protocol). You can use this banner to inform the users that the connection is audited. |
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
Code | Description | Notes |
---|---|---|
201 | Created | The new resource was successfully created. |
400 | InvalidQuery | The requested filter or its value is invalid. |
401 | Unauthenticated | The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
To add a settings policy, you have to:
For details, see Open a transaction.
POST the JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/settings_policies/ endpoint. You can find a detailed description of the available parameters listed in SSH settings policies.
If the POST request is successful, the response includes the key of the new policy. For example:
{ "key": "59790911-415c-4ed3-a0d2-1164637472ca", "meta": { "href": "/api/configuration/ssh/settings_policies/59790911-415c-4ed3-a0d2-1164637472ca", "parent": "/api/configuration/ssh/settings_policies", "transaction": "/api/transaction" } }
For details, see Commit a transaction.
To modify a settings policy, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/ssh/settings_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in SSH settings policies.
For details, see Commit a transaction.
Safeguard for Privileged Sessions stores the host keys and X.509 certificates of the trusted servers. When a client tries to connect to a server, Safeguard for Privileged Sessions verifies the host key or the certificate of the server, and allows connections only to the servers that have their keys available on Safeguard for Privileged Sessions (unless the SSH Connection Policy is configured differently).
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys
Header name | Description | Required | Values |
---|---|---|---|
session_id | Contains the authentication token of the user | Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists the SSH host keys and certificates of the servers that the users can connect to using SSH.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys/
The following command retrieves the properties of a specific key.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys/<object-id>
The following is a sample response received when listing SSH host keys and certificates from the https:<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys/ endpoint. For details of the meta object, see Introduction.
The key of these objects is in the following format: <type-of-the-key>-<host-address>:<host-port>.
{ "meta": { "href": "/api/ssh-host-keys", "parent": "/api" }, "items": [ { "key": "ssh-dss-10.110.0.1:22", "meta": {"href": "/api/ssh-host-keys/ssh-dss-10.110.0.1:22"} }, { "key": "ssh-dss-10.110.0.2:2222", "meta": {"href": "/api/ssh-host-keys/ssh-dss-10.110.0.2:2222"} }, { "key": "ssh-rsa-10.110.0.1:22", "meta": {"href": "/api/ssh-host-keys/ssh-rsa-10.110.0.1:22"} }, { "key": "x509v3-sign-rsa-d00::2222:dead:2222", "meta": {"href": "/api/ssh-host-keys/x509v3-sign-rsa-d00::2222:dead:2222"} } ] }
When retrieving the endpoint of a specific host key, the response is the following.
{ "key": "ssh-rsa-10.10.100.1:22", "meta": { "href": "/api/ssh-host-keys/ssh-rsa-10.10.100.1:22", "parent": "/api/ssh-host-keys" }, "ssh-rsa-10.10.100.1:22": { "address": "10.10.100.1", "port": 22, "type": { "selection": "ssh-rsa", "value": "AAAAB3NzaC1yc2EAAAABIwAAAQEAxrtNxBZieXhBI2gJoAdsjKNq...==" } } }
Element | Type | Description | ||
---|---|---|---|---|
key | string | Top level element, contains the ID of the host key or certificate in the following format: <type-of-the-key>-<host-address>:<host-port> | ||
<id-of-the-host-key> | Top level element (string) | The ID of the host key or certificate in the following format: <type-of-the-key>-<host-address>:<host-port>. | ||
address | string | The IPv4 or IPv6 address of the host that the key belongs to. Note that for IPv6 addresses, this is always the canonical format of the address. | ||
port | number | The port number where the host uses the key or certificate. | ||
type | JSON object | The ID of the host key or certificate in the following format: <type-of-the-key>-<host-address>:<host-port>. | ||
selection | string | Specifies the type of the host key. Possible values: ssh-rsa, ssh-dss, x509v3-sign-rsa, x509v3-sign-dss | ||
value | string | The host key or certificate as a string in PEM format. |
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
Code | Description | Notes |
---|---|---|
201 | Created | The new resource was successfully created. |
400 | InvalidQuery | The requested filter or its value is invalid. |
401 | Unauthenticated | The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
To list only specific host keys, you can use the following filters.
List every host key and certificate:
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys
List host keys of a specific type:
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys?type=<type-to-list>
Possible values: ssh-rsa, ssh-dss, x509v3-sign-rsa, x509v3-sign-dss. For example:
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys?type=ssh-rsa
List host keys for a specific port number:
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys?port=<port-number-to-list>
List host keys for a specific host address (IPv4 or IPv6):
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys?address=<host-address>
For a complex filter, separate the parameters with an ampersand (&) character, for example:
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys?port=<port-number-to-list>&type=<type-to-list>
The response to such requests is a JSON object, where the items list includes the IDs of the selected host keys (or an empty list). For example, filtering for ssh-dss keys could return a similar list:
{ "meta": { "href": "/api/ssh-host-keys", "parent": "/api" }, "items": [ { "key": "ssh-dss-10.110.0.1:22", "meta": {"href": "/api/ssh-host-keys/ssh-dss-10.110.0.1:22"} }, { "key": "ssh-dss-10.110.0.2:2222", "meta": {"href": "/api/ssh-host-keys/ssh-dss-10.110.0.2:2222"} } ] }
To upload a new host key or certificate, you have to POST the host key and other data as a JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys endpoint. For details, see Using the Safeguard for Privileged Sessions REST API. The body of the POST request must contain a JSON object with the parameters listed in SSH host keys and certificates. If the POST request is successful, the response includes an ID for the host key in the following format: <type-of-the-key>-<host-address>:<host-port>. For example:
{ "address": "10.110.0.1", "port": 22, "type": { "selection": "ssh-rsa", "value": "AAAAB3NzaC1yc2EAAAAD...zvMwgc==" } }
Note that for IPv6 addresses, Safeguard for Privileged Sessions will automatically convert the address to its canonical format.
To delete a host key or certificate, you have to DELETE https://<IP-address-of-Safeguard for Privileged Sessions>/api/ssh-host-keys/<ID-of-the-host-key> endpoint. For details, see Using the Safeguard for Privileged Sessions REST API. If the DELETE request is successful, the response includes only the meta object, for example:
{ "meta": { "href": "/api/ssh-host-keys/ssh-rsa-10.10.20.35:22", "parent": "/api/ssh-host-keys" } }
You must commit your changes to actually delete the object from Safeguard for Privileged Sessions.
© 2023 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy