Chat now with support
Chat with Support

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

Number of audited users

Querying the number of audited users

Querying the number of audited users request

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

Querying the number of audited users response

{
  "count": 3,
  "meta":{
    "href":"/api/audit/users/_count",
    "parent":"/api/audit/users"
  }
}

Private keys

Querying a private key

Querying a private key request

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

Querying a private key response

{
    "key": "identity-0",
    "body": {
      "public_key_fingerprint": {
          "digest": "2048 SHA256:JSFdfkT6wU9c00ddqX53hovDo7KbIB8OREfumUWDh8g no comment (RSA)",
          "hash_algorithm": "sha256"
      },
      "type": "rsa"
    }
}

Rsync backup policy

Querying backup policy

Querying backup policy request

curl --cookie cookies.txt --request GET https://<IP-address-of-SPS>/api/configuration/policies/backup_policies/99275192754364c2b1bd04

Querying backup policy response

{
    "body": {
        "include_node_id_in_path": true,
        "name": "backup_rsync",
        "notification_event": {
            "file_count_limit": 10240,
            "send_filelist": true,
            "type": "none"
        },
        "start_times": [
            "8:00"
        ],
        "target": {
            "auth_key": {
                "key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "meta": {
                    "href": "/api/configuration/private_keys/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
                }
            },
            "host_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAYQCsU80IBrJbOlqCi03qZK+FtgS783VKE1TVZBtDQlsXJ9FXu6KNBvqvSAjcXiWY+izqn+P14UVRY1vOdz7WwLIWOUoTKHfPMqv3bdjwM4Bhd26POWSFyDf46yx1YzvMwgc=",
            "path": "/data/backup",
            "port": 1122,
            "server": {
                "selection": "ip",
                "value": "192.168.122.1"
            },
            "type": "rsync",
            "username": "user1"
        }
    },
    "key": "99275192754364c2b1bd04"
}

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

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating