List of options that affect all ICA connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/ica/options
Cookies
| 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 global ICA options.
curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/ica/options
Response
The following is a sample response received when listing the list of default global ICA options.
For more information on the meta object, see Message format.
{
"body": {
"channel_database_cleanup": {
"enabled": false
},
"service": {
"enabled": false
}
}
}
"key": "options",
"meta": {
"first": "/api/configuration/ica/channel_policies",
"href": "/api/configuration/ica/options",
"last": "/api/configuration/ica/settings_policies",
"next": "/api/configuration/ica/settings_policies",
"parent": "/api/configuration/ica",
"previous": "/api/configuration/ica/channel_policies",
"transaction": "/api/transaction"
}
}
| key |
|
Top level item |
Contains the ID of the endpoint. |
| body |
|
Top level item |
Contains the elements of the global ICA options. |
| |
channel_database_cleanup |
Top level item |
Contains settings for database cleanup. |
| |
service |
Top level item |
Global setting to enable ICA connections, and specify the logging detail. |
| days |
integer |
Applies only if enabled is set to true.
Global retention time for the metadata of ICA connections, in days. Must exceed the retention time of the archiving policy (or policies) used for ICA connections, and the connection-specific database cleanup times (if configured). |
|
enabled |
boolean |
To enable the global cleanup of ICA connection metadata, set enabled to true. |
| log_level |
integer |
Applies only if enabled is set to true.
Defines the logging detail of ICA connections. |
|
enabled |
boolean |
To enable ICA connections, set to true. |
Examples
Querying the full list of global ICA options:
{
"body": {
"channel_database_cleanup": {
"enabled": true,
"days": 365
},
"service": {
"enabled": true,
"log_level": 4
}
}
"key": "options",
"meta": {
"first": "/api/configuration/ica/channel_policies",
"href": "/api/configuration/ica/options",
"last": "/api/configuration/ica/settings_policies",
"next": "/api/configuration/ica/settings_policies",
"parent": "/api/configuration/ica",
"previous": "/api/configuration/ica/channel_policies",
"transaction": "/api/transaction"
}
}
Modify global ICA settings
To modify global ICA settings, you have to:
-
Open a transaction.
For more information, see Open a transaction.
-
Modify the JSON object of the global ICA settings endpoint.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/ica/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.
-
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.
| 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. |
ICA settings policies define protocol-level settings (timeout, reliability). You can create multiple policies, and choose the appropriate one for each ICA connection.
URL
GET https://<IP-address-of-SPS>/api/configuration/ica/settings_policies
Cookies
| 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 ICA settings policies.
curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/ica/settings_policies
The following command retrieves the properties of a specific policy.
curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/ica/settings_policies/<policy-id>
Response
The following is a sample response received when listing ICA settings policies.
For more information on the meta object, see Message format.
{
"items": [
{
"key": "-301101020",
"meta": {
"href": "/api/configuration/ica/settings_policies/-301101020"
}
}
],
"meta": {
"first": "/api/configuration/ica/channel_policies",
"href": "/api/configuration/ica/settings_policies",
"last": "/api/configuration/ica/settings_policies",
"next": null,
"parent": "/api/configuration/ica",
"previous": "/api/configuration/ica/options",
"transaction": "/api/transaction"
}
}
When retrieving the endpoint of a specific policy, the response is the following.
{
"body": {
"name": "default",
"timeout": 600,
"inactivity_timeout": {
"enabled": true
"value": 13000
},
"preconnect_channel_check": false,
"reliability": {
"reconnect_attempts": 30,
"reconnect_sleep": 2,
"reconnect_timeout": 600
},
"timeout": 600
},
"key": "-301101020",
"meta": {
"first": "/api/configuration/ica/settings_policies/-301101020",
"href": "/api/configuration/ica/settings_policies/-301101020",
"last": "/api/configuration/ica/settings_policies/-301101020",
"next": null,
"parent": "/api/configuration/ica/settings_policies",
"previous": null,
"transaction": "/api/transaction"
}
}
| key |
|
|
string |
Top level element, contains the ID of the policy. |
| body |
|
|
Top level element (string) |
The elements of the ICA settings policy. |
|
name |
|
string |
Name of the ICA settings policy. Cannot contain whitespace. |
|
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. |
|
Elements of reliability |
|
Top level item |
Settings for ICA connection attempts. |
|
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 |
| reconnect_attempts |
int |
The number of times SPS attempts to connect to the target server. |
| reconnect_sleep |
int |
The number of seconds SPS waits between connection attempts. |
| reconnect_timeout |
int |
The number of seconds SPS waits after exhausting the number of reconnect_attempts. |
Add ICA settings policies
To add a settings policy, you have to:
-
Open a transaction.
For more information, see Open a transaction.
-
Create the JSON object for the new policy.
POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/ica/settings_policies/ endpoint. You can find a detailed description of the available parameters listed in the Element .
If the POST request is successful, the response includes the key of the new policy. For example:
{
"key": "dcd58077-98b3-4c73-8f0b-b34147863028",
"meta": {
"href": "/api/configuration/ica/settings_policies/dcd58077-98b3-4c73-8f0b-b34147863028",
"parent": "/api/configuration/ica/settings_policies",
"transaction": "/api/transaction"
}
}
-
Commit your changes.
For more information, see Commit a transaction.
Modify ICA settings policies
To modify a settings policy, you have to:
-
Open a transaction.
For more information, see Open a transaction.
-
Modify the JSON object of the policy.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/ica/settings_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in the Element .
-
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.
| 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. |
The current version of One Identity Safeguard for Privileged Sessions (SPS) has the following limitations:
- TDS protocol version 7.3 or later is required.
- Due to the TDS protocol version requirement, Microsoft® SQL Server® 2008, or later, is recommended.
- The Require Gateway Authentication on the SPS Web Interface option in Traffic Controls > MSSQL > Connections does not work in case of MSSQL connections.
-
MSSQL server with TCP dynamic port settings is not supported.
You must specify a static TCP port for every instance in the SQL Server Configuration Manager you want to audit. By doing so, you can configure the access to multiple MSSQL instances with multiple connection policies and specify the instances with inband or fixed targets and ports. You can also create and assign different Credential Store policies to check out SQL users' passwords of the instances.
In the MSSQL client program, always specify the address with the port number of the SPS connection policy you want to connect to.
