Chat now with support
Chat mit Support

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

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

Sample request

The following command lists the available endpoints.

curl --cookie cookies https://<IP-address-of-SPS>/api/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.
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.

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

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.
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.
Add a report

To add a report, you have to:

  1. Open a transaction.

    For more information, see Open a transaction.

  2. 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"
      }
    }
  3. Commit your changes.

    For more information, see Commit a transaction.

Modify a report

To modify a report, you have to:

  1. Open a transaction.

    For more information, see Open a transaction.

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

  3. Commit your changes.

    For more information, see Commit a transaction.

Generate a report for a custom time period

To generate a report for a custom time period, you have to:

  1. Define the custom time period for the report.

    GET https://<IP-address-of-SPS>/api/configuration/reporting/reports. Search for the name of the report that you want to run on a custom time period. Copy the value of key.

  2. POST the parameters to the https://<IP-address-of-SPS>/api/reports endpoint. The following parameter is required:

    • configuration_id

    The following parameters are optional.

    • start: start timestamp in the format of either YYYY-MM-DD or YYYY-MM-DDTHH:MM.

    • end: end timestamp in the format of either YYYY-MM-DD or YYYY-MM-DDTHH:MM.

    • force: By default: False. If you set it to True, you can regenerate a report that has already been generated before.

    If you do not enter the optional parameters, the start timestamp defaults to 1970.01.01 and the end timestamp defaults to the timestamp of when the report was generated.

    NOTE: Timestamps are according to UTC.

    This means that for example, if you are located in an UTC+1 region, a report that has the end parameter configured as 2020-01-18 will actually have an end date/time of 2020-01-18 01:00.

    Example: Generate a report for a custom time period
    https://198.51.100.0/api/reports?configuration_id=8292675195707f19d932af&start=2020-02-01&end=2020-02-18
  3. You will receive a response similar to the following:

    {
      "message": "Report generation started.",
      "meta": {
        "href": "/api/reports",
        "parent": "/api"
      }
    }

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

Pre-defined reports

You can configure the compliance reports of SPS using the predefined_reports endpoint.

To help you comply with the regulations of the Payment Card Industry Data Security Standard (PCI DSS), One Identity Safeguard for Privileged Sessions (SPS) can generate reports on the compliance status of SPS. Note that this is not a fully-featured compliance report: it is a tool to enhance and complement your compliance report by providing information available in SPS. The report corresponds with the document Payment Card Industry (PCI) Data Security Standard, Requirements and Security Assessment Procedures, Version 3.0, published by the PCI Security Standards Council.

URL
GET https://<IP-address-of-SPS>/api/configuration/reporting/predefined_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).

Sample request

The following command lists the pre-defined reports available on SPS.

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

The following command retrieves the properties of a specific report.

curl --cookie cookies https://<IP-address-of-SPS>/api//configuration/reporting/predefined_reports/<report-key>
Response

The following is a sample response received when listing pre-defined reports.

For details of the meta object, see Message format.

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

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

{
  "key": "pcidss",
  "meta": {
    "first": "/api/configuration/reporting/predefined_reports/pcidss",
    "href": "/api/configuration/reporting/predefined_reports/pcidss",
    "last": "/api/configuration/reporting/predefined_reports/pcidss",
    "next": null,
    "parent": "/api/configuration/reporting/predefined_reports",
    "previous": null,
    "transaction": "/api/transaction"
  },
  "pcidss": {
    "access": [
      "report"
    ],
    "email_recipients": {
      "selection": "default"
    },
    "name": "PCI-DSS",
    "send_report_in_email": true
  }
}
Element Type Description
key string Top level element, contains the ID of the report.
<id-of-the-report> Top level item The elements of the pre-defined report.
access list List of access control groups whose members can access 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.

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

Syntax error: \"No such property; property='recipients'

Do not provide recipients if you set the selection element under email_recipients to default.
400

Bad Request

"message": "New Ids are not allowed"

Error when committing your transaction. Creating new pre-defined reports is not allowed.
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.
Modify a pre-defined report

To modify a report, you have to:

  1. Open a transaction.

    For more information, see Open a transaction.

  2. Modify the JSON object of the report.

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

  3. Commit your changes.

    For more information, see Commit a transaction.

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen