You can use Credential Security Service Provider (CredSSP, also called Network Level Authentication or NLA) when One Identity Safeguard for Privileged Sessions (SPS) is member of the domain.
Prerequisites
-
The target servers and SPS must be in the same domain, or you must establish trust between the domains that contain the target servers and SPS. For details on the type of trust required, see Using One Identity Safeguard for Privileged Sessions (SPS) across multiple domains in the Administration Guide.
The SPS configuration API allows you to view, disable, or modify the domain membership configuration. To join the configured domain, you have to use the web interface of SPS.
URL
GET https://<IP-address-of-SPS>/api/rdp/domain_membership
Sample request
The following command lists the configuration options for domain membership.
curl --cookie cookies https://<IP-address-of-SPS>/api/rdp/domain_membership
Response
The following is a sample response received when querying the domain membership configuration.
{
"body": {
"domain": "testdomain",
"enabled": true,
"realm": "testdomain.api.test"
},
"key": "domain_membership",
"meta": {
"first": "/api/configuration/rdp/channel_policies",
"href": "/api/configuration/rdp/domain_membership",
"last": "/api/configuration/rdp/settings_policies",
"next": "/api/configuration/rdp/options",
"parent": "/api/configuration/rdp",
"previous": "/api/configuration/rdp/channel_policies",
"transaction": "/api/transaction"
}
}
| key |
|
string |
Top level element, contains the ID of the endpoint. |
| body |
|
Top level element (string) |
Contains the domain membership configuration. |
|
domain |
string |
The name of the domain.
Must be used if enabled is set to true. |
|
enabled |
boolean |
Set to true to configure domain membership. |
|
realm |
string |
Name of the realm.
Must be used if enabled is set to true. |
Examples:
Configure domain membership for the "test" domain on the "config.api" realm:
{
"domain": "test",
"enabled": true,
"realm": "test.config.api"
}
Disable domain membership.
{
"enabled": false
}
Modify domain membership settings
To modify domain membership settings, you have to:
-
Modify the JSON object of the domain membership configuration.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/rdp/domain_embership/ endpoint. You can find a detailed description of the available parameters listed in Element .
| 201 |
Created |
The new resource was successfully created. |
| 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. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 |
NotFound |
The requested object does not exist. |
List of options that affect all RDP connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/rdp/options
Sample request
The following command lists global RDP options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/rdp/options
Response
The following is a sample response received when listing global RDP options.
{
"body": {
"channel_database_cleanup": {
"enabled": false
},
"service": {
"enabled": false
}
}
"key": "options",
"meta": {
"first": "/api/configuration/rdp/channel_policies",
"href": "/api/configuration/rdp/options",
"last": "/api/configuration/rdp/settings_policies",
"next": "/api/configuration/rdp/settings_policies",
"parent": "/api/configuration/rdp",
"previous": "/api/configuration/rdp/domain_membership",
"transaction": "/api/transaction"
}
}
| key |
|
Top level item |
Contains the ID of the endpoint. |
| body |
|
Top level item |
Contains the elements of the global RDP options. |
| |
channel_database_cleanup |
Top level item |
Contains settings for database cleanup. |
| |
service |
Top level item |
Global setting to enable RDP connections, and specify the logging detail. |
| days |
integer |
Applies only if enabled is set to true.
Global retention time for the metadata of RDP connections, in days. Must exceed the retention time of the archiving policy (or policies) used for RDP connections, and the connection-specific database cleanup times (if configured). |
|
enabled |
boolean |
To enable the global cleanup of RDP connection metadata, set enabled to true. |
| log_level |
integer |
Applies only if enabled is set to true.
Defines the logging detail of RDP connections. |
|
enabled |
boolean |
To enable RDP connections, set to true. |
Examples
Querying the full list of global RDP options:
{
"body": {
"channel_database_cleanup": {
"enabled": true,
"days": 365
},
"service": {
"enabled": true,
"log_level": 4
}
}
"key": "options",
"meta": {
"first": "/api/configuration/rdp/channel_policies",
"href": "/api/configuration/rdp/options",
"last": "/api/configuration/rdp/settings_policies",
"next": "/api/configuration/rdp/settings_policies",
"parent": "/api/configuration/rdp",
"previous": "/api/configuration/rdp/domain_membership",
"transaction": "/api/transaction"
}
}
Modify global RDP settings
To modify global RDP settings, you have to:
-
Modify the JSON object of the global RDP settings endpoint.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/rdp/options endpoint.
You can find a detailed description of the available parameters listed in Element.
For more information about the elements of the channel_database_cleanup item, see Elements of channel_database_cleanup.
For more information about the elements of the service item, see Elements of service.
| 201 |
Created |
The new resource was successfully created. |
| 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 the SPS REST API attempted to access, but could not retrieve. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that the SPS REST API attempted to access, but could not retrieve. |
| 404 |
NotFound |
The requested object does not exist. |
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.
URL
GET https://<IP-address-of-SPS>/api/configuration/rdp/settings_policies
Sample request
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>
Response
The following is a sample response received when listing RDP settings policies.
{
"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",
"timeout": 600,
"inactivity_timeout": {
"enabled": true
"value": 13000
},
"permit_unreliable_usernames": true,
"preconnect_channel_check": true,
"protocol_features": {
"nla": {
"enabled": true,
"require_domain_membership": true
},
"server_screen": 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"
}
}
| 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. |
|
inactivity_timeout |
|
Top level element |
|
|
|
enabled |
boolean |
- true: If no user activity is detected, it terminates the session after the configured time has passed since the last user activity.
- false: No user inactivity timeout.
|
|
|
value |
int |
Only if enabled is true
The value of user activity timeout. Must be greater than or equal to the value of timeout |
|
|
userauth_banner |
|
string |
You can display a banner message to the clients before authentication. |
| 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. |
| 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. |
Examples:
Turn off NLA.
{
"autologon_domain_suffix": "-AUTO",
"name": "API_test",
"permit_unreliable_usernames": true,
"preconnect_channel_check": true,
"protocol_features": {
"nla": {
"enabled": false
},
"server_screen": 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
},
"server_screen": true
},
"screen": {
"maximum_bpp": 24,
"maximum_height": 2000,
"maximum_width": 2000
},
"timeout": 600
}
Add RDP settings policies
To add a settings policy, you have to:
-
Create the JSON object for the new policy.
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"
}
}
Modify RDP settings policies
To modify a settings policy, you have to:
-
Modify the JSON object of the policy.
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.
| 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. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 |
NotFound |
The requested object does not exist. |
