One Identity Safeguard for Privileged Sessions 7.4

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

Message format How to configure SPS using REST How to configure SPS using REST: a sample transaction

Authenticate to the SPS REST API Authenticate to the SPS REST API using X.509 certificate Listing SPS login methods Retrieve user information Checking the transaction status Open a transaction Commit a transaction Delete a transaction Reviewing the changelog of a transaction Defaults query parameter Application level error codes Navigating the configuration of SPS Modifying the configuration of SPS

Delete an object Create a new object Change an object

Generating SPS support bundle using REST

Basic settings

Retrieve basic firmware and host information Listing integrated products with SPS Firmware management

Retrieving information about SPS firmware image slots Testing new SPS firmware before upgrade Upgrading SPS to a new firmware Uploading new firmware to SPS Downloading and installing SPS firmware through HTTP

Network settings

Network configuration options DNS servers Routing between interfaces Naming options Network addresses Routing table Local services of SPS Local services: Web login for administrators Local services: Web login for users Local services: cluster interface System backup policy Encrypting system backup policy

Date and time

Date & time NTP servers Timezone

Logs, monitoring and alerts

Management options

Web gateway authentication

Syslog server settings Disk fill-up prevention Mail settings Health monitoring SNMP settings SNMP traps Local services: access for SNMP agents Alerting System alerts Traffic alerts

Trust stores Enabling One Identity Safeguard Remote Access without Starling Join Managing Starling Join

Retrieving the status of services related to Starling Join/Unjoin

User management and access control

User management and access control Login settings Privileges of usergroups Audit data access rules Active sessions Manage users and usergroups locally on SPS Manage usergroups locally on SPS Manage users locally on SPS Configuring LDAP servers Configuring SPS login methods Configuring the SAML2 Service Provider settings

Managing SPS

Troubleshooting options Internal certificates Passwords stored on SPS Private keys stored on SPS Private keys generated on SPS Certificates stored on SPS Local services: enabling SSH access to the SPS host Manage the SPS license Change contact information Splunk integration Splunk integration Manage SPS clusters

Promote a SPS node to be the Central Management node in a new cluster Join node(s) to the cluster Query join status Assign a role to a node Query nodes Query one particular node Query the status of all nodes in the cluster Query the status of one particular node Upload and enable a configuration synchronization plugin Disable a configuration synchronization plugin

Configuration tools in SPS

Resolving hostnames to IP addresses Testing LDAP server connection

General connection settings

Channel policy Policies Archive/Cleanup policy

Running audit data cleanup policies immediately

Audit policies Backup policy Real-time content monitoring with Content Policies LDAP servers Signing CA policies Time policy Trusted Certificate Authorities Local user databases User lists

HTTP connections

HTTP connections HTTP connection policies HTTP channels HTTP authentication policies Global HTTP options HTTP settings policies Creating custom HTTP error templates Uploading a custom logo to your custom HTTP proxy error pages

Citrix ICA connections

ICA connections ICA connection policies ICA channels Global ICA options ICA settings policies

MSSQL connections

Limitations in handling MSSQL connections MSSQL connections MSSQL connection policies MSSQL channels MSSQL authentication policies Global MSSQL options MSSQL settings policies

RDP connections

RDP connections RDP connection policies RDP channels Configuring domain membership Global RDP options RDP settings policies

SSH connections

SSH connections SSH connection policies SSH channels SSH authentication policies Global SSH options SSH settings policies SSH host keys and certificates

Telnet connections

Telnet connections Telnet connection policies Telnet channels Telnet authentication policies Global Telnet options Telnet pattern sets Telnet settings policies

VNC connections

VNC connections VNC connection policies VNC settings policies Global VNC options

Search, retrieve, download, and index sessions

Audited sessions Download audit trails Searching in the session database with the basic search method Retrieving all sessions from the session database with the advanced search method Retrieving user information from the recorded sessions Searching in connection content Generate and retrieve screenshot for content search Session statistics Session histogram Session alerts Session events Indexing sessions Session audit trail downloads Local services: configuring the indexer Indexer policies

Reporting

Reporting Reports Built-in subchapters Pre-defined reports Content subchapters Available search fields

Health and maintenance

Monitor appliance health status Monitor indexer service status

Advanced authentication and authorization

Usermapping policy Plugins

Upload a plugin Delete a plugin Check the integrity of a plugin

Authentication and authorization plugins

Configuring Authentication and Authorization plugin instances

Credential store plugins Credential stores

Completing the Welcome Wizard using REST

Enable and configure analytics using REST

Enable One Identity Safeguard for Privileged Analytics Configure One Identity Safeguard for Privileged Analytics

REST API examples

Examples

User info

REST API examples > Examples > User info

Querying user info

Querying user info request

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

Querying user info response

{

    "login_method": {

        "authentication": "local",

        "credential": "password",

        "name": "local_name"

    },

    "meta": {

        "href": "/api/user_info",

        "next": "/api",

        "transaction": "/api/transaction"

    },

    "user": {

        "name": "admin"

    }

}

VNC Connections Policies

REST API examples > Examples > VNC Connections Policies

Querying all VNC connection policies

Querying all VNC connection policies request

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

}

X.509 identities

REST API examples > Examples > X.509 identities

Querying an X.509 identity

Querying an X.509 identity request

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

Querying an X.509 identity response

{

    "key": "identity-0",

    "body": {

      "subject": "/C=RO/ST=TheRootState/L=TheRootLocality/O=TheRootOrganization/OU=TheRootOrganizationalUnit/CN=the.root.common.name.io/emailAddress=the@root.email.address.io",

      "issuer": "/C=RO/ST=TheRootState/L=TheRootLocality/O=TheRootOrganization/OU=TheRootOrganizationalUnit/CN=the.root.common.name.io/emailAddress=the@root.email.address.io",

      "issuer_chain": [],

      "not_after": "2024-08-11T13:04:43+00:00",

      "not_before": "2014-08-14T13:04:43+00:00",

      "pem": "-----BEGIN CERTIFICATE-----\nMIIEZTCCA02gAwIBAgIBATANBgkqhkiG9w0BAQ0FADCBzDELMAkGA1UEBhMCUk8x\nFTATBgNVBAgMDFRoZVJvb3RTdGF0ZTEYMBYGA1UEBwwPVGhlUm9vdExvY2FsaXR5\nMRwwGgYDVQQKDBNUaGVSb290T3JnYW5pemF0aW9uMSIwIAYDVQQLDBlUaGVSb290\nT3JnYW5pemF0aW9uYWxVbml0MSAwHgYDVQQDDBd0aGUucm9vdC5jb21tb24ubmFt\nZS5pbzEoMCYGCSqGSIb3DQEJARYZdGhlQHJvb3QuZW1haWwuYWRkcmVzcy5pbzAe\nFw0xNDA4MTQxMzA0NDNaFw0yNDA4MTExMzA0NDNaMIHMMQswCQYDVQQGEwJSTzEV\nMBMGA1UECAwMVGhlUm9vdFN0YXRlMRgwFgYDVQQHDA9UaGVSb290TG9jYWxpdHkx\nHDAaBgNVBAoME1RoZVJvb3RPcmdhbml6YXRpb24xIjAgBgNVBAsMGVRoZVJvb3RP\ncmdhbml6YXRpb25hbFVuaXQxIDAeBgNVBAMMF3RoZS5yb290LmNvbW1vbi5uYW1l\nLmlvMSgwJgYJKoZIhvcNAQkBFhl0aGVAcm9vdC5lbWFpbC5hZGRyZXNzLmlvMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwEi1z6V9Kk3djlS30p+Hf8iA\nUYU6PvyJBhK6NGqU99cS0zQL/9fVsZsxadGMLByADkWMduoXzmPuh8A16iHfu4ui\nkcAFskYNkhLTHKv8WPH74NowfsxI79fcYEEwnABPYmxubV4NdxfNbfny44JhZFzY\nj3A6GTlHonjJ3u3zlVn+AKqILs39U+ffCrYwilE75VaD2bCbb2ba4CiFM0u7s6Rz\nFthfPCm4C+f1MlSUdLsV2Hb+2zHf3NrNFklYGymAPlCQtmQjvxWnOrzi+dE5dqwR\n3FuSPWHT7FbbDAqCdxeQjxtsqV7Juk8lLsp+ogSMZi2Z+2p2edlY/lyFw91w4QID\nAQABo1AwTjAdBgNVHQ4EFgQUHCS1guZGRNHNSvIRRCht25WOJOEwHwYDVR0jBBgw\nFoAUHCS1guZGRNHNSvIRRCht25WOJOEwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0B\nAQ0FAAOCAQEAloRhnNbWa+Y0ckkEvgpZ0jB31FP9Ur7oMYt4JYUl7HF9fX59hPN7\nXq02DRQAhlNMz80rMqwl7+wn1BJW0CRv8uzUBpUqHEm77OZcFiFOS9NNvjfuhxbS\nU23GGIUtOWaZIPdoMRtIibGaP9sjKu8JHYGupHZKRxQNaQQ2ra3DQO75wbxwSV9X\nFOl7Spz8BN3wJZLBC5arMzThO0yxw6W46YI7KQbU2soH1hK1zsgoJzuNRiHuHBL3\nJvn1GYCVHxTp4UxuadrQnNN8OGJiivT48qeWiLslUxprSsqe3QzNM2o72uQ4r2II\n9BvEbOBbAExIr0fK+WykU6KGVUcIWCcn2w==\n-----END CERTIFICATE-----\n",

      "fingerprint": {

          "hash_algorithm": "sha256",

          "digest": "7a:6e:51:11:a2:19:7e:d9:b2:8e:fc:a1:72:18:25:18:51:8b:3b:dc:00:26:4f:9a:b3:95:af:63:07:28:fe:6e"

      }

    }

}

Creating an X.509 identity

Creating an X.509 identity request

curl --cookie cookies.txt --request POST --data '@-' https://<IP-address-of-SPS>/api/configuration/x509 <<'REQUEST'

{

    "pem": "-----BEGIN CERTIFICATE-----\nMIIEZTCCA02gAwIBAgIBATANBgkqhkiG9w0BAQ0FADCBzDELMAkGA1UEBhMCUk8x\nFTATBgNVBAgMDFRoZVJvb3RTdGF0ZTEYMBYGA1UEBwwPVGhlUm9vdExvY2FsaXR5\nMRwwGgYDVQQKDBNUaGVSb290T3JnYW5pemF0aW9uMSIwIAYDVQQLDBlUaGVSb290\nT3JnYW5pemF0aW9uYWxVbml0MSAwHgYDVQQDDBd0aGUucm9vdC5jb21tb24ubmFt\nZS5pbzEoMCYGCSqGSIb3DQEJARYZdGhlQHJvb3QuZW1haWwuYWRkcmVzcy5pbzAe\nFw0xNDA4MTQxMzA0NDNaFw0yNDA4MTExMzA0NDNaMIHMMQswCQYDVQQGEwJSTzEV\nMBMGA1UECAwMVGhlUm9vdFN0YXRlMRgwFgYDVQQHDA9UaGVSb290TG9jYWxpdHkx\nHDAaBgNVBAoME1RoZVJvb3RPcmdhbml6YXRpb24xIjAgBgNVBAsMGVRoZVJvb3RP\ncmdhbml6YXRpb25hbFVuaXQxIDAeBgNVBAMMF3RoZS5yb290LmNvbW1vbi5uYW1l\nLmlvMSgwJgYJKoZIhvcNAQkBFhl0aGVAcm9vdC5lbWFpbC5hZGRyZXNzLmlvMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwEi1z6V9Kk3djlS30p+Hf8iA\nUYU6PvyJBhK6NGqU99cS0zQL/9fVsZsxadGMLByADkWMduoXzmPuh8A16iHfu4ui\nkcAFskYNkhLTHKv8WPH74NowfsxI79fcYEEwnABPYmxubV4NdxfNbfny44JhZFzY\nj3A6GTlHonjJ3u3zlVn+AKqILs39U+ffCrYwilE75VaD2bCbb2ba4CiFM0u7s6Rz\nFthfPCm4C+f1MlSUdLsV2Hb+2zHf3NrNFklYGymAPlCQtmQjvxWnOrzi+dE5dqwR\n3FuSPWHT7FbbDAqCdxeQjxtsqV7Juk8lLsp+ogSMZi2Z+2p2edlY/lyFw91w4QID\nAQABo1AwTjAdBgNVHQ4EFgQUHCS1guZGRNHNSvIRRCht25WOJOEwHwYDVR0jBBgw\nFoAUHCS1guZGRNHNSvIRRCht25WOJOEwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0B\nAQ0FAAOCAQEAloRhnNbWa+Y0ckkEvgpZ0jB31FP9Ur7oMYt4JYUl7HF9fX59hPN7\nXq02DRQAhlNMz80rMqwl7+wn1BJW0CRv8uzUBpUqHEm77OZcFiFOS9NNvjfuhxbS\nU23GGIUtOWaZIPdoMRtIibGaP9sjKu8JHYGupHZKRxQNaQQ2ra3DQO75wbxwSV9X\nFOl7Spz8BN3wJZLBC5arMzThO0yxw6W46YI7KQbU2soH1hK1zsgoJzuNRiHuHBL3\nJvn1GYCVHxTp4UxuadrQnNN8OGJiivT48qeWiLslUxprSsqe3QzNM2o72uQ4r2II\n9BvEbOBbAExIr0fK+WykU6KGVUcIWCcn2w==\n-----END CERTIFICATE-----\n",

    "issuer_chain": [],

    "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAwEi1z6V9Kk3djlS30p+Hf8iAUYU6PvyJBhK6NGqU99cS0zQL\n/9fVsZsxadGMLByADkWMduoXzmPuh8A16iHfu4uikcAFskYNkhLTHKv8WPH74Now\nfsxI79fcYEEwnABPYmxubV4NdxfNbfny44JhZFzYj3A6GTlHonjJ3u3zlVn+AKqI\nLs39U+ffCrYwilE75VaD2bCbb2ba4CiFM0u7s6RzFthfPCm4C+f1MlSUdLsV2Hb+\n2zHf3NrNFklYGymAPlCQtmQjvxWnOrzi+dE5dqwR3FuSPWHT7FbbDAqCdxeQjxts\nqV7Juk8lLsp+ogSMZi2Z+2p2edlY/lyFw91w4QIDAQABAoIBAFHoZzI9z3SO2LsB\nkZByDlk7gpW3R9l+36urnJApeq2ce1Nmj1n7ifbvIfxum+RKe64YqD4bd+qeHQTM\ntuq2ZUTRtX2aq5KGTs+Tn0ROat9ErUPaDeBliwhIDoMeIePCKg7GG8AQ2XGKvSKE\n35dUecIz3rgzWTxXbxFhnLSO7j0G674Yz9WyzHaB4FZwrSYPtOYnZOBKMzFmxjqV\nw+D9lJbwypqn0xki8YeMfg9JRa4tUxzMBGf2PTRtuK5d8XtV10SZ+UBoNUzK12mL\n/zIv8Nw2fmykFhop+ODPGewq65sbmjVgiOF3dKYor+sGrbRZINzxqQRs7953v1ij\n7fwPwvUCgYEA9PoWjRfu81gmcaeVV24I7uVZPAj1D4vYWhiQXuYg1XhC/p5xNnbc\nIIbgCUOkm0qh52tny1BSMNC5UBntLgC+6ms1SXj6pyumlg+ba77KvLYSK6MR/7Ie\noz6stwh7E3iq2XkpmB+kpkXxCwmHPyPxsfc7rmKhI/Sh1ia92vTxeL8CgYEAyO+l\n2pYGwMICO780XZ61j+o+mTPOFXYj2YYl1z+u86bxFueA1BX0BaEEiEPmysc8clju\nEXB1SENx9qcu1p3Y+lL/tui9qT5AhvjwePr4qum1C8PCbT9FCG7eTWVVK1GV+jqb\n29ZbqJReMXCplo/PXnaDwHXNmiAhPSDI9n903l8CgYEA2WEZpbW5GUH9Sxjz0hMX\n5jSpjDY+jr7/CmOFqE/4jrQabqnVuAicqFhGcLIPXKVLKXkLL0RkymBMMCHxbsLG\npmjfbgTmFnULa1kKBv/UEsRVN1eKXySFP0IcLIZgABUxNazoFc7uYYTqsWqREpwo\nmkzSLpnid29aNBdInQSBSS0CgYEAvMFCz/+3AEQ/zNhk3L1GWZb2jvw3T7nXG3QF\nABr2wjPErntybcjhnpgPpeIDX+GhStl3ajJ2OhgBam7KdRl6xkxJow0nfWDZRPF9\nFGjOR9+bDx4p+m5A7xcXBSV3yGWvuYxs9Sp8l/QoN9FZvfICHv697YG8Tlh4YO/3\nWHeK1YkCgYEAhKGA66qWpNP9C7zb8WSj+/nXabhig0tZWNPRRRTB0HhCcPc3j8A8\n7I0XmPUi7mZOuEKcdTp81M/5ZCrOUUg0xOYfS8qASNjJhfWw7bg/ySc3r2z2x42Y\nwU6501uxc3H1MRWpBOq3Cd2prPvHgRE6DgjzzBf/7v/SpZpgDdu0994=\n-----END RSA PRIVATE KEY-----"

}

REQUEST

请选择您的产品：

为向您提供更好的服务，请填写'Purpose of your Chat'（联系目的）：

针对您的问题建议的解决方案