立即与支持人员聊天
与支持团队交流

One Identity Safeguard for Privileged Sessions 6.9.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, download, and index sessions Reporting Health and maintenance Advanced authentication and authorization Completing the Welcome Wizard using REST Enable and configure analytics using REST

Local services: cluster interface

To enable cluster management, enable the cluster interface on all nodes that you want to be part of your Safeguard for Privileged Sessions (SPS) cluster. Complete the following steps on each node of the cluster.

NOTE: All nodes in a cluster must run the same version of SPS.

URL
GET https://<IP-address-of-SPS>/api/configuration/local_services/cluster
Cookies
Cookie name Description Required Values
session_id Contains the authentication token of the user Required

The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API.

Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).
Sample request

The following command lists the configuration options.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/local_services/cluster
Response

The following is a sample response received when listing the configuration options.

For details of the meta object, see Message format.

{
    "body": {
        "enabled": true,
        "listen_address": {
            "key": "nic1.interfaces.ff7574025754b3df1647001.addresses.2553887595ce3ca7f1eae4",
            "meta": {
                "href": "/api/configuration/network/nics/nic1#interfaces/ff7574025754b3df1647001/addresses/2553887595ce3ca7f1eae4"
            }
        }
    },
    "key": "cluster",
    "meta": {
        "first": "/api/configuration/local_services/admin_web",
        "href": "/api/configuration/local_services/cluster",
        "last": "/api/configuration/local_services/user_web",
        "next": "/api/configuration/local_services/indexer",
        "parent": "/api/configuration/local_services",
        "previous": "/api/configuration/local_services/analytics",
        "remaining_seconds": 600,
        "transaction": "/api/transaction"
    }
}
Element Type Description
enabled boolean

By default, this option is set to false. Set it to true to enable the cluster interface.

listen_address Top level element (string) Contains the key of the network interface that is used as the cluster interface.
Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code Description Notes
401 Unauthenticated The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403 Unauthorized The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404 NotFound The requested object does not exist.

System backup policy

System backup uses a backup policy to create a snapshot of the configuration of One Identity Safeguard for Privileged Sessions (SPS) to a remote backup server. For details on how backup policies work, see "Data and configuration backups" in the Administration Guide. For details on configuring a backup policy using the REST API, see Backup policy. To encypt the backup, see Encrypting system backup policy.

URL
GET https://<IP-address-of-SPS>/api/configuration/management/system_backup
Cookies
Cookie name Description Required Values
session_id Contains the authentication token of the user Required

The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API.

Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).
Sample request

The following command lists the system backup settings of SPS.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/system_backup
Response

The following is a sample response received when listing the endpoints for date and time settings.

For details of the meta object, see Message format.

{
  "body": {
      "backup_policy": "<key-to-a-backup-policy>"
    },
  "key": "system_backup",
  "meta": {
    "first": "/api/configuration/management/certificates",
    "href": "/api/configuration/management/system_backup",
    "last": "/api/configuration/management/webinterface",
    "next": "/api/configuration/management/universal_siem_forwarder",
    "parent": "/api/configuration/management",
    "previous": "/api/configuration/management/syslog",
    "remaining_seconds": 600,
    "transaction": "/api/transaction"
  }
}
Element Description
backup_policy

Contains the ID of the backup policy to use for system backups. For details on configuring a backup policy using the REST API, see Backup policy.
Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code Description Notes
401 Unauthenticated The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403 Unauthorized The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404 NotFound The requested object does not exist.

Encrypting system backup policy

System backup uses a backup policy to create a snapshot of the configuration of One Identity Safeguard for Privileged Sessions (SPS) to a remote backup server. For details on how backup policies work, see "Data and configuration backups" in the Administration Guide. For details on configuring a backup policy using the REST API, see Backup policy. This section describes how to create encrypted system backups.

URL
GET https://<IP-address-of-SPS>/api/management/exported_configuration_encryption
Cookies
Cookie name Description Required Values
session_id Contains the authentication token of the user Required

The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API.

Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).
Sample request

The following command lists the system backup settings of SPS.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/exported_configuration_encryption
Response

The following is a sample response received when listing the endpoints for date and time settings.

For details of the meta object, see Message format.

{
    "body": {
        "encryption": {
            "enabled": true,
            "gpg_public_key": {
                "fingerprint": "2F2E3967EDAD2F288E54EE8693B99C4F545B7670",
                "public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nmQGNBF3rnZ0BDADHdz5/kCkrl7T8w861AGGXdGK/lwxunTCx6tfhSsFREWmKjhfr\nYTLNxsodALXtAphHeNAeUWwXjYDJelAlMVcDrVtLp7Ht8tqnmNt2NWUSmfFIF3ga\nD1OsH2UjT5Xt6XAjKvFfWeHSxkS0QHIcLfUT5WDoUcTEsR8jEdj80A7Z6.......
            CT1WwbMg5VoXQ3Rpp8evcUTzy3+ra/GosCSaFSrE31pyXkULB9+EAU7W\n23YDiM21csIaqX+XDGMex5Hq4PMhO7cqSMyB\n=j20J\n-----END PGP PUBLIC KEY BLOCK-----\n",
                "uids": [
                    "Demo User <example@oneidentity.com>"
                ]
            }
        }
    },
    "key": "exported_configuration_encryption",
    "meta": {
        "first": "/api/configuration/management/certificates",
        "href": "/api/configuration/management/exported_configuration_encryption",
        "last": "/api/configuration/management/webinterface",
        "next": "/api/configuration/management/health_monitoring",
        "parent": "/api/configuration/management",
        "previous": "/api/configuration/management/email",
        "remaining_seconds": 600,
        "transaction": "/api/transaction"
    }
}
Elements of encryption Type Description
encryption Top level element Defines encryption settings for system backups.
enabled boolean

When set to True, enables encryption of the system backups. Enabling encryption requires setting the gpg_public_key option.

gpg_public_key JSON object

Contains the fingerprint, public_key, and the list of uids of the GPG public key used to encrypt system backups. For example:

"gpg_public_key": {
    "fingerprint": "2F2E3967EDAD2F288E54EE8693B99C4F545B7670",
    "public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nmQGNBF3rnZ0BDADHdz5/kCkrl7T8w861AGGXdGK/lwxunTCx6tfhSsFREWmKjhfr\nYTLNxsodALXtAphHeNAeUWwXjYDJelAlMVcDrVtLp7Ht8tqnmNt2NWUSmfFIF3ga\nD1OsH2UjT5Xt6XAjKvFfWeHSxkS0QHIcLfUT5WDoUcTEsR8jEdj80A7Z6hKyF29g\...
    R40Niv4Ge6aYneDpk3yTBco6bBYDR7NKA7OREXCfqcyCeYB121UQ\nbb5aTZAaW8D8IRmybxpRxRAaHZX0apBgDLKwWf48kLOnOC9O7hgcyY1spZgTGz7i\nTryxlBl/CT1WwbMg5VoXQ3Rpp8evcUTzy3+ra/GosCSaFSrE31pyXkULB9+EAU7W\n23YDiM21csIaqX+XDGMex5Hq4PMhO7cqSMyB\n=j20J\n-----END PGP PUBLIC KEY BLOCK-----\n",
    "uids": [
        "Demo User <example@oneidentity.com>"
    ]
}
Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code Description Notes
401 Unauthenticated The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403 Unauthorized The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404 NotFound The requested object does not exist.

Date and time

相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级