Chat now with support
Chat mit Support

One Identity Safeguard for Privileged Sessions 8.0 LTS - 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 REST API examples

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.

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

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

The following is a sample response received.

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

{
    "body": {
        "product": "Safeguard for Privileged Sessions",
        "product_version": "7",
        "serial": "123-456-789"
        "license_type": "term",
        "valid_not_after": "2022-12-14",
        "enterprise": true
        "limit_type": "session",
        "licensed_options": {
          "basic_proxies": 0,
          "sudo_iolog": 0,
          "analytics": true,
        }
    },
    "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.

 

enterprise

 

boolean

Set to true to enable evaluating the limit values of basic_proxies and sudo_iologs of licensed_options. When set to true, all limit values other 0 than are considered unlimited.

 

license_type

 

string

Contains information about the type of your license. This information is mostly relevant for your company's Sales Team.

 

licensed_options

 

JSON object

Contains the limit values of basic_proxies and sudo_iologs, and enabling or disabling analytics.

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

  product   string The official name of the product the license is applied for.

 

product_version

 

string

The product version number currently in use with the license.

 

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.

NOTE: The valid_not_after key can have a null value. In this case, your license does not expire.

Elements of licensed_options

Type

Description
analytics boolean Set to true to enable analytics on this licensed version of SPS.
basic_proxies integer The value of the limit for sessions or hosts when using basic proxies with this licensed version of SPS.
sudo_iolog integer The value of the limit for using Sudo I/O logs with this licensed version of SPS.
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 more information, 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.txt -F 'data=@/path/license.div' https://<IP-address-of-SPS>/api/upload/license
  4. Commit your uploaded license file.

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

    curl --cookie cookies.txt https://<IP-address-of-SPS>/api/transaction --request PUT --data '{"message": "your commit message"}'
  5. Commit your changes.

    For more information, 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 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 contact information.

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

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

For more information on 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 more information, 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.txt "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 more information, see Commit a transaction.

SIEM forwarder

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 in the Administration Guide.

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 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 endpoints for SNMP configuration settings.

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

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

For more information on 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 more information, 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 Elements. 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 more information, see Commit a transaction.

Manage SPS clusters

When you have a set of two or more One Identity Safeguard for Privileged Sessions (SPS) instances in your deployment, you can join them into a cluster. This has several advantages. You can:

  • Manage the nodes from one central location.

  • Monitor their status and update their configuration centrally.

  • Search all session data recorded by all nodes in the cluster on a single node.

  • Scale the performance of the cluster by adding new nodes and joining them to the cluster easily.

  • Extend auditing to other networks by adding new nodes to the cluster and joining them to the cluster.

This is achieved by assigning roles to the individual nodes in your cluster: you can set one of your SPS nodes to be the Central management node and the rest of the nodes are managed from this central node.

NOTE: All nodes in a cluster must run the same version of SPS.

NOTE: To configure the /api/cluster/ endpoint, your usergroup must have "read and write/perform" privileges assigned to the Basic Settings > Cluster management object. You can configure this on the Users & Access Control > Appliance Access page of SPS's web interface.

For details, see Managing user rights and usergroups in the Administration Guide.

URL
GET https://<IP-address-of-any-node-in-cluster>/api/cluster
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 endpoints available under the cluster endpoint.

curl --cookie cookies.txt https://<IP-address-of-any-node-in-cluster>/api/cluster
Response

The following is a sample response received.

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

{
    "items": [
        {
            "key": "configuration_sync",
            "meta": {
                "href": "/api/cluster/configuration_sync"
            }
        },
        {
            "key": "join_request",
            "meta": {
                "href": "/api/cluster/join_request"
            }
        },
        {
            "key": "nodes",
            "meta": {
                "href": "/api/cluster/nodes"
            }
        },
        {
            "key": "promote",
            "meta": {
                "href": "/api/cluster/promote"
            }
        },
        {
            "key": "status",
            "meta": {
                "href": "/api/cluster/status"
            }
        }
    ],
    "meta": {
        "href": "/api/cluster",
        "join_request": "/api/cluster/join_request",
        "nodes": "/api/cluster/nodes",
        "parent": "/api",
        "promote": "/api/cluster/promote",
        "status": "/api/cluster/status",
        "configuration_sync": "/api/cluster/configuration_sync"
    }
}
Element Type Description
items Top-level element (list of JSON objects) List of endpoints (objects) available from the current endpoint.
key string The ID of the endpoint.
meta Top-level item (JSON object) Contains the path to the endpoint.
href string (relative path) The path of the resource that returned the response.
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.
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen