Tchater maintenant avec le support
Tchattez avec un ingénieur du 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

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

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

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
Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation