One Identity Safeguard for Privileged Sessions 6.0.1

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 Modifying the configuration of SPS

Delete an object Headers 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 Audit data access rules Active sessions 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

Promote a Safeguard for Privileged Sessions 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

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 authentication policies Global HTTP options HTTP settings policies

Citrix ICA connections

ICA connections ICA connection policies ICA channels Global ICA options ICA 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 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 Indexing sessions Session audit trail downloads Local services: configuring the indexer Indexer policies

Reporting

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

Health and maintenance

Monitor appliance health status

Advanced authentication and authorization

Usermapping policy Plugins Authentication and authorization plugins 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

Reporting

Topics:

Connection statistics subchapters

Reporting

Reporting > Reporting

List of endpoints for configuring reporting, and accessing the generated reports.

URL

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

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

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

curl --cookie cookies https://<IP-address-of-SPS>/configuration/reporting

Response

The following is a sample response received when listing the available endpoints.

For details of the meta object, see Message format.

{
  "meta": {
    "first": "/api/configuration/aaa",
    "href": "/api/configuration/reporting",
    "last": "/api/configuration/x509",
    "next": "/api/configuration/ssh",
    "parent": "/api/configuration",
    "previous": "/api/configuration/rdp",
    "transaction": "/api/transaction"
  },
  "items": [
    {
      "key": "content_subchapters",
      "meta": {
        "href": "/api/configuration/reporting/content_subchapters"
      }
    },
    {
      "key": "custom_subchapters",
      "meta": {
        "href": "/api/configuration/reporting/custom_subchapters"
      }
    },
    {
      "key": "predefined_reports",
      "meta": {
        "href": "/api/configuration/reporting/predefined_reports"
      }
    },
    {
      "key": "reports",
      "meta": {
        "href": "/api/configuration/reporting/reports"
      }
    },
    {
      "key": "statistics_subchapters",
      "meta": {
        "href": "/api/configuration/reporting/statistics_subchapters"
      }
    }
  ]
}

Endpoint	Description
content_subchapters	List of the reporting subchapters created from audit trail content (statistics of search keywords, and screenshots).
custom_subchapters	List of the reporting subchapters created from custom queries to the SPS connection database.
predefined_reports	List of the pre-defined reports available on SPS.
reports	List of the configured reports.
statistics_subchapters	List of the reporting subchapters created from connection statistics.

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.
400	InvalidQuery	The requested filter or its value is invalid.
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.

Reports

Reporting > Reports

List of the configured reports.

URL

GET https://<IP-address-of-SPS>/api/configuration/reporting/reports

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

Cookie name

Description

Required

Values

session_id

Contains the authentication token of the user

Required

Sample request

The following command lists the configured reports.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/reporting/reports

The following command retrieves the properties of a specific report.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/reporting/reports/<key_value>

Response

The following is a sample response received when listing reports.

For details of the meta object, see Message format.

{
  "meta": {
    "first": "/api/configuration/reporting/content_subchapters",
    "href": "/api/configuration/reporting/reports",
    "last": "/api/configuration/reporting/statistics_subchapters",
    "next": "/api/configuration/reporting/statistics_subchapters",
    "parent": "/api/configuration/reporting",
    "previous": "/api/configuration/reporting/predefined_reports",
    "transaction": "/api/transaction"
  },
  "items": [
    {
      "key": "7798770004e472c8576912",
      "meta": {
        "href": "/api/configuration/reporting/reports/7798770004e472c8576912"
      }
    },
    {
      "key": "8292675195707f19d932af",
      "meta": {
        "href": "/api/configuration/reporting/reports/8292675195707f19d932af"
      }
    }
  ]
}

When retrieving the endpoint of a specific report, the response is the following.

{
  "body": {
    "access": [
      "report"
    ],
    "chapters": [
      {
        "name": "System health",
        "subchapters": [
          {
            "name": "system_health_network_connections",
            "selection": "builtin"
          },
          {
            "name": "system_health_load_average",
            "selection": "builtin"
          }
        ]
      },
      {
        "name": "All connections",
        "subchapters": [
          {
            "name": "connection_each_scb_top10_channel_types_each",
            "selection": "builtin"
          },
          {
            "name": "connection_each_scb_top10_portforward_targets_each",
            "selection": "builtin"
          }
        ]
      },
      {
        "name": "Search statistics",
        "subchapters": [
          {
            "reference": "21111736175707f1df8bea1",
            "selection": "custom"
          }
        ]
      },
      {
        "name": "Misc",
        "subchapters": [
          {
            "reference": "13869311625707e0a3e0892",
            "selection": "custom"
          }
        ]
      },
      {
        "name": "Advanced statistics",
        "subchapters": [
          {
            "reference": "5983143445707eb740fee3",
            "selection": "custom"
          }
        ]
      }
    ],
    "email_recipients": {
      "recipients": [
        "admin@company.com"
      ],
      "selection": "other"
    },
    "frequency": {
      "day": false,
      "month": true,
      "week": false
    },
    "logo_id": "logoC890jH",
    "name": "all-options",
    "send_report_in_email": true
  },
  "key": "8292675195707f19d932af",
  "meta": {
    "first": "/api/configuration/reporting/reports/7798770004e472c8576912",
    "href": "/api/configuration/reporting/reports/8292675195707f19d932af",
    "last": "/api/configuration/reporting/reports/8292675195707f19d932af",
    "next": null,
    "parent": "/api/configuration/reporting/reports",
    "previous": "/api/configuration/reporting/reports/12046247915707e5d6a5c59",
    "transaction": "/api/transaction"
  }
}

Element			Type	Description
key			string	Top level element, contains the ID of the report
body			Top level element (string)	The elements of the report.
	access		list	Required. List of access control groups whose members can access the subchapter. To deny access to the report, use "admin" as the only value for the element.
	chapters		Top level item	A chapter of the report.
	email_recipients		Top level item	Contains the list of e-mails where the generated report is sent.
		recipients	list	Custom list of e-mails where the generated report is sent. To use a custom list, the selection element must be set to other.
		selection	string	This element can have two values: default uses the e-mail address configured in the reporting_address element of the https://<IP-address-of-SPS>/api/configuration/management/email endpoint (or the Basic Settings > Management > Mail settings > Send reports to field on the web UI). other uses the e-mails listed in the recipients element.
	frequency		Top level item	Contains the list of options for defining the frequency of generating the report.
		day	boolean	Set it to true to generate the report each day.
		month	boolean	Set it to true to generate the report each month.
		week	boolean	Set it to true to generate the report each week.
	logo_id		string	The ID of the custom logo. The null value means the report is generated using the default logo. You can upload a custom logo on the web UI of SPS, using the Reporting > Configuration > <report> > Choose new logo button.
	name		string	The name of the report.
	send_report_in_email		boolean	Set it to false if you do not want to include the generated report in the e-mail.

Chapters elements	Type	Description
name		string	Name of the chapter.
subchapters		list	List of subchapters included in the chapter.
	name	string	Name of the built-in subchapter included in the chapter. For the list of the built-in subchapters, see Built-in subchapters. To include a built-in subchapter, use the value of its name element, not the key.
	reference	string	The key of the custom, content, or statistics subchapter. For the keys of the reporting subchapters created from custom queries to the SPS connection database, see the custom_subchapters endpoint. For the keys of the reporting subchapters created from audit trail content (statistics of search keywords, and screenshots), see the reporting/content_subchapters endpoint. For the keys of the reporting subchapters created from connection statistics, see the reporting/statistics_subchapters endpoint. To include a custom, content, or statistics subchapter, use the value of its key element, not the name.
	selection	string	This element can have two values: Set builtin for the default reporting subchapters. Set custom for all other subchapters (custom, content or statistics).

Examples:

Set the e-mail recipients to the default (as configured in the reporting_address element of the /api/configuration/management/email endpoint):

"email_recipients": {
  "selection": "default"
}

Create a custom set of e-mail recipients:

"email_recipients": {
  "recipients": [
    "<email-1>",
    "<email-2>"
  ],
  "selection": "other"
}

Add a reporting chapter with built-in subchapters:

"chapters": [
  {
    "name": "<custom-name>",
    "subchapters": [
      {
        "name": "system_health_filesystem_usage",
        "selection": "builtin"
      },
      {
        "name": "system_health_network_connections",
        "selection": "builtin"
      },
      {
        "name": "system_health_load_average",
        "selection": "builtin"
      }
    ]
  }
        Add a reporting chapter with custom, content, or statistics subchapters:
"chapters": [
  {
    "name": "<custom-name>",
    "subchapters": [
      {
        "reference": "<key-of-subchapter>",
        "selection": "custom"
      },
      {
        "reference": "<key-of-subchapter>",
        "selection": "custom"
      }
    ]
  }

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.
400	InvalidQuery	The requested filter or its value is invalid.
400	IncompleteConfigurationSubtreeError	Possible cause: PUT operation on the reports endpoint, instead of POST.
400	IncompleteConfigurationSubtreeError "missing_paths": [ "email_recipients/recipients" ]	You have selected other for the selection element under email_recipients, but did not provide a list using recipients.
400	IncompleteConfigurationSubtreeError Syntax error: \"No such property; property='recipients'	Do not provide recipients if you set the selection element under email_recipients to default.
400	IncompleteConfigurationSubtreeError "missing_paths": [ "chapters/7/subchapters/0/name" ]	Verify that the selection element of the subchapter is correctly set to builtin or custom.
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.

Add a report

To add a report, you have to:

Open a transaction.

For details, see Open a transaction.
Create the JSON object for the new report.

POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/reporting/reports endpoint. You can find a detailed description of the available parameters listed in Element .

If the POST request is successful, the response includes the key of the new report.
```
{
  "key": "26ddf648-9a21-4a7f-af56-9cea575785a9",
  "meta": {
    "href": "/api/configuration/reporting/reports/26ddf648-9a21-4a7f-af56-9cea575785a9",
    "parent": "/api/configuration/reporting/reports",
    "transaction": "/api/transaction"
  }
}
```
Commit your changes.

For details, see Commit a transaction.

Modify a report

To modify a report, you have to:

Open a transaction.

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

PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/reporting/reports/<key-of-the-report> endpoint. You can find a detailed description of the available parameters listed in Element .
Commit your changes.

For details, see Commit a transaction.

Built-in subchapters

Reporting > Built-in subchapters

To create reports, you can use a number of predefined reporting subchapters. The following sections list the short description of each subchapter, as displayed on the web UI of SPS, and its name you can use to configure reports using the REST API.

Configuration changes

Configuration changes - Changes by pages:

configuration_changes_changes_by_pages
Configuration changes - Changes by users:

configuration_changes_changes_by_users
Configuration changes - Changes in time:

configuration_changes_changes_in_time
Configuration changes - Special events:

configuration_changes_special_events
Configuration changes - Password change:

configuration_changes_password_change

Connection summary

Channels table

connection_aggregate_scb_channels
Distribution of channels

connection_aggregate_scb_channeldist
Channels history

connection_aggregate_scb_channelshist
Verdicts history by channels

connection_aggregate_scb_verdicthist
Usernames

connection_aggregate_scb_usernames
Accepted usernames

connection_aggregate_scb_accepted_usernames
Remote usernames

connection_aggregate_scb_remote_usernames
Accepted remote usernames

connection_aggregate_scb_accepted_remote_usernames
Four-eyes authorizers

connection_aggregate_scb_4eyes_authorizers
Source addresses

connection_aggregate_scb_source_addresses
Server addresses

connection_aggregate_scb_server_addresses
Top 10 usernames in denied channels

connection_aggregate_scb_top10_users_in_denied_channels
Top 10 denied usernames in channels

connection_aggregate_scb_top10_denied_users
Top 10 denied servers in channels

connection_aggregate_scb_top10_denied_servers
Top 10 denied channel types

connection_aggregate_scb_top10_denied_channeltypes
Top 10 longest sessions

connection_aggregate_scb_top10_longest_sessions
Top 10 shortest sessions

connection_aggregate_scb_top10_shortest_sessions

System health

System health - Filesystem usage

system_health_filesystem_usage
System health - Network connections

system_health_network_connections
System health - Load average

system_health_load_average

All connections

Top 10 usernames in each connection

connection_each_scb_top10_users_each
Top 10 accepted usernames in each connection

connection_each_scb_top10_accepted_users_each
Top 10 remote usernames in each connection

connection_each_scb_top10_remote_users_each
Top 10 username/four-eyes authorizer in each connection

connection_each_scb_top10_4eyes_authorizers_each
Top 10 servers in each connection

connection_each_scb_top10_servers_each
Top 10 username/server in each connection

connection_each_scb_top10_username_server_connection_each
Top 10 username/remote user in each connection

connection_each_scb_top10_remoteusers_each
Top 10 commands over SSH session-exec channel in each connection

connection_each_scb_top10_exec_commands_each
Top 10 channel types in each connection

connection_each_scb_top10_channel_types_each
Top 10 Port forward targets in each connection

connection_each_scb_top10_portforward_targets_each

Specific connections

You can also use subchapters for a specific connection. You have to use the protocol and the key of the connection.

The following examples assume that the connection's protocol is SSH, and its key is 8348340645707e2575e3c6.

Top 10 usernames in "<connection_name>"

connection_<protocol>_scb_top10_users_<protocol>-<key>

Example:

connection_ssh_scb_top10_users_ssh-8348340645707e2575e3c6
Top 10 accepted usernames in "<connection_name>"

connection_<protocol>_scb_top10_accepted_users_<protocol>-<key>

Example:

connection_ssh_scb_top10_accepted_users_ssh-8348340645707e2575e3c6
Top 10 remote usernames in "<connection_name>"

connection_<protocol>_scb_top10_remote_users_<protocol>-<key>

Example:

connection_ssh_scb_top10_remote_users_ssh-8348340645707e2575e3c6
Top 10 username/four-eyes authorizer in "<connection_name>"

connection_<protocol>_scb_top10_4eyes_authorizers_<protocol>-<key>

Example:

connection_ssh_scb_top10_4eyes_authorizers_ssh-8348340645707e2575e3c6
Top 10 servers in "<connection_name>"

connection_<protocol>_scb_top10_servers_<protocol>-<key>

Example:

connection_ssh_scb_top10_servers_ssh-8348340645707e2575e3c6
Top 10 username/server in "<connection_name>"

connection_<protocol>_scb_top10_username_server_connection_<protocol>-<key>

Example

connection_ssh_scb_top10_username_server_connection_ssh-8348340645707e2575e3c6
Top 10 username/remote user in "<connection_name>"

connection_<protocol>_scb_top10_remoteusers_<protocol>-<key>

Example:

connection_ssh_scb_top10_remoteusers_ssh-8348340645707e2575e3c6
Top 10 commands over SSH session-exec channel in "<connection_name>"

connection_<protocol>_scb_top10_exec_commands_<protocol>-<key>

Example:

connection_ssh_scb_top10_exec_commands_ssh-8348340645707e2575e3c6
Top 10 channel types in "<connection_name>"

connection_<protocol>_scb_top10_channel_types_<protocol>-<key>

Example:

connection_ssh_scb_top10_channel_types_ssh-8348340645707e2575e3c6
Top 10 Port forward targets in "<connection_name>"

connection_<protocol>_scb_top10_portforward_targets_<protocol>-<key>

Example:

connection_ssh_scb_top10_portforward_targets_ssh-8348340645707e2575e3c6

Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation

Veuillez sélectionner votre produit

Afin de mieux répondre à vos besoins, précisez l'objet du tchat:

Solutions recommandées pour votre problème

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

Reporting

Topics:

Reporting

URL

Cookies

Sample request

Response

Status and error codes

Reports

URL

Cookies

Sample request

Response

Examples:

Status and error codes

Add a report

Open a transaction.

Create the JSON object for the new report.

Commit your changes.

Modify a report

Open a transaction.

Modify the JSON object of the report.

Commit your changes.

Built-in subchapters

Configuration changes

Connection summary

System health

All connections

Specific connections