RDP settings policies define protocol-level settings (timeout, display, protocol version, and authentication). You can create multiple policies, and choose the appropriate one for each RDP connection.
GET https://<IP-address-of-SPS>/api/configuration/rdp/settings_policies
| Cookie 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 SPS REST API. Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
The following command lists RDP settings policies.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/rdp/settings_policies
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/rdp/settings_policies/<policy-id>
The following is a sample response received when listing RDP settings policies.
For details of the meta object, see Message format.
{
"items": [
{
"key": "-301",
"meta": {
"href": "/api/configuration/rdp/settings_policies/-301"
}
},
{
"key": "-303",
"meta": {
"href": "/api/configuration/rdp/settings_policies/-303"
}
},
{
"key": "13298899495727c51f725cf",
"meta": {
"href": "/api/configuration/rdp/settings_policies/13298899495727c51f725cf"
}
}
],
"meta": {
"first": "/api/configuration/rdp/channel_policies",
"href": "/api/configuration/rdp/settings_policies",
"last": "/api/configuration/rdp/settings_policies",
"next": null,
"parent": "/api/configuration/rdp",
"previous": "/api/configuration/rdp/options",
"transaction": "/api/transaction"
}
}
When retrieving the endpoint of a specific policy, the response is the following.
{
"body": {
"autologon_domain_suffix": "-AUTO",
"name": "API_test",
"permit_unreliable_usernames": true,
"preconnect_channel_check": true,
"protocol_features": {
"nla": {
"enabled": true,
"require_domain_membership": true
},
"rdp4_auth_enabled": true,
"rdp4_enabled": true,
"rdp5_enabled": true
},
"screen": {
"maximum_bpp": 32,
"maximum_height": 2000,
"maximum_width": 2000
},
"timeout": 600,
"userauth_banner": "Click 'OK' to log in."
},
"key": "13298899495727c51f725cf",
"meta": {
"first": "/api/configuration/rdp/settings_policies/-301",
"href": "/api/configuration/rdp/settings_policies/13298899495727c51f725cf",
"last": "/api/configuration/rdp/settings_policies/13298899495727c51f725cf",
"next": null,
"parent": "/api/configuration/rdp/settings_policies",
"previous": "/api/configuration/rdp/settings_policies/-303",
"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 RDP settings policy. | |
| autologon_domain_suffix | string | Enter the suffix that the client will append to the domain when using autologon in conjunction with Network Level Authentication (CredSSP). | |
| name | string | Name of the RDP settings policy. Cannot contain whitespace. | |
| permit_unreliable_usernames | boolean | Set to true to automatically terminate RDP connections if SPS cannot reliably extract the username. | |
| preconnect_channel_check | boolean |
Before establishing the server-side connection, SPS 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. | |
| protocol_features | Top level item | Settings for RDP protocol versions, and Network Layer Authentication. | |
| screen | Top level item | Display size and depth settings. | |
| timeout | int | Connection timeout, in seconds. Note that the SPS web UI displays the same value in milliseconds. | |
|
|
userauth_banner |
string |
You can display a banner message to the clients before authentication. |
| Elements of protocol | Type | Description | |
|---|---|---|---|
| nla | Top level item | Settings for Network Level Authentication. | |
| enabled | boolean |
Set to true to enable Network Level Authentication. If set to true, the require_domain_membership element is required in the JSON. | |
| require_domain_membership | boolean |
Set to true to require domain membership. Must be in the JSON if NLA is enabled. | |
| rdp4_auth_enabled | boolean | Set to true to enable RDP4 authentication within the RDP5 protocol. This might be needed for compatibility reasons with certain client applications. | |
| rdp4_enabled | boolean | Set to true to enable the version 4 of the Remote Desktop Protocol. | |
| rdp5_enabled | boolean |
Set to true to enable the version 5 of the Remote Desktop Protocol. To also configure SSL-encryption for RDP5, enable the nla element, or configure a Signing CA in your connection policies. | |
| Elements of screen | Type | Description |
|---|---|---|
| maximum_bpp | int | The maximum allowed color depth of the remote desktop, in bits. The following values are valid: 8, 15, 16, 24. |
| maximum_height | int | The maximum allowed height of the remote desktop, in pixels. |
| maximum_width | int | The maximum allowed width of the remote desktop, in pixels. |
Turn off NLA.
{
"autologon_domain_suffix": "-AUTO",
"name": "API_test",
"permit_unreliable_usernames": true,
"preconnect_channel_check": true,
"protocol_features": {
"nla": {
"enabled": false
},
"rdp4_auth_enabled": true,
"rdp4_enabled": true,
"rdp5_enabled": true
},
"screen": {
"maximum_bpp": 24,
"maximum_height": 2000,
"maximum_width": 2000
},
"timeout": 600
}
Configure NLA.
{
"autologon_domain_suffix": "-AUTO",
"name": "API_test",
"permit_unreliable_usernames": true,
"preconnect_channel_check": true,
"protocol_features": {
"nla": {
"enabled": true,
"require_domain_membership": false
},
"rdp4_auth_enabled": true,
"rdp4_enabled": true,
"rdp5_enabled": true
},
"screen": {
"maximum_bpp": 24,
"maximum_height": 2000,
"maximum_width": 2000
},
"timeout": 600
}
To add a settings policy, you have to:
For details, see Open a transaction.
POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/rdp/settings_policies/ endpoint. You can find a detailed description of the available parameters listed in the table of RDP settings policy parameters.
If the POST request is successful, the response includes the key of the new policy. For example:
{
"key": "9c3a0419-53e6-43a4-902c-2b3b0ce7a7a7",
"meta": {
"href": "/api/configuration/rdp/settings_policies/9c3a0419-53e6-43a4-902c-2b3b0ce7a7a7",
"parent": "/api/configuration/rdp/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-SPS>/api/configuration/rdp/settings_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in the table of RDP settings policy parameters.
For details, see Commit a transaction.
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| Code | Description | Notes |
|---|---|---|
| 201 | Created | The new resource was successfully created. |
| 400 |
Bad Request "message": "RDP Settings Policy 'API_test': SPS must be a domain member to allow enabling Network Level Authentication." |
You have set require_domain_membership to true, but SPS is not the member of a domain. |
| 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. |
List of endpoints for configuring the policies, options and connection rules of SSH connections.
GET https://<IP-address-of-SPS>/api/configuration/ssh
| Cookie 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 SPS REST API. Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
The following command lists the available settings for configuring for SSH connections.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ssh
The following is a sample response received when listing the configuration settings.
For details of the meta object, see Message format.
{
"items": [
{
"key": "authentication_policies",
"meta": {
"href": "/api/configuration/ssh/authentication_policies"
}
},
{
"key": "channel_policies",
"meta": {
"href": "/api/configuration/ssh/channel_policies"
}
},
{
"key": "connections",
"meta": {
"href": "/api/configuration/ssh/connections"
}
},
{
"key": "options",
"meta": {
"href": "/api/configuration/ssh/options"
}
},
{
"key": "settings_policies",
"meta": {
"href": "/api/configuration/ssh/settings_policies"
}
}
],
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/ssh",
"last": "/api/configuration/x509",
"next": "/api/configuration/telnet",
"parent": "/api/configuration",
"previous": "/api/configuration/reporting",
"transaction": "/api/transaction"
}
}
| Item | Description |
|---|---|
| authentication_policies | List of the default and custom authentication policies. |
| channel_policies | List of the default and custom channel policies. |
| connections | List of connection policies. |
| options | List of global SSH options that affect all connections. |
| settings_policies | List of protocol-level settings (algorithms, greetings and banners, timeout). You can create multiple variations, and choose the appropriate one for each connection policy. |
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| Code | Description | Notes |
|---|---|---|
| 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. |
Connection policies determine if a server can be accessed from a particular client. Connection policies reference other resources (policies, usergroups, keys) that must be configured and available before creating a connection policy.
GET https://<IP-address-of-SPS>/api/configuration/ssh/connections/
| Cookie 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 SPS REST API. Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
The following command lists SSH connection policies.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ssh/connections/
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ssh/connections/<connection-key>
The following is a sample response received when listing SSH connection policies.
For details of the meta object, see Message format.
{
"items": [
{
"key": "8348340645707e2575e3c6",
"meta": {
"href": "/api/configuration/ssh/connections/8348340645707e2575e3c6"
}
}
],
"meta": {
"first": "/api/configuration/ssh/authentication_policies",
"href": "/api/configuration/ssh/connections",
"last": "/api/configuration/ssh/settings_policies",
"next": "/api/configuration/ssh/options",
"parent": "/api/configuration/ssh",
"previous": "/api/configuration/ssh/channel_policies",
"remaining_seconds": 600,
"transaction": "/api/transaction"
}
}
When retrieving the endpoint of a specific SSH connection policy, the response is the following.
{
"body": {
"access_control": [
{
"authorizer": "reporting",
"permission": "audit_and_authorize",
"require_different_ip": true,
"require_different_username": true,
"subject": {
"selection": "everybody"
}
}
],
"active": true,
"channel_database_cleanup": {
"days": 550,
"enabled": true
},
"client_side_hostkey": {
"plain_hostkey": {
"dsa_key": null,
"enabled": true,
"rsa_key": {
"key": "e5a58682-6189-4477-9415-67c1c9b20b0d",
"meta": {
"href": "/api/configuration/private_keys/e5a58682-6189-4477-9415-67c1c9b20b0d"
}
}
},
"x509_hostkey": {
"enabled": false
}
},
"indexing": {
"enabled": true,
"policy": {
"key": "-50000",
"meta": {
"href": "/api/configuration/policies/indexing/-50000"
}
},
"priority": 2
},
"log_audit_trail_downloads": true,
"name": "API_test_SSH",
"network": {
"clients": [
"0.0.0.0/24"
],
"ports": [
22
],
"targets": [
"192.168.56.102/24"
]
},
"policies": {
"aa_plugin": null,
"analytics_policy": null,
"archive_cleanup_policy": {
"key": "1854671967571b9063c4c82",
"meta": {
"href": "/api/configuration/policies/archive_cleanup_policies/1854671967571b9063c4c82"
}
},
"audit_policy": {
"key": "78101850949e47437dd91d",
"meta": {
"href": "/api/configuration/policies/audit_policies/78101850949e47437dd91d"
}
},
"authentication_policy": {
"key": "1895203635707e3340262f",
"meta": {
"href": "/api/configuration/ssh/authentication_policies/1895203635707e3340262f"
}
},
"backup_policy": {
"key": "512524636571b903540804",
"meta": {
"href": "/api/configuration/policies/backup_policies/512524636571b903540804"
}
},
"channel_policy": {
"key": "-10000",
"meta": {
"href": "/api/configuration/ssh/channel_policies/-10000"
}
},
"credential_store": {
"key": "505008562571b936560254",
"meta": {
"href": "/api/configuration/policies/credentialstores/505008562571b936560254"
}
},
"ldap_server": {
"key": "250588254571b931066482",
"meta": {
"href": "/api/configuration/policies/ldap_servers/250588254571b931066482"
}
},
"settings": {
"key": "-300",
"meta": {
"href": "/api/configuration/ssh/settings_policies/-300"
}
},
"usermapping_policy": {
"key": "9328731525704545f5e3de",
"meta": {
"href": "/api/configuration/policies/usermapping_policies/9328731525704545f5e3de"
}
}
},
"rate_limit": {
"enabled": true,
"value": 200
},
"server_address": {
"selection": "original"
},
"server_side_hostkey": {
"plain_hostkey": {
"enabled": true,
"hostkey_check": "accept-first-time"
},
"x509_hostkey": {
"enabled": false
}
},
"source_address": {
"selection": "box_address"
},
"web_gateway_authentication": {
"enabled": true,
"groups": [
"reporting"
],
"require_same_ip": true
}
},
"key": "8348340645707e2575e3c6",
"meta": {
"first": "/api/configuration/ssh/connections/8348340645707e2575e3c6",
"href": "/api/configuration/ssh/connections/8348340645707e2575e3c6",
"last": "/api/configuration/ssh/connections/8348340645707e2575e3c6",
"next": null,
"parent": "/api/configuration/ssh/connections",
"previous": null,
"transaction": "/api/transaction"
}
}
| Element | Type | Description | ||
|---|---|---|---|---|
| key | string | Top level element, contains the ID of the connection policy. | ||
| body | Top level element (string) | The elements of the connection policy. | ||
| access_control | Top level list |
Collection of access policies. Access policies define who can authorize and audit a connection. | ||
| active | boolean | Set to false to suspend the connection policy. Connection settings are preserved. | ||
| channel_database_cleanup | Top level item | Configures cleanup of the connection metadata on the connection policy's level. | ||
| days | int |
Retention time, in days. Must not exceed the retention time of the archive_cleanup_policy, and the retention time configured in the global settings of the protocol. The global settings of the SSH protocol are available at the api/configuration/ssh/options endpoint. | ||
| enabled | boolean | Set to true to enable periodical cleanup of the connection metadata. | ||
| indexing | Top level item | Configures indexing for the connection policy. | ||
| enabled | boolean | Set to true to enable indexing the connections. | ||
| policy | string |
References the identifier of the indexing policy. You can configure indexing policies at the /api/configuration/policies/indexing/ endpoint. To modify or add an indexing policy, use the value of the returned key as the value of the policy element, and remove any child elements (including the key). | ||
| priority | int |
Specifies the indexing priority for the connection. Possible values are:
| ||
| log_audit_trail_downloads | boolean |
Set to true to log audit trail downloads. | ||
| name | string | The name of the connection policy. | ||
| network | ||||
| clients | list, string | List of client ("from") IP addresses. | ||
| ports | list, integers | List of target ports. | ||
| targets | list, string | List of target IP addresses. | ||
| policies | Top level item | List of policies referenced by the connection policy. | ||
| aa_plugin | string |
References the identifier of the AA plug-in. You can configure AA plug-ins at the /api/configuration/plugins/aa/ endpoint. To modify or add an AA plug-in, use the value of the returned key as the value of the aa_plugin element, and remove any child elements (including the key). | ||
| analytics | string |
References the identifier of the analytics policy. You can configure analytics policies at the /api/configuration/analytics/ endpoint. To add or modify an analytics policy, use the value of the returned key as the value of the analytics element, and remove any child elements (including the key). | ||
| archive_cleanup_policy | string |
References the identifier of the archive/cleanup policy. You can configure archive and cleanup policies at the /api/configuration/policies/archive_cleanup_policies/ endpoint. To modify or add an archive/cleanup policy, use the value of the returned key as the value of the archive_cleanup_policy element, and remove any child elements (including the key). | ||
| audit_policy | string |
Cannot be null. References the identifier of the audit policy. You can configure audit policies at the /api/configuration/policies/audit_policies/ endpoint. To modify or add an audit policy, use the value of the returned key as the value of the audit_policy element, and remove any child elements (including the key). | ||
| authentication_policy | string |
Cannot be null. References the identifier of the authentication policy. You can configure authentication policies at the /api/configuration/ssh/authentication_policies/ endpoint. To modify or add an authentication policy, use the value of the returned key as the value of the authentication_policy element, and remove any child elements (including the key). | ||
| backup_policy | string |
References the identifier of the backup policy. You can configure backup policies at the /api/configuration/policies/backup_policies/ endpoint. To modify or add a backup policy, use the value of the returned key as the value of the backup_policy element, and remove any child elements (including the key). | ||
| channel_policy | string |
References the identifier of the channel policy. The value of this option cannot be null. To modify or add a channel policy, use the value of the returned key as the value of the channel_policy element, and remove any child elements (including the key). You can configure SSH channel policies at the /api/configuration/ssh/channel_policies/ endpoint. | ||
| credential_store | string |
References the identifier of the credential store. You can configure credential stores at the /api/configuration/policies/credentialstores/ endpoint. To modify or add a credential store, use the value of the returned key as the value of the credential_store element, and remove any child elements (including the key). | ||
| ldap_server | string |
References the identifier of the LDAP server. You can configure LDAP servers at the /api/configuration/policies/ldap_servers/ endpoint. To modify or add an LDAP server, use the value of the returned key as the value of the ldap_server element, and remove any child elements (including the key). | ||
| settings | string |
References the identifier of the settings policy. The value of this option cannot be null. To modify or add a settings policy for this protocol, use the value of the returned key as the value of the settings element, and remove any child elements (including the key). You can configure SSH settings policies at the /api/configuration/ssh/settings_policies/ endpoint. | ||
| usermapping_policy | string |
References the identifier of a Usermapping Policy. You can configure Usermapping Policies at the /api/configuration/policies/usermapping_policies/ endpoint. To modify or add a Usermapping Policy, use the value of the returned key as the value of the usermapping_policies element, and remove any child elements (including the key). | ||
| rate_limit | Top level element | Connection rate limit. | ||
| enabled | boolean | Set to true to provide a connection rate limit. | ||
| value | int | The number of connections (per minute) that are allowed in the connection policy. | ||
| server_address | Top level item | Defines the address where the clients connect to. | ||
| server_side_hostkey | Top level element |
Settings for verifying the server's identity using plain hostkeys and X.509 host certificates. At least one of the options (plain_hostkey or X509_hostkey) must be enabled. | ||
| source_address | Top level element | Allows you to configure Source Network Address Translation (SNAT) on the server side of SPS. SNAT determines the IP address SPS uses in the server-side connection. The target server will see the connection coming from this address. | ||
| selection | string |
Configures Source Network Address Translation. Possible values are:
| ||
| address | string |
Must be used if the value of the selection element is set to fix. The IP address to use as the source address in server-side connections. | ||
| web_gateway_authentication | Top level item | When gateway authentication is required for a connection, the user must authenticate on SPS as well. This additional authentication can be performed out-of-band on the SPS web interface for every protocol. | ||
| enabled | boolean | Set to true to enable additional gateway authentication on the SPS web interface. | ||
| groups | list, string |
By default, any user can perform gateway authentication for the connections. You can restrict authentication to members of specific usergroups. Define the usergroups at the /api/configuration/aaa/local_database/groups/ endpoint, and list the name of each group here. | ||
| require_same_ip | boolean | Set to true to only accept web gateway authentication from the same host that initiated the connection. | ||
| Elements of access_control | Type | Description | |
|---|---|---|---|
| authorizer | string |
The usergroup (local or LDAP) who can authorize or audit the connection. Local usergroups can be added or modified at the /api/configuration/aaa/local_database/groups/ endpoint. | |
| permission | string |
Defines the permissions of the authorizer usergroup. Possible values are:
| |
| require_different_ip | boolean | Set to true to require the authorizing user and its subject to have different IP addresses. | |
| require_different_username | boolean | Set to true to require the authorizing user and its subject to have different usernames. | |
| subject | Top level item | Defines the subjects of the access control policy. | |
| group | string |
The usergroup (local or LDAP) that is subject to the access control policy. Local usergroups can be added or modified at the /api/configuration/aaa/local_database/groups/ endpoint. | |
| selection | string |
Possible values:
| |
| Elements of client_side_hostkey | Type | Description | ||
|---|---|---|---|---|
| plain_hostkey | Top level item |
Configures the RSA key SPS shows to the clients. | ||
| rsa_key | string |
References the identifier of the RSA key. You can add RSA keys at the /api/configuration/private_keys/ endpoint. To modify or add an RSA key, use the value of the returned key as the value of the rsa_key element, and remove any child elements (including the key). | ||
| x509_hostkey | Top level item | Configures the X.509 keys SPS shows to the clients. | ||
| enabled | boolean |
Set to true to allow presenting X.509 hostkeys to clients. You must enable either plain_hostkey or x509_hostkey (or both). | ||
| x509 | Top level item | Parameters for X.509 hostkeys. | ||
| selection | string |
Possible values:
| ||
| signing_ca | string |
Must be used when generating the X.509 certificate. References the signing Certificate Authority (CA). 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 rsa_key element, and remove any child elements (including the key). | ||
| x509_identity | string |
Must be used when using the same X.509 host certificate across connection policies. References the identifier of the X.509 certificate stored on SPS. You can configure certificates at the /api/configuration/x509/ endpoint. To modify or add an X.509 host certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key). | ||
| Elements of server_side_hostkey | Type | Description | ||
|---|---|---|---|---|
| plain_hostkey | Top level element | Verifies the identity of the servers based on their hostkeys. | ||
| enabled | boolean |
Set to true to enable plain hostkey checking. If enabled, the hostkey_check element is mandatory. | ||
| hostkey_check | string |
Defines the method for checking the host keys of the target server. Possible values are:
| ||
| x509_hostkey | Top level element | Verifies the identity of the servers based on their X.509 certificates. | ||
| enabled | string |
Set to true to enable X.509 hostkey verification. If enabled, the x509_check element is mandatory. | ||
| x509_check | Top level item | Contains the configuration settings for verifying X.509 certificates. | ||
| selection | string |
Configures the validation of X.509 certificates. Possible values are:
| ||
| trusted_ca | string |
Must be used if the selection element is set to accept-signed-by. References the identifier of the trusted CA. You can add or modify the list of 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). | ||
For practical purposes, the following examples show only the relevant parts of a connection policy JSON object. To modify or add a connection policy, always submit the full JSON object.
Access control list: configuring the "security" usergroup to only audit connections made by the "root_only" usergroup.
"access_control": [
{
"authorizer": "security",
"permission": "audit",
"require_different_ip": true,
"require_different_username": true,
"subject": {
"group": "root_only",
"selection": "only"
}
}
Target server: use the address specified by the client.
"server_address": {
"selection": "original"
}
Target server: use a fix address.
"server_address": {
"address": "<fix-IP>",
"port": 22,
"selection": "fix"
}
Target server: configure inband destination selection, where the client can specify the target address in the username. The target can be either an IP range, or a domain.
"server_address": {
"dns_server": "<ip-of-dns-server>",
"dns_suffixes": null,
"domains": [
{
"domain": {
"selection": "address",
"value": "<IP-range>"
},
"port": 22
},
{
"domain": {
"selection": "domain",
"value": "*.example"
},
"port": 22
}
],
"selection": "inband"
}
Source address: use the same fix IP when connecting to the remote server.
"source_address": {
"address": "<ip-address>",
"selection": "fix"
}
Web gateway authentication: require the admin usergroup to perform an additional gateway authentication on the SPS web interface. They must authenticate from the same host which initiated the connection.
"web_gateway_authentication": {
"enabled": true,
"groups": [
"admin"
],
"require_same_ip": true
}
Client-side hostkey: use plain hostkeys uploaded to SPS, and generate X.509 certificates for the connection.
"client_side_hostkey": {
"plain_hostkey": {
"dsa_key": "<id-of-dsa-key>",
"enabled": true,
"rsa_key": "<id-of-rsa-key>"
},
"x509_hostkey": {
"enabled": true,
"x509": {
"selection": "generate",
"signing_ca": "<key-of-signing-ca>"
}
}
}
Policies: configure only the required policies.
"policies": {
"aa_plugin": null,
"analytics_policy": null,
"archive_cleanup_policy": null,
"audit_policy": "<key-of-audit-policy>",
"authentication_policy": "<key-of-auth-policy>",
"backup_policy": null,
"channel_policy": "<key-of-channel-policy>",
"credential_store": null,
"ldap_server": null,
"settings": "<key-of-settings-policy>",
"usermapping_policy": null
}
Server-side hostkey: accept the hostkey or X.509 certificate presented at the first connection, and require the same hostkey or certificate for any subsequent connections.
"server_side_hostkey": {
"plain_hostkey": {
"enabled": true,
"hostkey_check": "accept-first-time"
},
"x509_hostkey": {
"enabled": true,
"x509_check": {
"selection": "accept-first-time"
}
}
}
Server-side hostkey: only accept X.509 certificates that are verified by a trusted CA.
"server_side_hostkey": {
"plain_hostkey": {
"enabled": false
},
"x509_hostkey": {
"enabled": true,
"x509_check": {
"selection": "accept-signed-by",
"trusted_ca": "<id-of-trusted-ca>"
}
}
}
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| 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 connection policy, you have to:
For details, see Open a transaction.
POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/ssh/connections/ endpoint. You can find a detailed description of the available parameters listed in Element .
If the POST request is successful, the response includes the key of the new SSH connection policy. For example:
{
"key": "a99be49b-b0a2-4cf9-b70d-fea1f9ea188f",
"meta": {
"href": "/api/configuration/ssh/connections/a99be49b-b0a2-4cf9-b70d-fea1f9ea188f",
"parent": "/api/configuration/ssh/connections",
"transaction": "/api/transaction"
}
}
For details, see Commit a transaction.
To modify an SSH connection policy, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/ssh/connections/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in Element .
For details, see Commit a transaction.
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Conditions d’utilisation Confidentialité Cookie Preference Center