Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 6.4.0 - 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, download, and index sessions Reporting Health and maintenance Advanced authentication and authorization Completing the Welcome Wizard using REST Enable and configure analytics using REST

ICA settings policies

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

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/ica/settings_policies

The following command retrieves the properties of a specific policy.

curl --cookie cookies 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 details of 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",
    "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"
  }
}
Element Type Description
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.

reliability Top level item Settings for ICA connection attempts.
timeout int Connection timeout, in seconds. Note that the SPS web UI displays the same value in milliseconds.
Elements of reliability Type Description
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:

  1. Open a transaction.

    For details, see Open a transaction.

  2. 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 parameter list table.

    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"
      }
    }
  3. Commit your changes.

    For details, see Commit a transaction.

Modify ICA settings policies

To modify a settings policy, you have to:

  1. Open a transaction.

    For details, see Open a transaction.

  2. 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 parameter list table.

  3. Commit your changes.

    For details, 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.
401 AuthenticationFailure Authenticating the user with the given credentials has failed.
404 NotFound The requested object does not exist.

MSSQL connections

Topics:

Limitations in handling MSSQL connections

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.
  • Server responses are currently not indexed and therefore cannot be searched in Search.
  • Downloaded audit trails can be opened with BDP, but can only be exported as PCAP.
  • The Require Gateway Authentication on the SPS Web Interface option in MSSQL Control > Connections does not work in case of MSSQL connections.

NOTE:Some clients (for example, Microsoft SQL Server Management Studio) establish more than one parallel connections at the same time. One Identity Safeguard for Privileged Sessions (SPS) arranges these into separate connections, and their contents are also arranged into separate audit trails.

AA and Credstore plugins (for example, Starling 2FA plugin) will be called multiple times and can cause unexpected results. In case of plugins that require One-Time Passwords (OTP), the already accepted OTP might suddenly become invalid.

Also, if you want to use four-eyes authorization configured for your connections, you will have to perform them for each connection.

MSSQL connections

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

URL
GET https://<IP-address-of-SPS>/api/configuration/mssql
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 MSSQL connections.

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

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

For details of the meta object, see Message format.

{
  "items": [
    {
      "key": "authentication_policies",
      "meta": {
        "href": "/api/configuration/mssql/authentication_policies"
      }
    },
    {
      "key": "channel_policies",
      "meta": {
        "href": "/api/configuration/mssql/channel_policies"
      }
    },
    {
      "key": "connections",
      "meta": {
        "href": "/api/configuration/mssql/connections"
      }
    },
    {
      "key": "options",
      "meta": {
        "href": "/api/configuration/mssql/options"
      }
    },
    {
      "key": "settings_policies",
      "meta": {
        "href": "/api/configuration/mssql/settings_policies"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/aaa",
    "href": "/api/configuration/mssql",
    "last": "/api/configuration/x509",
    "next": "/api/configuration/network",
    "parent": "/api/configuration",
    "previous": "/api/configuration/management",
    "remaining_seconds": 600,
    "transaction": "/api/transaction"
  }
}
Item Description
connections List of connection policies.
authentication_policies List of the default and custom authentication policies.
channel_policies List of the default and custom channel policies.
options List of global MSSQL options that affect all connections.
settings_policies List of protocol-level settings (idle and session timeout). 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.
401 AuthenticationFailure Authenticating the user with the given credentials has failed.
404 NotFound The requested object does not exist.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating