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. |
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy Cookie Preference Center