Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 7.2.1 - 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 --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 --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"
    }
}

Transaction handling

Querying transaction status

Querying transaction status request 

curl --cookie cookies --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"
    }
}

VNC Connections Policies

Querying all VNC connection policies

Querying all VNC connection policies request 

curl --cookie cookies --request GET https://<IP-address-of-SPS>/api/configuration/vnc/connections
Querying a specific VNC connection policy

Querying a specific VNC connection policy request 

curl --cookie cookies --request GET https://<IP-address-of-SPS>/api/configuration/vnc/connections/130169583263cfc5f16d727

Querying a specific VNC connection policy response 

{
    "body": {
        "name": "test_connection",
        "active": true,
        "network": {
            "clients": ["0.0.0.0/0"],
            "targets": ["0.0.0.0/0"],
            "ports": [5900]
        },
        "server_address": {
            "selection": "original",
            "custom_dns": {
                "enabled": false
            }
        },
        "source_address": {
            "selection": "box_address"
        },
        "client_side_transport_security": {
            "selection": "tls",
            "sps_certificate": {
                "selection": "generate",
                "signing_ca": {
                    "key": "25284480263cfc687996aa",
                    "meta": {
                        "href": "/api/configuration/policies/signing_cas/25284480263cfc687996aa"
                    }
                }
            },
            "peer_certificate_check": {
                "enabled": false
            }
        },
        "server_side_transport_security": {
            "selection": "disabled"
        },
        "access_control": [],
        "web_gateway_authentication": {
            "enabled": false
        },
        "indexing": {
            "enabled": true,
            "priority": 3,
            "policy": {
                "key": "-50000",
                "meta": {
                    "href": "/api/configuration/policies/indexing/-50000"
                 }
             }
        },
        "rate_limit": {
            "enabled": false
        },
        "log_audit_trail_downloads": true,
        "override_log_level": {
            "enabled": false
        },
        "policies": {
            "audit_policy": {
                "key": "78101850949e47437dd91d",
                "meta": {
                    "href": "/api/configuration/policies/audit_policies/78101850949e47437dd91d"
                }
            },
            "channel_policy": {
                "key": "-30100112",
                "meta": {
                    "href": "/api/configuration/vnc/channel_policies/-30100112"
                }
            },
            "settings": {
                "key": "-30211",
                "meta": {
                    "href": "/api/configuration/vnc/settings_policies/-30211"
                }
            },
            "backup_policy": null,
            "archive_cleanup_policy": null,
            "analytics_policy": {
                "key": "32077743363cecb4629ea7",
                "meta": {
                    "href": "/api/configuration/policies/analytics/32077743363cecb4629ea7"
                }
            }
        }
    },
    "key": "130169583263cfc5f16d727"
}
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating