Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 6.5.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

Manage the SPS license

You can display information about the currently used SPS license from the https://<IP-address-of-SPS>/api/configuration/management/license endpoint.

 Caution:

Accessing the One Identity Safeguard for Privileged Sessions (SPS) host directly using SSH is not recommended or supported, except for troubleshooting purposes. In such case, the One Identity Support Team will give you exact instructions on what to do to solve the problem.

For security reasons, disable SSH access to SPS when it is not needed. For details, see "Enabling SSH access to the One Identity Safeguard for Privileged Sessions (SPS) host" in the Administration Guide.

The following encryption algorithms are configured on the local SSH service of SPS:

  • Key exchange (KEX) algorithms:

    diffie-hellman-group-exchange-sha256

  • Ciphers:

    aes256-ctr,aes128-ctr

  • Message authentication codes:

    hmac-sha2-512,hmac-sha2-256
URL
GET https://<IP-address-of-SPS>/api/configuration/management/license
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 configuration options.

curl --cookie cookies -H "Content-Type: application/json" https://10.30.255.28/api/configuration/management/license
Response

The following is a sample response received.

For details of the meta object, see Message format.

{
    "body": {
        "customer": "Example",
        "limit": 5000,
        "limit_type": "host",
        "serial": "b937d212-db7d-0f2f-4c87-295e3c57024a",
        "valid_not_after": "2018-11-07",
        "valid_not_before": "2017-11-06"
    },
    "key": "license",
    "meta": {
        "first": "/api/configuration/management/certificates",
        "href": "/api/configuration/management/license",
        "last": "/api/configuration/management/webinterface",
        "next": "/api/configuration/management/root_password",
        "parent": "/api/configuration/management",
        "previous": "/api/configuration/management/health_monitoring",
        "remaining_seconds": 600,
        "transaction": "/api/transaction",
        "upload": "/api/upload/license"
    }
}
Element Type Description
key string Top level element, contains the ID of the endpoint.
body Top level element (string) Contains the parameters of the license.
customer string The company permitted to use the license (for example, Example Ltd.).
limit integer The actual value of the session or host limit (see limit_type).
limit_type host | session

  • host: Limits the number of servers (individual IP addresses) that can be connected through SPS.

  • session: Limits the number of concurrent sessions (parallel connections) that can pass through SPS at a time (for example 25). SPS will reject additional connection requests until an already established connection is closed.

serial string

The unique serial number of the license.

valid_not_after date

The date when the license expires. The dates are displayed in YYYY/MM/DD format.

valid_not_before date

The date after which the license is valid. The dates are displayed in YYYY/MM/DD format.
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.
Upload a new license

To upload a new license file, complete the following steps.

  1. Download your license file from support portal.

  2. Open a transaction.

    For details, see Open a transaction.

  3. Upload the license file.

    Upload the file to the https://<IP-address-of-SPS>/api/upload/license endpoint. For example:

    curl --cookie cookies -F 'data=@/path/license.txt' -H "Expect:" --insecure https://<IP-address-of-SPS>/api/upload/license
  4. Restart the traffic on SPS.

    SPS will not use the new license to ongoing sessions. For the new license to take full effect, you must restart all traffic on the Basic Settings > System > Traffic control page of the SPS web interface.

    curl --cookie cookies -F 'data=@/path/license.txt' -H "Expect:" --insecure https://<IP-address-of-SPS>/api/upload/license
  5. Commit your changes.

    For details, see Commit a transaction.

Change contact information

The About page on the SPS web interface and the /api/info endpoint contains various contact information. You can change this to a custom email address or URL.

URL
GET https://<IP-address-of-SPS>/api/configuration/management/support_info
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 RPC API settings.

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

The following is a sample response received when querying the endpoint.

For details of the meta object, see Message format.

{
    "body": {
        "uri": null
    },
    "key": "support_info",
    "meta": {
        "first": "/api/configuration/management/certificates",
        "href": "/api/configuration/management/support_info",
        "last": "/api/configuration/management/webinterface",
        "next": "/api/configuration/management/syslog",
        "parent": "/api/configuration/management",
        "previous": "/api/configuration/management/splunk_forwarder",
        "remaining_seconds": 600,
        "transaction": "/api/transaction"
    }
Change the support link

To change the support link, complete the following steps.

  1. Open a transaction.

    For details, see Open a transaction.

  2. PUT a JSON object containing the new support link.

    PUT a JSON object containing the new support link to the https://<IP-address-of-SPS>/api/configuration/management/support_info endpoint. For example:

    curl -X PUT -d '{"uri": { "selection": "mailto", "value": "mailto:support@example.com" } }' -H "Content-Type: application/json" --cookie cookies "https://<IP-address-of-SPS>/api/configuration/management/support_info"

    To use an HTTP or HTTPS link as contact info, use the following JSON object:

    {
  "uri": {
    "selection": "url",
    "value": "http://example.com"
   }
}

    To use a email address as contact info, use the following JSON object:

    {
  "uri": {
    "selection": "mailto",
    "value": "mailto:support@example.com"
   }
}
  3. Commit your changes.

    For details, see Commit a transaction.

Splunk integration

SPS can forward session data to Splunk near real-time. Using the One Identity Safeguard for Privileged Sessions App for Splunk you can integrate this data with your other sources, and access all your data related to privileged user activities from a single interface. To configure SPS to forward session data to Splunk, complete the following steps.

Prerequisites and restrictions:

  • SPS version 5 F5 or later

  • Splunk version 6.5 or later

  • SPS does not send historical data to Splunk, only data from the sessions started after you complete this procedure.

URL
GET https://<IP-address-of-SPS>/api/configuration/management/splunk_forwarder
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 endpoints for SNMP configuration settings.

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

The following is a sample response received when querying the endpoint.

For details of the meta object, see Message format.

{
"body": {
    "enabled": true,
    "flush_interval": 600,
    "host":
        { "selection": "fqdn", "value": "splunk.example.com" },
    "pam_address":
        { "selection": "fqdn", "value": "scb.example.com" },
    "port": 8088,
    "ssl":
        { "selection": "insecure" },
    "token": "2134356431"
    }
}
Elements of remote_desktop_gateway Type Description
body JSON object Top-level element
enabled boolean

Set to true and configure the other options as needed for your environment to forward session data from SPS to Splunk.

flush_interval integer [seconds] If the Splunk server becomes unaccessible, SPS will try to resend the data when this period expires.
host JSON object

Contains the hostname or the IPv4 address of the Splunk server.

"host":
    { "selection": "fqdn", "value": "splunk.example.com" },
"host":
    { "selection": "ip", "value": "192.168.1.1" },
selection fqdn | ip

Defines the address type (IP or domain name). Possible values are:

  • fqdn: The server address is provided as a fully qualified domain name.

  • ip: The server address is provided as an IPv4 address.

value string

The address of the server.

port integer

The port number where your Splunk HTTP Event Collector is accepting connections. By default, Splunk uses port 8088.

ssl JSON object

Determines if encryption is used between SPS and Splunk.

selection string

Determines if encryption is used between SPS and Splunk. Possible values:

  • disabled: Use this option if your Splunk HTTP Event Collector accepts only unencrypted HTTP connections.

    Since the data forwarded to Splunk contains sensitive information, One Identity recommends to use HTTPS encryption between SPS and Splunk.

    "ssl": { "selection": "disabled" },

  • insecure: Use HTTPS encryption between SPS and Splunk.

    "ssl": { "selection": "insecure" },

  • secure: Use HTTPS encryption between SPS and Splunk and also verify the identity of the Splunk server. If you use this option, you must include the certificate of the Splunk server, or the certificate of the CA that issued the certificate of the Splunk server in the certificate option.

    "ssl":
    { "certificate": "-----BEGIN CERTIFICATE-----\nMIIFPzCCAyegA\n....\nr8lDCPoq\n0wgJ\n-----END CERTIFICATE-----\n",
    "selection": "secure"
    },
token string

The HTTP Event Collector authentication token you have generated for SPS.
Configure Splunk forwarder

  1. Install the One Identity Safeguard for Privileged Sessions App for Splunk to your Splunk installation. This will automatically enable and configure the HTTP Event Collector (HEC) in your Splunk installation, and create an HTTP Event Collector authentication token ("HEC token") that SPS will use.

    To help identify the source of the received data, the following settings are configured automatically in the One Identity Safeguard for Privileged Sessions App for Splunk:

    • index: The One Identity Safeguard for Privileged Sessions App for Splunk creates the index automatically, with the name balabit_events.

    • sourcetype: The source type of the events the SPS fowards is balabit:event.

  2. On your Splunk interface, navigate to Settings > Data inputs > HTTP Event Collector. Copy the Token Value from the Balabit_HEC field. This is the HTTP Event Collector authentication token and you will need it when configuring SPS.

  3. Create the JSON object that configures SPS to forward session data to Splunk.

    POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/management/splunk_forwarder endpoint. You can find a detailed description of the available parameters listed in Elements of remote_desktop_gateway. For example,

    {
    "enabled": true,
    "flush_interval": 600,
    "host":
        { "selection": "fqdn", "value": "splunk.example.com" },
    "pam_address":
        { "selection": "fqdn", "value": "psm.example.com" },
    "port": 8088,
    "ssl":
        { "selection": "insecure" },
    "token": "2134356431"
}
  4. Commit your changes.

    For details, see Commit a transaction.

  5. Splunk will display the data received from SPS as it was received from the host set in the pam_address field. By default, this is the hostname and domain name of the SPS appliance as set on the /api/configuration/network/naming endpoint. Adjust this field as needed for your environment.

  6. Start a session that SPS will audit to test your configuration, and verify that the data of the session appears in Splunk.

Splunk integration

The universal SIEM forwarder can automatically send data about the audited sessions to Splunk, ArcSight, or other third-party systems. The messages are standard syslog messages in RFC3164 format (also called legacy-syslog or BSD-syslog format). The body of the syslog message (the MESSAGE part) can be formatted as JavaScript Object Notation (JSON), Common Event Format (CEF), or JSON-CIM format. For information about the details of the messages that the universal SIEM forwarder sends to the external SIEM network elements, see Message format forwarded to SIEMs.

One of the main advantages of the universal SIEM forwarder is that it has a lower impact on network and performance.

Each message contains the minimal information relevant to the event. Use the built-in correlation feature of the SIEM to combine events by session ID and view all information in one place.

Prerequisites and restrictions

  • SPS version 5 F9 or later

  • Splunk version 6.5 or later

  • The CEF format is supported on all currently supported versions of ArcSight ESM, IBM QRadar and Microsoft Azure Sentinel.

  • SPS does not send historical data, only data from the sessions started after you complete this procedure.

URL
GET https://<IP-address-of-SPS>/api/configuration/management/universal_siem_forwarder
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 endpoints for SNMP configuration settings.

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

The following is a sample response received when querying the endpoint.

For details of the meta object, see Message format.

{
    "body": {
        "enabled": true,
        "prefix": "myprefix",
        "targets": [
            {
                "format": "json_cim",
                "name": "siem_target",
                "protocol": {
                    "selection": "syslog",
                    "value": {
                        "address": {
                            "selection": "ip",
                            "value": "192.168.1.1"
                        },
                        "port": 5555,
                        "tls": {
                            "selection": "disabled"
                        }
                    }
                }
            }
        ]
     }
Elements Type Description
body JSON object Top-level element
enabled boolean

Set to true and configure the other options as needed for your environment to forward session data from SPS to an external SIEM device.

prefix string

A prefix to make the data more readable.

The prefix is added to each JSON key. For example, if you use sps_ as a prefix, in the forwarded JSON message the {"protocol": "ssh"} key changes to {"sps_protocol": "ssh"}, which allows you to identify the forwarded data more easily.

Other formats ignore the Prefix option.

targets JSON object

Specifies the details of the target SIEM device.

format cef | json | json_cim

The format of the message sent to the SIEM. Use the following:

  • json_cim: if using Splunk.

  • cef: if using CEF-compatible SIEMs, for example, Microsoft Azure Sentinel.

  • json: for general use.

name string

The name of the SIEM forwarder policy.

protocol JSON object

Specifies connection details to the target SIEM device. For example:

"protocol": {
    "selection": "syslog",
    "value": {
        "address": {
            "selection": "ip",
            "value": "192.168.1.1"
        },
        "port": 5555,
        "tls": {
            "selection": "secure",
            "trusted_ca_list_ref": "1241814345d074efd1ded7"
        }
    }
}
Elements of protocol Type Description
selection string

Must be syslog

value JSON object

Contains the address of the SIEM and the TLS settings of the connection.

address JSON object

Contains the type and the value of the address. For example:

"address": {
    "selection": "ip",
    "value": "192.168.1.1"
},
"address": {
    "selection": "fqdn",
    "value": "my-siem.example.com"
},
selection string

Defines the address type (IP or domain name). Possible values are:

  • fqdn

    The server address is provided as a fully qualified domain name.

  • ip

    The server address is provided as an IP address.

value string The address of the server, corresponding to the format set in the selection field.
port integer

The port number of the server.

tls JSON object

The security settings of the connection. For example:

tls": {
    "selection": "secure",
    "trusted_ca_list_ref": "1241814345d074efd1ded7"
}
"tls": {
    "selection": "disabled"
}
selection disabled | insecure | secure

  • disabled: Use an unencrypted connection. Since the data forwarded contains sensitive information, One Identity recommends to use TLS encryption between SPS and your SIEM.

  • insecure: Use TLS encryption, but do not validate the certificate of the SIEM.

  • secure: Use TLS encryption and validate the certificate of the SIEM. If you use this option, you must also set the trusted_ca_list_ref field.

trusted_ca_list_ref string

The key of the trusted CA list used to validate the certificate of the SIEM. This option is required if you set "selection": "secure". For details on creating trusted CA lists, see Trusted Certificate Authorities.
Configure universal SIEM forwarder
  2. Open a transaction.

    For details, see Open a transaction.

  3. If you want to send the messages in an encrypted connection to the SIEM and also validate the certificate of the SIEM, upload the certificate of the CA that signed the certificate of the SIEM to a trusted CA list. For details on creating trusted CA lists, see Trusted Certificate Authorities.

  4. Create the JSON object that configures SPS to forward session data to your SIEM.

    POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/management/universal_siem_forwarder endpoint. You can find a detailed description of the available parameters listed in Splunk integration. For example,

    {
    "enabled": true,
    "prefix": "myprefix",
    "targets": [
        {
            "format": "json_cim",
            "name": "siem_target",
            "protocol": {
                "selection": "syslog",
                "value": {
                    "address": {
                        "selection": "ip",
                        "value": "192.168.1.1"
                    },
                    "port": 5555,
                    "tls": {
                        "selection": "disabled"
                    }
                }
            }
        }
    ]
 }
  5. Commit your changes.

    For details, see Commit a transaction.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating