Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 8.0 LTS - 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, retrieve, download, and index sessions Reporting Health and maintenance Advanced authentication and authorization Completing the Welcome Wizard using REST Enable and configure analytics using REST REST API examples

SSH Settings Policies

Querying all SSH settings policies

Querying all SSH settings policies request 

curl --cookie cookies.txt --request GET https://<IP-address-of-SPS>/api/configuration/ssh/settings_policies
Querying the default SSH settings policy

Querying the default SSH settings policy request 

curl --cookie cookies.txt --request GET https://<IP-address-of-SPS>/api/configuration/ssh/settings_policies/-300

Querying the default SSH settings policy response 

{
    "key": "-300",
    "body": {
        "name": "default",
        "timeout": 600,
        "inactivity_timeout": {
            "enabled": false
        },
        "preconnect_channel_check": false,
        "greeting": "",
        "userauth_banner": "",
        "software_version": "SSH",
        "strict_mode": true,
        "client_side_algorithms": {
            "kex": ["diffie-hellman-group14-sha1", "diffie-hellman-group1-sha1"],
            "cipher": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "aes128-cbc", "blowfish-cbc",
                       "cast128-cbc", "aes192-cbc", "aes256-cbc", "3des-cbc", "arcfour"],
            "mac": ["hmac-sha1", "hmac-md5"],
            "compression": ["none"],
            "hostkey": ["ecdsa-sha2-nistp256", "ecdsa-sha2-nistp384", "ecdsa-sha2-nistp521", "ssh-ed25519","rsa-sha2-512","rsa-sha2-256","ssh-rsa"]
        },
        "server_side_algorithms": {
            "kex": ["diffie-hellman-group14-sha1", "diffie-hellman-group1-sha1"],
            "cipher": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "aes128-cbc", "blowfish-cbc",
                       "cast128-cbc", "aes192-cbc", "aes256-cbc", "3des-cbc", "arcfour"],
            "mac": ["hmac-sha1", "hmac-md5"],
            "compression": ["none"],
            "hostkey": ["ecdsa-sha2-nistp256", "ecdsa-sha2-nistp384", "ecdsa-sha2-nistp521", "ssh-ed25519","rsa-sha2-512","rsa-sha2-256","ssh-rsa"]
        }
    },
    "meta": {
        "first": "/api/configuration/ssh/settings_policies/-300",
        "href": "/api/configuration/ssh/settings_policies/-300",
        "last": "/api/configuration/ssh/settings_policies/93246150354ca6b9a48fba",
        "next": "/api/configuration/ssh/settings_policies/93246150354ca6b9a48fba",
        "parent": "/api/configuration/ssh/settings_policies",
        "previous": null,
        "transaction": "/api/transaction"
    }
}

Search fields available in reports

Querying search fields available in reports

Querying search fields available in reports request 

curl --cookie cookies.txt --request GET https://<IP-address-of-SPS>/api/configuration/reporting/_available_search_fields

Querying search fields available in reports response 

{
  "body": {
    "event": {
      "fields": [
        {
        "description": "The command line without prompt in commands",
        "field": "action",
        "name": "Event Action",
        "presentable": true,
        "searchable": true,
        "type": "string"
        },
        {
          "description": "The id of the channel the event belongs to.",
          "field": "channel_id",
          "name": "Channel ID",
          "presentable": true,
          "searchable": true,
          "type": "string"
        },
        {
          "description": "The command executed, or the window title detected in the channel (for example, ls, exit, or Firefox).",
          "field": "content",
          "name": "Event content",
          "presentable": true,
          "searchable": true,
          "type": "string"
        },
        {
          "description": "The details of the protocol used for the operation.",
          "field": "details",
          "name": "Protocol details",
          "presentable": true,
          "searchable": true,
          "type": "string"
        },
        {
          "description": "The identifier of the vault event.",
          "field": "event_id",
          "name": "Event ID",
          "presentable": true,
          "searchable": true,
          "type": "string"
        },
        {
          "description": "The type of the operation that occurred, for example, Create file (in the case of FTP) or GET (in the case of HTTP).",
          "field": "operation",
          "name": "Operation",
          "presentable": true,
          "searchable": true,
          "type": "string"
        },
        {
          "description": "The path (if any) used by the operation that occurred.",
          "field": "path",
          "name": "Path",
          "presentable": true,
          "searchable": true,
          "type": "string"
        },
        {
          "description": "The identifier of the event within the audit trail (.zat file).",
          "field": "record_id",
          "name": "Event ID",
          "presentable": true,
          "searchable": true,
          "type": "long"
        },
        {
          "description": "The status code of the protocol response (if any) returned.",
          "field": "response_code",
          "name": "Response code",
          "presentable": true,
          "searchable": true,
          "type": "long"
        },
        {
          "description": "The date when the event happened.",
          "field": "time",
          "name": "Event date",
          "presentable": false,
          "searchable": true,
          "type": "date"
        },
        {
          "description": "The type of the event, for example, command, screen_content, window_title.",
          "documentation": "https://support.oneidentity.com/one-identity-safeguard-for-privileged-sessions/technical-documents",
          "field": "type",
          "name": "Event type",
          "presentable": true,
          "searchable": true,
          "type": "string"
        }
      ]
    }
  }
}

Transaction handling

Querying transaction status

Querying transaction status request 

curl --cookie cookies.txt --request GET https://<IP-address-of-SPS>/api/transaction

Querying transaction status response 

{
    "body": {
        "commit_message": "optional",
        "status": "closed"
    },
    "key": "transaction",
    "meta": {
        "href": "/api/transaction",
        "parent": "/api"
    }
}

Trust stores

Querying trust stores

Querying trust stores request 

curl --cookie cookies.txt --request GET https://<IP-address-of-SPS>/api/configuration/trust_stores

Querying trust stores response 

{
    "items": [
        {
            "key": "-7001",
            "meta": {
                "href": "/api/configuration/trust_stores/-7001"
            },
            "body": {
                "name": "Built-in",
                "revocation_check": "none",
                "trust_store_type": "built-in"
            }
        },
        {
            "key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "meta": {
                "href": "/api/configuration/trust_stores/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
            },
            "body": {
                "name": "My_Custom_Trust_Store",
                "authorities": [
                    {
                        "fingerprint": {
                            "digest": "01:25:1f:a2:df:2a:31:1a:29:7a:ba:43:c4:03:42:a5:d7:30:ec:2d:e0:d7:7a:72:a7:1b:c3:99:c5:6c:10:ea",
                            "hash_algorithm": "sha256"
                        },
                        "issuer": "/C=HU/ST=Budapest/O=Internet Widgits Pty Ltd",
                        "not_after": "2034-06-18T12:36:48+00:00",
                        "not_before": "2014-08-12T12:36:48+00:00",
                        "pem": "-----BEGIN CERTIFICATE-----\nMIIDZzCCAk+gAwIBAgIUMlI5+EgTDAh2zqRDGYrzFRyozI8wDQYJKoZIhvcNAQEL\nBQAwQzELMAkGA1UEBhMCSFUxETAPBgNVBAgMCEJ1ZGFwZXN0MSEwHwYDVQQKDBhJ\nbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMTQwODEyMTIzNjQ4WhcNMzQwNjE4\nMTIzNjQ4WjBDMQswCQYDVQQGEwJIVTERMA8GA1UECAwIQnVkYXBlc3QxITAfBgNV\nBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBALffJBDD6A/ZGBTgFbyLXHulU+hGnMW3DoPo2q4HY1/FfbkS\nrzmK+Fiz+3EwJCWi+EwK9mqve/nh6YRRw/VaAVQ7CkA7f7to+I7gP647Bq1wk0lh\nBVEJNlN0jfYYSumGxzPotw/fon1MkXuMbLc0Pr/vFX3NQC7/STAV5dZFcdboXDA7\nZZ3rzBIr93ThObsGj01MRO6wrS3rfE7Px9D7C2u9YSkP3OQ1Sfm/jqyLNaT6xt4i\nhrLnfYEc8mClnrlvILi+q/D6mIUSjb4IGvergAyl4jgPjO02UcvBzOIA9tDlBJBi\nQxZx+T620ubmEwOl9Q0G8RAWKz7szrBcXEjXhYUCAwEAAaNTMFEwHQYDVR0OBBYE\nFCDfEeq5Hsm8jMrG110iNpt5cikTMB8GA1UdIwQYMBaAFCDfEeq5Hsm8jMrG110i\nNpt5cikTMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAK3iizM4\nCx69YD+4CWOUswULrCJA38C+nDYONLbNkact8JKXqCn/MaZTII+dZoV9RjjX4AzA\nPTQkZT+RoVeCZyt+qWHMdjq6koabXwQmXNozUtaxEZTrnoUDEWtNIbjV/gNtRcSG\nsU7i9L2YnwDzTw0cR/pu1Hykq8fwqNqjQGYnmXtJspMkKAtVe1CrtnPLiC6JBr0g\n5GZF58sHx5+gO0RkqdzJgRAGnImdfAahqfHmKRFmxoxWLyylRyqDgQ+KqcaDvZI+\ni36M+NQHVrDX4jo4CFoXhFlSOepvtDOpmzoWhugwDNMPuU1IEY7//CJBXQnjp+uf\nLO6PsNmMKDGi9Dk=\n-----END CERTIFICATE-----\n",
                        "subject": "/C=HU/ST=Budapest/O=Internet Widgits Pty Ltd"
                    }
                ],
                "crl_urls": [
                    "http://crl.it/sec"
                ],
                "revocation_check": "full",
                "trust_store_type": "custom"
            }
        }
    ],
    "meta": {
        "first": "/api/configuration/aaa",
        "href": "/api/configuration/trust_stores",
        "last": "/api/configuration/x509",
        "next": "/api/configuration/vnc",
        "parent": "/api/configuration",
        "previous": "/api/configuration/troubleshooting",
        "transaction": "/api/transaction"
    }
}
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating