One Identity Safeguard for Privileged Sessions 7.2.1

One Identity Safeguard for Privileged Sessions 7.2.1 - REST API Reference Guide

Message format How to configure SPS using REST How to configure SPS using REST: a sample transaction

Authenticate to the SPS REST API Authenticate to the SPS REST API using X.509 certificate Listing SPS login methods Retrieve user information Checking the transaction status Open a transaction Commit a transaction Delete a transaction Reviewing the changelog of a transaction Defaults query parameter Application level error codes Navigating the configuration of SPS Modifying the configuration of SPS

Delete an object Create a new object Change an object

Generating SPS support bundle using REST

Basic settings

Retrieve basic firmware and host information Listing integrated products with SPS Firmware management

Retrieving information about SPS firmware image slots Testing new SPS firmware before upgrade Upgrading SPS to a new firmware Uploading new firmware to SPS Downloading and installing SPS firmware through HTTP

Network settings

Network configuration options DNS servers Routing between interfaces Naming options Network addresses Routing table Local services of SPS Local services: Web login for administrators Local services: Web login for users Local services: cluster interface System backup policy Encrypting system backup policy

Date and time

Date & time NTP servers Timezone

Logs, monitoring and alerts

Management options

Web gateway authentication

Syslog server settings Disk fill-up prevention Mail settings Health monitoring SNMP settings SNMP traps Local services: access for SNMP agents Alerting System alerts Traffic alerts

Trust stores Enabling One Identity Safeguard Remote Access without Starling Join Managing Starling Join

Retrieving the status of services related to Starling Join/Unjoin

User management and access control

User management and access control Login settings Privileges of usergroups Audit data access rules Active sessions Manage users and usergroups locally on SPS Manage usergroups locally on SPS Manage users locally on SPS Configuring LDAP servers Configuring SPS login methods Configuring the SAML2 Service Provider settings

Managing SPS

Troubleshooting options Internal certificates Passwords stored on SPS Private keys stored on SPS Private keys generated on SPS Certificates stored on SPS Local services: enabling SSH access to the SPS host Manage the SPS license Change contact information Splunk integration Splunk integration Manage SPS clusters

Promote a SPS node to be the Central Management node in a new cluster Join node(s) to the cluster Query join status Assign a role to a node Query nodes Query one particular node Query the status of all nodes in the cluster Query the status of one particular node Upload and enable a configuration synchronization plugin Disable a configuration synchronization plugin

Configuration tools in SPS

Resolving hostnames to IP addresses Testing LDAP server connection

General connection settings

Channel policy Policies Archive/Cleanup policy Audit policies Backup policy Real-time content monitoring with Content Policies LDAP servers Signing CA policies Time policy Trusted Certificate Authorities Local user databases User lists

HTTP connections

HTTP connections HTTP connection policies HTTP channels HTTP authentication policies Global HTTP options HTTP settings policies Creating custom HTTP error templates Uploading a custom logo to your custom HTTP proxy error pages

Citrix ICA connections

ICA connections ICA connection policies ICA channels Global ICA options ICA settings policies

MSSQL connections

Limitations in handling MSSQL connections MSSQL connections MSSQL connection policies MSSQL channels MSSQL authentication policies Global MSSQL options MSSQL settings policies

RDP connections

RDP connections RDP connection policies RDP channels Configuring domain membership Global RDP options RDP settings policies

SSH connections

SSH connections SSH connection policies SSH channels SSH authentication policies Global SSH options SSH settings policies SSH host keys and certificates

Telnet connections

Telnet connections Telnet connection policies Telnet channels Telnet authentication policies Global Telnet options Telnet pattern sets Telnet settings policies

VNC connections

VNC connections VNC connection policies VNC settings policies Global VNC options

Search, retrieve, download, and index sessions

Audited sessions Download audit trails Searching in the session database with the basic search method Retrieving all sessions from the session database with the advanced search method Searching in connection content Generate and retrieve screenshot for content search Session statistics Session histogram Session alerts Session events Indexing sessions Session audit trail downloads Local services: configuring the indexer Indexer policies

Reporting

Reporting Reports Built-in subchapters Pre-defined reports Content subchapters

Health and maintenance

Monitor appliance health status

Advanced authentication and authorization

Usermapping policy Plugins

Upload a plugin Delete a plugin Check the integrity of a plugin

Authentication and authorization plugins

Configuring Authentication and Authorization plugin instances

Credential store plugins Credential stores

Completing the Welcome Wizard using REST

Enable and configure analytics using REST

