Citrix ICA connections
Topics:
ICA connections
List of endpoints for configuring the policies, options and connection rules of ICA connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/ica
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 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). |
Sample request
The following command lists the available settings for configuring for ICA connections.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ica
Response
The following is a sample response received when listing the configuration settings.
For details of the meta object, see Message format.
{
"items": [
{
"key": "channel_policies",
"meta": {
"href": "/api/configuration/ica/channel_policies"
}
},
{
"key": "options",
"meta": {
"href": "/api/configuration/ica/options"
}
},
{
"key": "settings_policies",
"meta": {
"href": "/api/configuration/ica/settings_policies"
}
}
],
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/ica",
"last": "/api/configuration/x509",
"next": "/api/configuration/local_services",
"parent": "/api/configuration",
"previous": "/api/configuration/http",
"transaction": "/api/transaction"
}
}
| Item | Description |
|---|---|
| channel_policies | List of the default and custom channel policies. |
| options | List of global ICA options that affect all connections. |
| settings_policies | List of protocol-level settings (timeout, reliability). 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. |
ICA 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.
|
|
Caution:
The connection policies of this protocol are available in READ-ONLY mode on the REST API. Also, the returned data is incomplete, it does not include any protocol-specific settings, only the parameters that are common to every supported protocol. To modify the connection policies of this protocol, you must use the SPS web interface. Using the REST API, you can modify the connection policies of the RDP and SSH protocols. |
URL
GET https://<IP-address-of-SPS>/api/configuration/ica/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 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). |
Sample request
The following command lists ICA connection policies.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ica/connections/
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ica/connections/<connection-key>
ICA channels
The available ICA channel types and their functionalities are described below. For details on configuring channel policies, see Channel policy.
| Channel | Special options | Description |
|---|---|---|
| CTXTW | Yes |
Drawing (Thinwire): Enables access to the server's desktop (screen). This channel is for remoting graphics and user input (keyboard, mouse). This channel must be enabled for ICA to work. Channel-specific actions:
For example: "actions": {
"audit": true,
"four_eyes": true,
"content_policy": {
"key": "433849548566ab327522e6"
"meta": {
"href": "/api/configuration/policies/content_policies/44287216854f482e7f2b24"
}
},
} |
| CTXCAM | None | Audio Mapping: Enable access to the sound device of the server. |
| CTXCDM | None | Drive Mapping: Enable access to the client's hard drives on the server. |
| CTXCLIP | 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 the Safeguard Desktop Player cannot search or display its contents. |
| CTXSCRD | None | Smartcard: Enable using client side installed smartcards in server-side applications. |
| CTXCOM1 | None | Printer (COM1): Enable access to the serial port COM1. |
| CTXCOM2 | None | Printer (COM2): Enable access to the serial port COM2. |
| CTXLPT1 | None | Printer (LPT1): Enable access to the parallel port LPT1. |
| CTXLPT2 | None | Printer (LPT2): Enable access to the parallel port LPT2. |
| CTXCPM | None | Printer Spooler: Enable access to the client's printer from the remote desktops and applications. |
| CTXFLSH | None | HDX Mediastream: Some user widgets (for example Flash player) will not run on the server but on the client. These widgets are controlled from the server side using this channel. This is not supported by Safeguard Desktop Player and it is disabled by default. |
| CTXUSB | None | USB: Enable using client side installed USB devices in server-side applications. |
| CTXTWI | None | Seamless:Enable seamless channels that run a single application on the ICA server, instead of accessing the entire desktop. When disabled, the application window will be accessed along with an empty desktop. |
| SPDBRS | None | Speedbrowse: Speeds up web browsing. Not currently supported by Safeguard Desktop Player, should be disabled by default. |
| custom | 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, configure the channels field. Channel-specific access control rules:
|