Chatee ahora con Soporte
Chat con el soporte

One Identity Safeguard for Privileged Sessions 7.1 - REST API Reference Guide

Introduction Using the SPS REST API Basic settings User management and access control Managing SPS General connection settings HTTP connections Citrix ICA connections MSSQL connections RDP connections SSH connections Telnet connections VNC connections Search, retrieve, download, and index sessions Reporting Health and maintenance Advanced authentication and authorization Completing the Welcome Wizard using REST Enable and configure analytics using REST

RDP connections

List of endpoints for configuring the policies, options and connection rules of RDP connections.

URL
GET https://<IP-address-of-SPS>/api/configuration/rdp
Cookies
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 more information on authentication, see Authenticate to the SPS REST API.

NOTE: 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).
Sample request

The following command lists the available settings for configuring for RDP connections.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/rdp
Response

The following is a sample response received when listing the configuration settings.

For more information on the meta object, see Message format.

{
  "items": [
    {
      "key": "channel_policies",
      "meta": {
        "href": "/api/configuration/rdp/channel_policies"
      }
    },
    {
      "key": "connections",
      "meta": {
        "href": "/api/configuration/rdp/connections"
      }
    },
    {
      "key": "domain_membership",
      "meta": {
        "href": "/api/configuration/rdp/domain_membership"
      }
    },
    {
      "key": "options",
      "meta": {
        "href": "/api/configuration/rdp/options"
      }
    },
    {
      "key": "settings_policies",
      "meta": {
        "href": "/api/configuration/rdp/settings_policies"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/aaa",
    "href": "/api/configuration/rdp",
    "last": "/api/configuration/x509",
    "next": "/api/configuration/reporting",
    "parent": "/api/configuration",
    "previous": "/api/configuration/private_keys",
    "transaction": "/api/transaction"
  }
}
Item Description
channel_policies List of the default and custom channel policies.
connections List of connection policies.
domain_membership Domain membership configuration. Prerequisite for configuring Credential Security Service Provider / Network Layer Authentication.
options List of global RDP options that affect all connections.
settings_policies List of protocol-level settings (timeout, display, protocol version, and authentication). You can create multiple variations, and choose the appropriate one for each connection policy.
Status and error codes

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.
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.

RDP connection policies

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.

URL
GET https://<IP-address-of-SPS>/api/configuration/rdp/connections/
Cookies
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 more information on authentication, see Authenticate to the SPS REST API.

NOTE: 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).
Sample request

The following command lists RDP connection policies.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/rdp/connections/

The following command retrieves the properties of a specific policy.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/rdp/connections/<connection-key>
Response

The following is a sample response received when listing RDP connection policies.

For more information on the meta object, see Message format.

{
    "items": [
        {
            "key": "12932832285a830b4d2f5d7",
            "meta": {
                "href": "/api/configuration/rdp/connections/12932832285a830b4d2f5d7"
            }
        }
    ],
    "meta": {
        "first": "/api/configuration/rdp/channel_policies",
        "href": "/api/configuration/rdp/connections",
        "last": "/api/configuration/rdp/settings_policies",
        "next": "/api/configuration/rdp/domain_membership",
        "parent": "/api/configuration/rdp",
        "previous": "/api/configuration/rdp/channel_policies",
        "remaining_seconds": 600,
        "transaction": "/api/transaction"
    }
}

When retrieving the endpoint of a specific RDP 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
        },
        "indexing": {
            "enabled": true,
            "policy": {
                "key": "-50000",
                "meta": {
                    "href": "/api/configuration/policies/indexing/-50000"
                }
            },
            "priority": 3
        },
        "log_audit_trail_downloads": true,
        "name": "rdp_demo",
        "network": {
            "clients": [
                "0.0.0.0/0"
            ],
            "ports": [
                3389
            ],
            "targets": [
                "10.30.255.28/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"
                }
            },
            "backup_policy": {
                "key": "512524636571b903540804",
                "meta": {
                    "href": "/api/configuration/policies/backup_policies/512524636571b903540804"
                }
            },
            "channel_policy": {
                "key": "-20200",
                "meta": {
                    "href": "/api/configuration/rdp/channel_policies/-20200"
                }
            },
            "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": "-301",
                "meta": {
                    "href": "/api/configuration/rdp/settings_policies/-301"
                }
            },
            "usermapping_policy": null
        },
        "rate_limit": {
            "enabled": false
        },
        "remote_desktop_gateway": {
            "enabled": false
        },
        "server_address": {
            "address": "10.30.255.70",
            "port": 3389,
            "selection": "fix"
        },
        "source_address": {
            "selection": "box_address"
        },
        "transport_security": {
            "certificate": {
                "selection": "self_signed"
            },
            "server_certificate_check": {
               "enabled": false
            },
            "legacy_fallback": false,
            "selection": "tls"
        },
        "web_gateway_authentication": {
            "enabled": false
        }
    },
    "key": "12932832285a830b4d2f5d7",
    "meta": {
        "first": "/api/configuration/rdp/connections/12932832285a830b4d2f5d7",
        "href": "/api/configuration/rdp/connections/12932832285a830b4d2f5d7",
        "last": "/api/configuration/rdp/connections/12932832285a830b4d2f5d7",
        "next": null,
        "parent": "/api/configuration/rdp/connections",
        "previous": null,
        "remaining_seconds": 600,
        "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:

  • 5

    Very low priority.

  • 4

    Low priority.

  • 3

    Normal (default) priority.

  • 2

    High priority.

  • 1

    Very high priority.

  • 0

    Near real-time priority.

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.
override_log_level Top level item

Specifies the verbosity level of sessions handled by this connection policy. The log level of other connection policies is not affected. If disabled, the log level set at the /api/configuration/<protocol>/options endpoint is used.

  • To use the default log level, disable this option:

    "override_log_level": {
    "enabled": false
},

  • To use a custom log level for the connection policy, enable this option and set the log level to use:

    "override_log_level": {
    "enabled": true,
    "log_level": 5
},
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_policy 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).

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 RDP channel policies at the /api/configuration/rdp/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 RDP 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.
remote_desktop_gateway Top level element

Configure SPS to act as a Remote Desktop Gateway. Otherwise, simply disable this option:

"remote_desktop_gateway": {
    "enabled": false
},
server_address Top level item Defines the address where the clients connect to.
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:

  • box_address

    Default. Uses the network address of the logical interface of SPS.

  • original

    Uses the IP address of the client, as seen by SPS.

  • fix

    Uses a fixed address when connecting to the remote server.

    Must be used with the address element.

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.

transport_security Top level element

Configures the encryption used in the sessions.

certificate JSON object

Selects the certificate to show to the peers. You have the following options:

  • Use a self-signed certificate:

    Select this option if you want to enable TLS-encryption, but you do not have a certificate that is generated by an external CA, or a signing CA.

    "certificate": {
        "selection": "self_signed"
    }
  • Use the same certificate for each client:

    Select this option if you want to use the same certificate for every peer. Note that you must reference a certificate that includes its private key that you have already uploaded to SPS. For details, see Certificates stored on SPS.

    "certificate": {
    "selection": "fix",
    "x509_identity": "893b7eb7-8c6f-403a-ba3a-1d09dc4b4c7a"
}
  • Generate a certificate for each client:

    Select this option if you want to generate a certificate for each client. Note that you must reference a Signing CA that you have already configured on SPS. For details, see Signing CA policies.

    "certificate": {
    "selection": "generate",
    "signing_ca": "1904188625a843f11d30a5"
},
server_certificate_check JSON object

By default, SPS accepts any certificate shown by the server.

"server_certificate_check": {
   "enabled": false
},

To verify the certificate of the destination server, configure and reference a Trusted CA list.

"server_certificate_check": {
   "enabled": true,
   "trusted_ca": "9106862955a844051d7bf6"
},
legacy_fallback boolean

Set to true to permit the clients to disable TLS encryption and use only the Legacy RDP Security Layer (also known as: Standard RDP Security). You might want to do this if you are experiencing compatibility issues. For example, when you attempt to connect to a very old Windows machine (for example, Windows Server 2003 or older).

 Caution:

Security Hazard!

Selecting this option can significantly reduce the strength of the encryption used!

selection legacy | tls

Configures the encryption used in the sessions.

  • legacy: Disables TLS encryption for RDP connections completely, and uses only the Legacy RDP Security Layer (also known as: Standard RDP Security). You might want to do this if you are experiencing compatibility issues. For example, when you attempt to connect to a very old Windows machine (for example, Windows Server 2003 or older).

    		 Caution:

    Security Hazard!

    Selecting this option can significantly reduce the strength of the encryption used!

    "transport_security": {
    "selection": "legacy"
},

  • tls: Enables TLS-encryption. Note that you must also set the certificate, server_certificate_check, and legacy_fallback options.

    "transport_security": {
    "certificate": {
        "selection": "self_signed"
    },
    "server_certificate_check": {
        "enabled": false
    },
    "legacy_fallback": false,
    "selection": "tls"
}
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
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:

  • audit

    The usergroup with the audit permission can monitor ongoing connections, and download the audit trails of a closed and indexed connection.

  • authorize

    The usergroup with the authorize permission can authorize connection requests.

  • audit_and_authorize

    The usergroup with the audit_and_authorize permission can authorize connection requests, monitor connections, and download the audit trail of closed and indexed connections.

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:

  • everybody

    Every user is subject to the access control policy.

  • only

    Requires the group element.

    Members of the usergroup specified in the group element are subject to the access control policy.

Elements of remote_desktop_gateway Type Description
enabled boolean

Set to true and configure the other options as needed for your environment to use SPS as a Remote Desktop Gateway. For details and prerequisites, see "Using One Identity Safeguard for Privileged Sessions (SPS) as a Remote Desktop Gateway" in the Administration Guide.

certificate JSON object

To act as a Remote Desktop Gateway, SPS needs to display a certificate to the clients.

  • To automatically create new certificates on SPS for every client, set "selection": "generate", and reference the Certificate Authority (CA) to sign the generated certificates. For example:

    "certificate": {
    "selection": "generate",
    "value": {
        "signing_ca": "53449998258a4ceba80fdc"
        },
        "common_name": "examplecn"
    }

    For details on uploading certificates, see Certificates stored on SPS.

  • To always display the same certificate, set "selection": "fix", and reference an X.509 certificate and the matching private key. For example:

    "certificate": {
        "selection": "fix",
        "value": "1904188625a843f11d30a5"
    },

    For details on creating a signing CA, see Signing CA policies.

selection generate | fix

Determines if SPS displays the same certificate to every client (fix), or generates a separate certificate (generate) for every client.

value JSON object or string

Contains the options and parameters related to the option set in selection.

  • If selection is set to generate, this is a JSON object.

  • If selection is set to fix, this is a string containing the reference ID of the certificate that SPS displays to the clients.

common_name string

Available only if selection is set to generate. You can specify the Common Name of the generated certificates in this parameter. For example:

"common_name": "examplecn"

If set to null, the Common Name of the certificates will be SPS-hostname.domainname

signing_ca string

Available only if selection is set to generate. Contains the reference key of the signing CA used to sign the certificates that SPS shows to the clients. For example:

"signing_ca": "1904188625a843f11d30a5"

If set to null, the Common Name of the certificates will be SPS-hostname.domainname

local_authentication JSON object

Determines how SPS authenticates the clients: either using Active Directory (SPS must be member of a domain), or using a Local User Database.

selection active_directory | local_user_database

Determines how SPS authenticates the clients:

  • using Active Directory (SPS must be member of a domain)

    "local_authentication": {
    "selection": "local_user_database",
    "value": {
        "domain": "example",
        "local_user_database": "15646962145a843f758501d"
        }
    }

  • using a Local User Database.

    "local_authentication": {
    "selection": "active_directory",
    "value": null
}
value JSON object

Set to null if selection is set to active_directory.

If selection is set to local_user_database, value contains a JSON object with the domain and local_user_database keys.

domain string

Available only if selection is set to local_user_database.

local_user_database string

Available only if selection is set to local_user_database. Contains the reference ID of a Local User Database that SPS will use to authenticate the clients.
Elements of server_address Type Description
custom_dns string

Configures a DNS server that is used to reverse-resolve the hostname if the Channel Policy contains the address of the target as a hostname instead of an IP address. By default, this is disabled and SPS uses the DNS server set in the /api/configuration/network/dns endpoint.

  • To use the default DNS, disable this option:

    "server_address": {
    "custom_dns": {
        "enabled": false
    },
    ...
},

  • To use a custom DNS, enable this option and set the IP address of the domain name server to use:

    "server_address": {
    "custom_dns": {
        "enabled": true,
        "server": "192.168.1.1"
    },
    ...
},
selection string

Configures the address where the clients connect to. Possible values are:

  • original

    Connect to the same address specified by the client.

  • nat

    Perform a network address translation on the target address.

    Must be used with the network element.

  • fix

    Must be used with the address and port elements.

  • inband

    Extract the address of the server from the username.

    Must be used with the domains element.

    Optional elements: exception_domains, dns_server, and dns_suffixes.

network string

Must be used if selection is set to nat.

The target address in IP/prefix format. Example: "10.20.30.40/24".

address string

Must be used if selection is set to fix.

The IP address of the target server.

port int

Must be used if selection is set to fix.

The port of the target server.

domains Top level list

Must be used if selection is set to inband.

domain Top level item Lists the address ranges that are included in the connection policy.
selection string

Specifies if the target address range is provided as a domain or as an IP range. Possible values are:

  • address

    The value of the target address is an IP range.

  • domain

    The value of the target address is a domain.

value string

The address range of the target server(s).

Use the selection element to specify if the address is an IP range, or a domain.

port int The port of the targer server(s).
exception_domains Top level list

Can only be used if selection is set to inband.

Lists the address ranges that are excluded from the connection policy.

domain Top level item Contains the excluded address range.
selection string

Specifies if the excluded address(es) are provided as a domain or as an IP range. Possible values are:

  • address

    The value of the excluded address is an IP range.

  • domain

    The value of the excluded address is a domain.

value string

The excluded address(es).

Use the selection element to specify if the address is an IP range, or a domain.

port int The excluded port.
dns_server string

Can only be used if selection is set to inband.

IP address or the hostname of the domain name server used to resolve the address of the target server.

dns_suffixes list, string

Can only be used if selection is set to inband.

If the clients do not include the domain name when addressing the server (for example they use username@server instead of username@server.example.com), SPS can automatically add domain information (for example example.com).

You can add multiple domain names. SPS attempts to resolve the target address by appending the domain names in the provided order, and uses the first successfully resolved address to establish the connection.

Examples

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"
    }
  }

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
}

Policies: configure only the required policies.

"policies": {
  "aa_plugin": null,
  "analytics_policy": null,
  "archive_cleanup_policy": null,
  "audit_policy": "<key-of-audit-policy>",
  "backup_policy": null,
  "channel_policy": "<key-of-channel-policy>",
  "credential_store": null,
  "ldap_server": null,
  "settings": "<key-of-settings-policy>",
  "usermapping_policy": null
}
Status and error codes

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.
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.
Add a connection policy

To add an RDP connection policy, you have to:

  1. Open a transaction.

    For more information, see Open a transaction.

  2. Create the JSON object for the new RDP connection policy.

    POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/rdp/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 connection policy. For example:

    {
  "key": "a99be49b-b0a2-4cf9-b70d-fea1f9ea188f",
  "meta": {
    "href": "/api/configuration/rdp/connections/a99be49b-b0a2-4cf9-b70d-fea1f9ea188f",
    "parent": "/api/configuration/rdp/connections",
    "transaction": "/api/transaction"
  }
}
  3. Commit your changes.

    For more information, see Commit a transaction.

Modify an RDP connection policy

To modify an RDP connection policy, you have to:

  1. Open a transaction.

    For more information, see Open a transaction.

  2. Modify the JSON object of the connection policy.

    PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/rdp/connections/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in Element .

  3. Commit your changes.

    For more information, see Commit a transaction.

RDP channels

The available RDP channel types and their functionalities are described below. For details on configuring channel policies, see Channel policy.

Channel Special options Description
#drawing Yes

Drawing: Enables access to the server's graphical desktop (screen). This channel must be enabled for RDP to work.

Channel-specific actions:

  • content_policy reference: The ID of the Content policy to apply to the connection.

For example:

"actions": {
  "audit": true,
  "content_policy": {
    "key": "433849548566ab327522e6"
  },
  "four_eyes": false,
  "ids": false
}
cliprdr None Clipboard: Enable access to the server's clipboard: the clipboard of the remote desktop can be pasted into local applications (and vice-versa). Note that SPS can audit the clipboard channel, but cannot search or display its contents.
rdpdr Yes

Redirects: Enables access to every device redirections available in RDP, like file-sharing, printer sharing, device (for example CD-ROM) sharing, and so on. To enable only a specific type of redirection, use the specific channels instead (for example, rdpdr-serial for serial device redirection).

Channel-specific actions:

  • log_transfer_to_db (true|false): Make the list of file operations available in the Search > File operations column of the SPS web interface

  • log_transfer_to_syslog (true|false): Send the file operations into the system log

Channel-specific access control rules:

  • devices (list): To permit only specific redirections, list the unique name of the redirection in this field. Leave it empty to permit access to every redirection available.

rdpsnd None

Sound: Enable access to the sound device of the server.

customs Yes

Custom: Applications can open custom channels to the clients connecting remotely to the server. Enabling the Custom channel allows the clients to access all of these custom channels. To permit only specific channels, list the unique names of the channels into the customs field.

For example, to monitor RemoteApp connections, you need to configure custom channels. For more information, see "Configuring RemoteApps" in the Administration Guide.

Channel-specific access control rules:

  • customs (list): To permit only specific custom channels, list the unique name of the channels in this field. Leave it empty to permit access to every custom channel available.

seamrdp None Seamless: Enable seamless channels that run a single application on the RDP server, instead of accessing the entire desktop.
drdynvc Yes

Dynamic virtual channel: Enable the server to open channels back to the client dynamically. Enabling this channel allows access to all of such dynamic channels. To restrict which dynamic channels are permitted, list the unique names of the channels into the drdynvcs field.

Channel-specific access control rules:

  • drdynvcs (list): To restrict which dynamic channels are permitted, list the unique names of the channels in this field. Leave it empty to permit access to every dynamic channel available.

rdpdr-serial Yes

Serial redirect: Enables access to serial-port redirections. To restrict access to specific redirections, list the unique names of the channels in the devices field.

Channel-specific access control rules:

  • devices (list): To permit only specific redirections, list the unique name of the redirection in this field. Leave it empty to permit access to every redirection available.

rdpdr-parallel Yes

Parallel redirect: Enables access to parallel-port redirections. To restrict access to specific redirections, list the unique names of the channels in the devices field.

Channel-specific access control rules:

  • devices (list): To permit only specific redirections, list the unique name of the redirection in this field. Leave it empty to permit access to every redirection available.

rdpdr-printer Yes

Printer redirect: Enables access to printer-port redirections. To restrict access to specific redirections, list the unique names of the channels in the devices field.

Channel-specific access control rules:

  • devices (list): To permit only specific redirections, list the unique name of the redirection in this field. Leave it empty to permit access to every redirection available.

rdpdr-disk Yes

Disk redirect: Enables access to shared disk drives. To restrict access to specific redirections, list the unique names of the channels in the devices field, for example:

"devices": [
  "C:"
                        
Channel-specific actions:
  • log_transfer_to_db (true|false): Make the list of file operations available in the Search > File operations column of the SPS web interface
  • log_transfer_to_syslog (true|false): Send the file operations into the system log
Channel-specific access control rules:
  • devices (list): To permit only specific redirections, list the unique name of the redirection in this field. Leave it empty to permit access to every redirection available.
rdpdr-scard Yes

SCard redirect:Enables access to shared SCard devices. To restrict access to specific redirections, list the unique names of the channels in the devices field, for example:

Channel-specific access control rules:

  • devices (list): To permit only specific redirections, list the unique name of the redirection in this field. Leave it empty to permit access to every redirection available.

Configuring domain membership

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 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
Cookies
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 more information on authentication, see Authenticate to the SPS REST API.

NOTE: 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).
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.

For more information on the meta object, see Message format.

{
  "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"
  }
}
Element Type Description
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:

  1. Open a transaction.

    For more information, see Open a transaction.

  2. 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 .

  3. Commit your changes.

    For more information, see Commit a transaction.

Status and error codes

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.
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.
Documentos relacionados

The document was helpful.

Seleccionar calificación

I easily found the information I needed.

Seleccionar calificación