Enable One Identity Safeguard for Privileged Analytics Configure One Identity Safeguard for Privileged Analytics

REST API examples

Examples

REST API examples Configuration default values Date and time configuration Firmware slots Number of sessions SSH Settings Policies Transaction handling VNC Connections Policies

Configuration tools in SPS

Managing SPS > Configuration tools in SPS

A list of tools that can help with the configuration of SPS.

URL

GET https://<IP-address-of-SPS>/api/tools/

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 available configuration tools in SPS.

curl -X GET -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/tools/

Response

The following is a sample response received when the available configuration tools are listed.

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

{
     "items": [
       {
         "key": "hosts-by-name",
         "meta": {
           "href": "/api/tools/hosts-by-name"
         }
       },
       {
         "key": "ldaptest",
         "meta": {
           "href": "/api/tools/ldaptest"
         }
       }
     ],
     }

Item	Description
Resolving hostnames to IP addresses	Resolve the hostname of a computer or server to IP addresses.
Testing LDAP server connection	Test LDAP server connection.

HTTP response codes

For more information and a list of standard HTTP response codes, see Application level error codes.

Resolving hostnames to IP addresses

Managing SPS > Configuration tools in SPS > Resolving hostnames to IP addresses

SPS configuration requires you to set IP addresses as values. Resolve the hostname of a computer or server with the /hosts-by-name endpoint to receive the list of all related IP addresses that you can use for configuration.

NOTE: The protocol parameter can only take the following two values: TCP and UDP. Anything else will return an error message.

URL

POST https://<IP-address-of-SPS>/api/tools/hosts-by-name

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 resolves the hostname to IP addresses.

curl -X POST -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/tools/hosts-by-name

{
     "hostname": "example.org",
     "protocol": "TCP"
    }

Elements of the request message body include:

Element	Type	Required	Description	Notes
hostname	string	Required	The unique identifier that serves as the name of the computer or server whose IP address you want to resolve.
protocol	string	Required	The type of Internet Protocol used to address and route packets of data.	Possible values are: TCP UDP

Element

Type

Required

Description

Notes

hostname

string

Required

The unique identifier that serves as the name of the computer or server whose IP address you want to resolve.

protocol

string

Required

The type of Internet Protocol used to address and route packets of data.

Possible values are:

Response

When resolving a hostname to IP addresses, the response is the following.

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

{
     "ipv4": [
       "93.184.216.34",
       "93.184.216.35"
     ],
     "ipv6": [
       "2606:2800:220:1:248:1893:25c8:1946",
       "2606:2800:220:1:248:1893:25c8:1947"
     ]
   }

Elements of the response message body include:

Element	Type	Description	Notes
ipv4	string array	The Internet Protocol type of the IP addresses is version 4.
ipv6	string array	The Internet Protocol type of the IP addresses is version 6.

HTTP response codes

HTTP response codes comprise of standard or endpoint-specific HTTP status and error codes. The following table lists the endpoint-specific HTTP response codes for this request.

HTTP response code	Status/Error	Description
400	Syntactic Error	The protocol you provided is not valid. Use TCP or UDP as value instead.
400	HostnameCannotBeResolved	The hostname you provided cannot be resolved. Check the following: The hostname you provided is valid. The hostname is available on the Internet.
401	Unauthenticated	Unauthenticated users cannot query the IP addresses of a host.

HTTP response code

Status/Error

Description

400

Syntactic Error

The protocol you provided is not valid. Use TCP or UDP as value instead.

400

HostnameCannotBeResolved

The hostname you provided cannot be resolved. Check the following:

The hostname you provided is valid.
The hostname is available on the Internet.

401

Unauthenticated

Unauthenticated users cannot query the IP addresses of a host.

For more information and a list of standard HTTP response codes, see Application level error codes.

Testing LDAP server connection

Managing SPS > Configuration tools in SPS > Testing LDAP server connection

Use the /ldaptest endpoint to test whether your LDAP server configuration was successful and the connection between the LDAP server and SPS can be established. You can identify connection issues based on the specific error messages received (for example, unsuccessful authorization due to incomplete credentials).

URL

GET https://<IP-address-of-SPS>/api/tools/ldaptest

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 endpoints for testing LDAP server availability.

curl -k -X GET -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/tools/ldaptest

Response

The following is a sample response received when LDAP test endpoints are listed.

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

{
     "items": [
       {
         "key": "aaa",
         "meta": {
           "href": "/api/tools/ldaptest/aaa"
         }
       },
       {
         "key": "policies",
         "meta": {
           "href": "/api/tools/ldaptest/policies"
         }
       }
     ],
     "meta": {
       "aaa": "/api/tools/ldaptest/aaa",
       "href": "/api/tools/ldaptest",
       "parent": "/api/tools",
       "policies": "/api/tools/ldaptest/policies",
       "remaining_seconds": 600
     }
   }

