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

Trusted CA list

Querying trusted CA lists

Querying trusted CA lists request 

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

Querying trusted CA lists response 

{
  "items": [
    {
      "body": {
        "authorities": [
          {
            "certificate": {
              "fingerprint": {
                "digest": "a2:bf:82:70:db:24:67:84:5f:f4:f7:2b:4e:9a:0d:bd:55:c1:96:0c:04:7d:f2:a3:aa:07:9b:2c:f7:28:99:70",
                "hash_algorithm": "sha256"
              },
              "issuer": "/C=CA/ST=TheCaState/L=TheCaLocality/O=TheCaOrganization/OU=TheCaOrganizationalUnit/CN=TheCaCommonName/emailAddress=ca@email.io",
              "not_after": "2024-08-10T20:14:39+00:00",
              "not_before": "2014-08-13T20:14:39+00:00",
              "pem": "-----BEGIN CERTIFICATE-----\nMIIGKTCCBBGgAwIBAgIBATANBgkqhkiG9w0BAQ0FADCBrjELMAkGA1UEBhMCQ0Ex\nEzARBgNVBAgMClRoZUNhU3RhdGUxFjAUBgNVBAcMDVRoZUNhTG9jYWxpdHkxGjAY\nBgNVBAoMEVRoZUNhT3JnYW5pemF0aW9uMSAwHgYDVQQLDBdUaGVDYU9yZ2FuaXph\ndGlvbmFsVW5pdDEYMBYGA1UEAwwPVGhlQ2FDb21tb25OYW1lMRowGAYJKoZIhvcN\nAQkBFgtjYUBlbWFpbC5pbzAeFw0xNDA4MTMyMDE0MzlaFw0yNDA4MTAyMDE0Mzla\nMIGuMQswCQYDVQQGEwJDQTETMBEGA1UECAwKVGhlQ2FTdGF0ZTEWMBQGA1UEBwwN\nVGhlQ2FMb2NhbGl0eTEaMBgGA1UECgwRVGhlQ2FPcmdhbml6YXRpb24xIDAeBgNV\nBAsMF1RoZUNhT3JnYW5pemF0aW9uYWxVbml0MRgwFgYDVQQDDA9UaGVDYUNvbW1v\nbk5hbWUxGjAYBgkqhkiG9w0BCQEWC2NhQGVtYWlsLmlvMIICIjANBgkqhkiG9w0B\nAQEFAAOCAg8AMIICCgKCAgEAww6OH1Ve5A5FpJy/WjIHxyBXPxgglJPnx4Yhzu54\ndtygNUdhCA1zK4blp98ScL1mZBbTMxdafStXFfpWH0S7E+2HNKcn/8WmTPit/EHU\nScrvvfX3B0YNRWj1/07kZk7NNrsMM7na9ogdtFCOsMJie2miHZIl1TKrjk5iwqNF\nIOcbiEQyZIvGeZ0ygIx1IumgobyTsLrReg1m5N1lgB2BGoZPxVAi5lniKHybhr3c\nzXEhfeYJqhgJs9klInqYRpHegOMIfu2SLE5Smc5ER7dHVRtz5qipAHvjMtlTbMCA\nMW27D2jYxV825S2tcqGLt29+DY6HLU42MOVIP6AnnXwDeeedGFggWnPKkexlk3Np\noY+A5BNpvVCjR6B6isjJMZix2xNcvjUL7UCwVGrjXUGh92oCxp/nB4Ye6DU5W/Ib\nsMnlIaU2VHhOdB1xBAJm6fsZt0fw2zQho03J9fu+lHuJcy+BH7GFI3Mq16Y5V4I+\nAMefhyfjYvwsLi9duaRPXc8La3tLyUXfCz3OcSk6uMRXIG07jU5tox77zVdVwiLo\nTJr0NxcsejbqA+JUBxOC1NnOqL09KOgS0DM8KOLvL3Fn2qJAb+CZMJ6hGwwG/4ou\nemGnBmww5IoF4C/uzc5fdLf4CNOhZlMyaJdK+ch8EgA4L5+TDRpS68Mr61M0eIzm\n0EUCAwEAAaNQME4wHQYDVR0OBBYEFB2uFEEasuvs54CajKxDHFppfUywMB8GA1Ud\nIwQYMBaAFB2uFEEasuvs54CajKxDHFppfUywMAwGA1UdEwQFMAMBAf8wDQYJKoZI\nhvcNAQENBQADggIBABSwj0DcaloHUkIUw0MJt2NyY2B5MAl+AFXqQ1nRP5iWxTKN\nAwko1J4OjALCKbN64bhA3WUDEFzQpiJtG9StRYoEeYc0MwjTm9FAHsTArdPL7pVu\nxCAJjWOQ9DGXcyI8oMUaRN4i+NzWi2cLSsvpt8BP4eQhgiE7dS5sQJ6D3CgvmuNm\nwzzJxx7DGXmQPCtYfX65QUwZOcbBfw/P8qeNQ2Ua49k01MlCi8z/vciALv14t1gW\nMtPTgaoqb+YMMBv0dZ6vE8U1rZy4nY65c+Nn14Oohd4A0YAkb0LZsuhfA/2tdrNs\n0Q2iCbOZ5uUTzkZE6tOrxkNr4+EqQbk6H0MhsW5W82gP7aI1ZbWYvjv/kLrNdFQf\nIMUE0Or9Ojer0t85lpzKx2A3DnFjWithyBeDnJfVxIMabUtKaV4cRJrJyj/21Jt1\n9vtG6uix0K6Aozmk0DyX/3gH5aNompCS6d942ANGVqQvdsawXAXV6SoIHCtPyRG9\nIQqMlRrBJLZulEfNM91UgDYyS5fBg49Fp6bZwiPFh+mk+p/j4cAQ+kltKQVb9wz7\nPtpVa3h4wEs2RnMs0lnv3i6U1eO+Fx52imDwP2Ik8miaMcyX33b0lWMxkrCWdD0X\n2tjcWpnETbL2yXaXb2GT+mLuDGYdyEM+a6I3xMB4jO4H0EynmM7O/C3f+2NU\n-----END CERTIFICATE-----\n",
              "subject": "/C=CA/ST=TheCaState/L=TheCaLocality/O=TheCaOrganization/OU=TheCaOrganizationalUnit/CN=TheCaCommonName/emailAddress=ca@email.io"
            },
            "crl": null
          }
        ],
        "dn_check": {
          "altEmailAddress": "admin@company",
          "c": "HU",
          "cn": "ldap.company",
          "emailAddress": "administrator@company",
          "l": "Some Street 1",
          "o": "Company",
          "ou": "Security Team",
          "st": "Budapest"
        },
        "dns_lookup": true,
        "name": "CA-for-LDAP-server-auth",
        "strict_hostcheck": true
      },
      "key": "544893247544627d36e68e",
      "meta": {
        "href": "/api/configuration/policies/trusted_ca_lists/544893247544627d36e68e"
      }
    },
    {
      "body": {
        "authorities": [
          {
            "certificate": {
              "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": "http://crl.it.company/security-team"
          },
          {
            "certificate": {
              "fingerprint": {
                "digest": "56:83:96:91:ec:95:8b:0a:c5:3c:32:8b:24:29:35:93:9c:09:53:6a:aa:59:dc:3b:3a:ba:b1:42:2d:58:1c:d1",
                "hash_algorithm": "sha256"
              },
              "issuer": "/C=HU/ST=Budapest/O=Internet Widgits Pty Ltd/CN=Chained CA",
              "not_after": "2042-02-13T13:54:33+00:00",
              "not_before": "2014-09-29T13:54:33+00:00",
              "pem": "-----BEGIN CERTIFICATE-----\nMIIDxzCCAq+gAwIBAgICRWwwDQYJKoZIhvcNAQELBQAwWDELMAkGA1UEBhMCSFUx\nETAPBgNVBAgMCEJ1ZGFwZXN0MSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0\neSBMdGQxEzARBgNVBAMMCkNoYWluZWQgQ0EwHhcNMTQwOTI5MTM1NDMzWhcNNDIw\nMjEzMTM1NDMzWjBaMQswCQYDVQQGEwJIVTERMA8GA1UECAwIQnVkYXBlc3QxITAf\nBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEVMBMGA1UEAwwMTG93IGxl\ndmVsIENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0q11QEkLBq8t\n/jY/p7F6OPEgNVvGpanTtbpKoYLCzUOoEGxQRrNYHd+g2QpUpe/aOYYelH+LCJo1\nc/g1rCiH3ZbyB2ALvORDCifdyJOwFS+kpdVnKw1k1HyrR3mlT4Zimc6zYTTLTnpB\nvCSsFjaq+38fdkjyBPm8A3oi5gg1LuXsWGls/tEZKg0MyQm28W78xLHrxcz0qgOS\nu6PX4ta9uB6siU0RwUQZK9rnG0Amf7XkuQhsVh7FZH5+GfLqMDjiRc4DElIabaHx\nXyzTOVGNTRBt7pRdV7RCGz4zN6qRMgDwrGcuNWoAGTS29tqsvAQwmGNognFOvOPs\nUs/DkSKawQIDAQABo4GYMIGVMBIGA1UdEwEB/wQIMAYBAf8CAQAwLwYDVR0fBCgw\nJjAkoCKgIIYeaHR0cDovL2NybC5kZXZlbC5iYWxhYml0LzEuY3JsMA4GA1UdDwEB\n/wQEAwIBBjAdBgNVHQ4EFgQUSO7MuQhH85oWTTNC4FdvHdW3FT0wHwYDVR0jBBgw\nFoAUmOJaDKbO1mKJ2eO5iTPUXUS5WFgwDQYJKoZIhvcNAQELBQADggEBABReQoBk\nPFl2CcQfJhZRiTOa1Njuj51D/NOVVIKaWHjMkcm2LbC3g58hME5Eh0TZ5t0a9Lbz\nfscn2oSHTviy9Lljb67v4UHQWYtgK6OV9swHgqvHvzdKCO84zWvZrI9kvM2qUo5S\nHIBB8ZtmU+wNL5P5JyAsJ3TFxSwKL5sVbvZkgvnYDRXdGJOORj6hSXWmtYAiTdQ4\ncP3LM65/24TP7ygdnqVIUCbz7vBYAB8ejEYY5lUzeUpyJ7XyQgQNdyp7CPMzILr2\nTnYBxWTBwPi1GVk1AzPlSd3eNQbZfCpxthMIJw2p9nDW5tKmZGoDT31wpQ0BsNud\n38KHwVldP+u5aeE=\n-----END CERTIFICATE-----\n",
              "subject": "/C=HU/ST=Budapest/O=Internet Widgits Pty Ltd/CN=Low level CA"
            },
            "crl": "http://crl.it.company/end-users"
          }
        ],
        "dn_check": {
          "altEmailAddress": null,
          "c": "HU",
          "cn": "$username",
          "emailAddress": "administrator@company",
          "l": null,
          "o": "Company",
          "ou": null,
          "st": "Budapest"
        },
        "dns_lookup": false,
        "name": "CA-for-user-auth",
        "strict_hostcheck": true
      },
      "key": "1792500305544627d371c21",
      "meta": {
        "href": "/api/configuration/policies/trusted_ca_lists/1792500305544627d371c21"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/policies/aa_plugin_instances",
    "href": "/api/configuration/policies/trusted_ca_lists",
    "last": "/api/configuration/policies/usermapping_policies",
    "next": "/api/configuration/policies/user_databases",
    "parent": "/api/configuration/policies",
    "previous": "/api/configuration/policies/time_policies",
    "transaction": "/api/transaction"
  }
}
Querying a trusted CA list

Querying a trusted CA list request 

curl --cookie cookies.txt --request GET https://<IP-address-of-SPS>/api/configuration/policies/trusted_ca_lists/544893247544627d36e68e

Querying a trusted CA list response 

{
    "key": "544893247544627d36e68e",
    "body": {
        "name": "CA-for-LDAP-server-auth",
        "authorities": [
            {
            "certificate": {
                "fingerprint": {
                    "digest": "a2:bf:82:70:db:24:67:84:5f:f4:f7:2b:4e:9a:0d:bd:55:c1:96:0c:04:7d:f2:a3:aa:07:9b:2c:f7:28:99:70",
                    "hash_algorithm": "sha256"
                },
                "issuer": "/C=CA/ST=TheCaState/L=TheCaLocality/O=TheCaOrganization/OU=TheCaOrganizationalUnit/CN=TheCaCommonName/emailAddress=ca@email.io",
                "not_after": "2024-08-10T20:14:39+00:00",
                "not_before": "2014-08-13T20:14:39+00:00",
                "subject": "/C=CA/ST=TheCaState/L=TheCaLocality/O=TheCaOrganization/OU=TheCaOrganizationalUnit/CN=TheCaCommonName/emailAddress=ca@email.io",
                "pem": "-----BEGIN CERTIFICATE-----\nMIIGKTCCBBGgAwIBAgIBATANBgkqhkiG9w0BAQ0FADCBrjELMAkGA1UEBhMCQ0Ex\nEzARBgNVBAgMClRoZUNhU3RhdGUxFjAUBgNVBAcMDVRoZUNhTG9jYWxpdHkxGjAY\nBgNVBAoMEVRoZUNhT3JnYW5pemF0aW9uMSAwHgYDVQQLDBdUaGVDYU9yZ2FuaXph\ndGlvbmFsVW5pdDEYMBYGA1UEAwwPVGhlQ2FDb21tb25OYW1lMRowGAYJKoZIhvcN\nAQkBFgtjYUBlbWFpbC5pbzAeFw0xNDA4MTMyMDE0MzlaFw0yNDA4MTAyMDE0Mzla\nMIGuMQswCQYDVQQGEwJDQTETMBEGA1UECAwKVGhlQ2FTdGF0ZTEWMBQGA1UEBwwN\nVGhlQ2FMb2NhbGl0eTEaMBgGA1UECgwRVGhlQ2FPcmdhbml6YXRpb24xIDAeBgNV\nBAsMF1RoZUNhT3JnYW5pemF0aW9uYWxVbml0MRgwFgYDVQQDDA9UaGVDYUNvbW1v\nbk5hbWUxGjAYBgkqhkiG9w0BCQEWC2NhQGVtYWlsLmlvMIICIjANBgkqhkiG9w0B\nAQEFAAOCAg8AMIICCgKCAgEAww6OH1Ve5A5FpJy/WjIHxyBXPxgglJPnx4Yhzu54\ndtygNUdhCA1zK4blp98ScL1mZBbTMxdafStXFfpWH0S7E+2HNKcn/8WmTPit/EHU\nScrvvfX3B0YNRWj1/07kZk7NNrsMM7na9ogdtFCOsMJie2miHZIl1TKrjk5iwqNF\nIOcbiEQyZIvGeZ0ygIx1IumgobyTsLrReg1m5N1lgB2BGoZPxVAi5lniKHybhr3c\nzXEhfeYJqhgJs9klInqYRpHegOMIfu2SLE5Smc5ER7dHVRtz5qipAHvjMtlTbMCA\nMW27D2jYxV825S2tcqGLt29+DY6HLU42MOVIP6AnnXwDeeedGFggWnPKkexlk3Np\noY+A5BNpvVCjR6B6isjJMZix2xNcvjUL7UCwVGrjXUGh92oCxp/nB4Ye6DU5W/Ib\nsMnlIaU2VHhOdB1xBAJm6fsZt0fw2zQho03J9fu+lHuJcy+BH7GFI3Mq16Y5V4I+\nAMefhyfjYvwsLi9duaRPXc8La3tLyUXfCz3OcSk6uMRXIG07jU5tox77zVdVwiLo\nTJr0NxcsejbqA+JUBxOC1NnOqL09KOgS0DM8KOLvL3Fn2qJAb+CZMJ6hGwwG/4ou\nemGnBmww5IoF4C/uzc5fdLf4CNOhZlMyaJdK+ch8EgA4L5+TDRpS68Mr61M0eIzm\n0EUCAwEAAaNQME4wHQYDVR0OBBYEFB2uFEEasuvs54CajKxDHFppfUywMB8GA1Ud\nIwQYMBaAFB2uFEEasuvs54CajKxDHFppfUywMAwGA1UdEwQFMAMBAf8wDQYJKoZI\nhvcNAQENBQADggIBABSwj0DcaloHUkIUw0MJt2NyY2B5MAl+AFXqQ1nRP5iWxTKN\nAwko1J4OjALCKbN64bhA3WUDEFzQpiJtG9StRYoEeYc0MwjTm9FAHsTArdPL7pVu\nxCAJjWOQ9DGXcyI8oMUaRN4i+NzWi2cLSsvpt8BP4eQhgiE7dS5sQJ6D3CgvmuNm\nwzzJxx7DGXmQPCtYfX65QUwZOcbBfw/P8qeNQ2Ua49k01MlCi8z/vciALv14t1gW\nMtPTgaoqb+YMMBv0dZ6vE8U1rZy4nY65c+Nn14Oohd4A0YAkb0LZsuhfA/2tdrNs\n0Q2iCbOZ5uUTzkZE6tOrxkNr4+EqQbk6H0MhsW5W82gP7aI1ZbWYvjv/kLrNdFQf\nIMUE0Or9Ojer0t85lpzKx2A3DnFjWithyBeDnJfVxIMabUtKaV4cRJrJyj/21Jt1\n9vtG6uix0K6Aozmk0DyX/3gH5aNompCS6d942ANGVqQvdsawXAXV6SoIHCtPyRG9\nIQqMlRrBJLZulEfNM91UgDYyS5fBg49Fp6bZwiPFh+mk+p/j4cAQ+kltKQVb9wz7\nPtpVa3h4wEs2RnMs0lnv3i6U1eO+Fx52imDwP2Ik8miaMcyX33b0lWMxkrCWdD0X\n2tjcWpnETbL2yXaXb2GT+mLuDGYdyEM+a6I3xMB4jO4H0EynmM7O/C3f+2NU\n-----END CERTIFICATE-----\n"
                },
                "crl": null
            }
        ],
        "dns_lookup": true,
        "strict_hostcheck": true,
        "dn_check": {
            "cn": "ldap.company",
            "c": "HU",
            "o": "Company",
            "ou": "Security Team",
            "emailAddress": "administrator@company",
            "altEmailAddress": "admin@company",
            "st": "Budapest",
            "l": "Some Street 1"
        }
    },
    "meta": {
        "first": "/api/configuration/policies/trusted_ca_lists/544893247544627d36e68e",
        "href": "/api/configuration/policies/trusted_ca_lists/544893247544627d36e68e",
        "last": "/api/configuration/policies/trusted_ca_lists/1792500305544627d371c21",
        "next": "/api/configuration/policies/trusted_ca_lists/1792500305544627d371c21",
        "parent": "/api/configuration/policies/trusted_ca_lists",
        "previous": null,
        "transaction": "/api/transaction"
    }
}

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

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating