One Identity Safeguard for Privileged Sessions 5.8.0

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 Retrieve user information Checking the transaction status Open a transaction Commit a transaction Delete a transaction Reviewing the changelog of a transaction Application level error codes Navigating the configuration of SPS Headers

Basic settings

Retrieve basic firmware and host information Network settings

Web interface 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

Date and time

Date & time NTP servers Timezone

Logs, monitoring and alerts

Management options 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

User management and access control

User management and access control Authentication and user database settings Privileges of usergroups Manage users and usergroups locally on SPS Manage usergroups locally on SPS Manage users locally on SPS

Managing SPS

Troubleshooting options Internal certificates Headers Headers Headers Local services: enabling SSH access to the SPS host RPC API Manage the SPS license Change contact information Splunk integration Manage Safeguard for Privileged Sessions clusters

General connection settings

Channel policy Policies Audit policies 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 Global HTTP options HTTP settings policies

Citrix ICA connections

ICA connections ICA connection policies Global ICA options ICA settings policies

RDP connections

RDP connections Status and error codes RDP channels Configuring domain membership Global RDP options RDP settings policies

SSH connections

SSH connections Status and error codes SSH channels SSH authentication policies Global SSH options SSH settings policies SSH host keys and certificates

Telnet connections

Telnet connections Telnet connection policies Global Telnet options

VNC connections

VNC connections VNC connection policies Global VNC options

Search, download, and index sessions

Audited sessions Download audit trails Searching in the session database Searching in connection content Session statistics Session histogram Session alerts Session events Local services: configuring the indexer Indexer policies

Reporting

Reporting Reports Built-in subchapters Pre-defined reports Content subchapters Custom subchapters Connection statistics subchapters

Advanced authentication and authorization

Usermapping policy Upload a plugin Authentication and authorization plugins Credential store plugins Credential stores Ticketing policies Ticketing plugins

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

About us Third-party contributions

Basic settings

Retrieve basic firmware and host information

Basic settings > Retrieve basic firmware and host information

The /api/info endpoint contains generic information about the SPS host. Note that part of this information is available without authentication.

URL

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

Headers

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

Header 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 displays the information about SPS that is available without authentication.

curl https://10.40.255.171/api/info

The following command displays the information about SPS that is available for authenticated users.

curl --cookie cookies https://<IP-address-of-SPS>/api/info

Response

The following is a sample response received by an anonymous user. For details of the meta object, see Message format.

{
    "body": {
	"domainname": "balabit",
        "hostname": "scbwriter",
        "nickname": null,
        "support_link": "mailto:scb-administrator@example.com"
    },
    "key": "about_info",
    "meta": {
        "href": "/api/info",
        "parent": "/api"
    }
}

The following is a sample response received by an authenticated user.

{
    "body": {
        "analytics_enabled": false,
	"build_date": "2018-06-15T20:18:40+00:00",
	"config_hash": "2abde4c81d9b544bf53fae4f4b9657fc",	
        "domainname": "balabit",
        "firmware_version": "5.7.0",
        "hostname": "scbwriter",
        "nickname": null,
	"roles": [
		"central-management",
		"search-master"
	],		
        "support_link": "mailto:scb-administrator@example.com",
        "version": "5 F7"
    },
    "key": "about_info",
    "meta": {
        "href": "/api/info",
        "remaining_seconds": 9889
        "parent": "/api"
    }
}

Element	Description
analytics_enabled	Indicates whether or not the One Identity Safeguard for Privileged Analytics module has been enabled.
build_date	Build date of the SPS firmware. This element is included in the response only for authenticated users.
config_hash	Contains the hash of the XML database running on the given SPS host.
domainname	Name of the domain used on the network. You can configure this parameter on the /api/configuration/network/naming endpoint. For details, see Naming options.
hostname	Name of the machine running SPS. You can configure this parameter on the /api/configuration/network/naming endpoint. For details, see Naming options.
nickname	The nickname of the SPS host. Use it to distinguish the devices. It is displayed in the core and boot login shells. You can configure this parameter on the /api/configuration/network/naming endpoint. For details, see Naming options.
support_link	The e-mail address of the SPS administrator, as set in the admin_address parameter of the /api/configuration/management/email endpoint. For details, see Mail settings.
firmware_version	The version number of the firmware running on SPS, for example, 4.3.2a. This element is included in the response only for authenticated users.
version	The name of the major release running on SPS, for example, 4 F3. This element is included in the response only for authenticated users.

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.

Network settings

Basic settings > Network settings

Web interface

Basic settings > Network settings > Web interface

Configuration options for the web interface of SPS.

URL

GET https://<IP-address-of-SPS>/api/configuration/management/webinterface

Headers

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

Header name

Description

Required

Values

session_id

Contains the authentication token of the user

Required

Sample request

The following command lists the configuration options for the SPS web interface.

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

Response

The following is a sample response received when listing the configuration options of the SPS web interface. For details of the meta object, see Introduction.

{
  "body": {
    "timeout": 10
  },
  "key": "webinterface",
  "meta": {
    "first": "/api/configuration/management/certificates",
    "href": "/api/configuration/management/webinterface",
    "last": "/api/configuration/management/webinterface",
    "next": null,
    "parent": "/api/configuration/management",
    "previous": "/api/configuration/management/syslog",
    "transaction": "/api/transaction"
  }
}

Element		Type	Description
key		string	Top level element, contains the ID of the endpoint.
body		Top level element (string)	Contains the configuration options of the SPS web interface.
	timeout	int	Session timeout, in minutes. SPS terminates sessions that are idle for this period. This setting applies sessions that access the SPS web interface and the SPS REST interface.

Modify the configuration of the web interface

To modify the configuration of the web interface, you have to:

Open a transaction.

For details, see Open a transaction.
Modify the JSON object of the endpoint.

PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/management/webinterface endpoint. You can find a detailed description of the available parameters listed in Web interface.
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 Using the SPS REST API.

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.

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

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

Basic settings

Retrieve basic firmware and host information

URL

Headers

Sample request

Response

Status and error codes

Network settings

Web interface

URL

Headers

Sample request

Response

Modify the configuration of the web interface

Open a transaction.

Modify the JSON object of the endpoint.

Commit your changes.

Status and error codes