Operations

Operations with the /ldaptest endpoint include:

Operation	HTTP method	URL
List endpoints for testing LDAP server availability	GET	/api/tools/ldaptest
Testing a LDAP server	POST	/api/tools/ldaptest/policies
Testing an AAA LDAP server	POST	/api/tools/ldaptest/aaa

Example: Testing LDAP server connection

To test your connection to a LDAP server, you have to

Authenticate to SPS. For more information, see Authenticate to the SPS REST API.

List the available LDAP servers that you have previously configured.

curl -k -X GET -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/configuration/policies/ldap_servers

Select the key of the LDAP server that you want to test.

Use the key to test whether you can connect to the LDAP server.

curl -k -X POST -H "Content-Type: application/json" -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/tools/ldaptest/policies --data '{"key": "200796612861e564724534a"}'

Response

The following is a sample response received when you test your connection to a LDAP server.

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

{
     "meta": {
       "href": "/api/tools/ldaptest/policies",
       "ldap_server": "/api/configuration/policies/ldap_servers/200796612861e564724534a",
       "parent": "/api/tools/ldaptest",
       "remaining_seconds": 600
     },
     "success": true
   }

Example: Testing AAA LDAP server connection

To test your connection to an AAA LDAP server, you have to

Authenticate to SPS. For more information, see Authenticate to the SPS REST API.

List the available AAA LDAP servers that you have previously configured.

curl -k -X GET -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/configuration/aaa/ldap_servers

Select the key of the AAA LDAP server that you want to test.

Use the key to test whether you can connect to the AAA LDAP server.

curl -k -X POST -H "Content-Type: application/json" -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/tools/ldaptest/aaa --data '{"key": "200796612861e564724534a"}'

Response

The following is a sample response received when you test your connection to an AAA LDAP server.

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

{
     "meta": {
       "href": "/api/tools/ldaptest/policies",
       "ldap_server": "/api/configuration/aaa/ldap_servers/200796612861e564724534a",
       "parent": "/api/tools/ldaptest",
       "remaining_seconds": 600
     },
     "success": true
   }

Elements of the response message body include:

Element	Type	Description	Notes
success	boolean	Indicates that the connection to the provided LDAP server could be established.	Possible values are: true - the test was successful false - the test was not successful
meta.href	string (relative path)	Path of the resource that returned the response. When creating a new object, this is the URL of the created object.
meta.ldap_server	string (relative path)	Identifier of the LDAP server that was tested.
meta.parent	string (relative path)
meta.remaining_seconds	integer	Time left until the session times out in seconds.	SPS closes idle sessions after a period of inactivity. This value shows the number of seconds left until the timeout. For more information on setting the session timeout, Login settings.

HTTP response codes

HTTP response codes comprise of standard or endpoint-specific HTTP status and error codes. The following table lists the endpoint-specific HTTP response codes for this request.

HTTP response code	Status/Error	Description
400	TransactionMustBeClosed	The user attempted to test a LDAP server while a transaction was open (for example, there were pending configuration changes while the test was attempted). Commit or roll back the transaction before testing the LDAP server.
400	NoSuchLDAPServer	There are no LDAP servers configured with the identifier specified in the request: --data '{"key": "<invalid value>"}' Make sure that you use a valid key from the list of configured LDAP servers. This can also occur if you attempt to test an AAA LDAP server using the /ldaptest/policies endpoint or vice versa.
400	LDAPServerWithNoBindPassword	You can connect to a LDAP server using a bind DN (bind_dn) and a bind password (bind_password). These credentials are used for authentication. Normally, you need both credentials to make a successful connection, so that access to the LDAP server can be controlled. Some LDAP servers might be configured to allow so-called anonymous connections, meaning that there is no access control whatsoever and anybody can connect to that server. To test such a connection, there must be no credentials configured for that LDAP server. valid: a bind_dn and a bind_password are both configured, or there is no bind_dn and no bind_password invalid: there is a bind_dn, but no bind_password, or there is a bind_password, but no bind_dn
400	LDAPServerWithNoBindDn	See LDAPServerWithNoBindPassword.
500	LDAPConnectionFailure	Something went wrong during testing the connection. The most common reason would be an incorrect server address/port, DNS resolution failure, firewalls, or a damaged networking cable. Make sure that the configured address/port is reachable from SPS.