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

Reports

List of the configured reports.

URL

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

Cookies

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

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.

Add a report

To add a report, you have to:

1. Open a transaction.

   For details, 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 details, see Commit a transaction.

Modify a report

To modify a report, you have to:

1. Open a transaction.

   For details, 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 details, see Commit a transaction.

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

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

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.

Modify a pre-defined report

To modify a report, you have to:

1. Open a transaction.

   For details, 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 details, see Commit a transaction.

Content subchapters

Reporting subchapters created from audit trail content (statistics of search keywords, and screenshots). You have to provide a list of keywords, and create the appropriate filters to narrow down the scope of the search. SPS searches the indexed content of all audit trails that fit the filter criteria, and provide the resulting statistics and screenshots in the report.

Configure and enable indexing for all connections that you want to include in the reports.

URL

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

Cookies

Sample request

The following command lists the available content subchapters.

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

The following command retrieves the properties of a specific subchapter.

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

Response

The following is a sample response received when listing content subchapters.

For details of the meta object, see Message format.

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

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

{
  "body": {
    "access": [
      "search"
    ],
    "filter": {
      "channel_policy": {
        "key": "-10200",
        "meta": {
          "href": "/api/configuration/ssh/channel_policies/-10200"
        }
      },
      "connection_policy": "8348340645707e2575e3c6",
      "protocol": "ssh",
      "server_address": "192.168.56.102",
      "server_port": 22,
      "source_address": "192.168.56.101",
      "source_port": 22,
      "username": "admin"
    },
    "name": "API_test_subchapter",
    "search_words": [
      "logout"
    ]
  },
  "key": "13869311625707e0a3e0892",
  "meta": {
    "first": "/api/configuration/reporting/content_subchapters/13869311625707e0a3e0892",
    "href": "/api/configuration/reporting/content_subchapters/13869311625707e0a3e0892",
    "last": "/api/configuration/reporting/content_subchapters/13869311625707e0a3e0892",
    "next": null,
    "parent": "/api/configuration/reporting/content_subchapters",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

Examples:

Create a content subchapter for the occurences of the "logout" keyword in SSH connections. Make the subchapter accessible to the search and report usergroups.

• Search connections where the "shell-only" channel policy is used.

  {
    "access": [
      "search",
      "report"
    ],
    "filter": {
      "channel_policy": "-10000",
      "connection_policy": null,
      "protocol": "ssh",
      "server_address": null,
      "server_port": null,
      "source_address": null,
      "source_port": null,
      "username": null
    },
    "name": "Shell_access",
    "search_words": [
      "logout"
    ]
  }

• Search connections of a specific connection policy. Provide the protocol of the connection. The key of the connection policy is available at the /api/configuration/<protocol>/connections/ endpoint.

  {
    "access": [
      "search",
      "report"
    ],
    "filter": {
      "channel_policy": null,
      "connection_policy": "<key-of-connection-policy>",
      "protocol": "ssh",
      "server_address": null,
      "server_port": null,
      "source_address": null,
      "source_port": null,
      "username": null
    },
    "name": "Controlled_access",
    "search_words": [
      "logout"
    ]
  }

• Search connections where the "admin" username was used.

  {
    "access": [
      "search",
      "report"
    ],
    "filter": {
      "channel_policy": null,
      "connection_policy": null,
      "protocol": "ssh",
      "server_address": null,
      "server_port": null,
      "source_address": null,
      "source_port": null,
      "username": "admin"
    },
    "name": "Login_as_admin",
    "search_words": [
      "logout"
    ]
  }

• Search connections made to a specific server address and port.

  {
    "access": [
      "search",
      "report"
    ],
    "filter": {
      "channel_policy": null,
      "connection_policy": null,
      "protocol": "ssh",
      "server_address": "<server-ip>",
      "server_port": <port>,
      "source_address": null,
      "source_port": null,
      "username": null
    },
    "name": "Server_access",
    "search_words": [
      "logout"
    ]
  }

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.

Add a content subchapter

To add a content subchapter, you have to:

1. Open a transaction.

   For details, see Open a transaction.

2. Create the JSON object for the new content subchapter.

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

   • To use a channel policy for filtering, use the key of the policy. You must also set the protocol element to the corresponding protocol.

     For example, to use the shell-only channel policy, which is a default SSH policy provided by SPS, you have to configure both the channel_policy element…

     "channel_policy": "-10000"

     …and the protocol element:

     "protocol": "ssh"

   If the POST request is successful, the response includes the key of the new subchapter. For example:

   {
     "key": "416bb324-b44e-4ed3-a49d-02e99e53e941",
     "meta": {
       "href": "/api/configuration/reporting/content_subchapters/416bb324-b44e-4ed3-a49d-02e99e53e941",
       "parent": "/api/configuration/reporting/content_subchapters",
       "transaction": "/api/transaction"
     }
   }

3. Commit your changes.

   For details, see Commit a transaction.

Modify a content subchapter

To modify a content subchapter, you have to:

1. Open a transaction.

   For details, see Open a transaction.

2. Modify the JSON object of the subchapter.

   You can find a detailed description of the available parameters listed in Element

   To use a channel policy for filtering, do not include the returned key and meta elements of the channel policy in your PUT request. Instead, set the value of the channel_policy to the value of its key.

   For example, if a GET request for the subchapter returns the following channel_policy filter:

   "channel_policy": {
     "key": "-10200",
     "meta": {
       "href": "/api/configuration/ssh/channel_policies/-10200"
     }
   }

   You have to change it in your PUT request to:

   "channel_policy": "-10200"

   You must also configure the protocol element to the protocol of the channel policy.

3. Upload the modified configuration

   PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/reporting/content_subchapters/<subchapter-key> endpoint.

4. Commit your changes.

   For details, see Commit a transaction.