지금 지원 담당자와 채팅
지원 담당자와 채팅

One Identity Safeguard for Privileged Sessions 7.1.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

Telnet pattern sets

List of Telnet pattern sets that help to extract the username from Telnet connections.

URL
GET https://<IP-address-of-SPS>/api/configuration/telnet/pattern_sets
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 more information on authentication, see Authenticate to the SPS REST API.

NOTE: 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 available Telnet pattern sets.

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

The following is a sample response received when listing the available Telnet pattern sets.

For more information on the meta object, see Message format.

{
  "items": [
    {
      "body": { "name": "Cisco devices",
            "description: "Cisco devices that require authentication"
      },
      "key": "-8000",
      "meta": { "href": "/api/configuration/telnet/pattern_sets/-8000" }
    },
    {
      "body": { "name": "Cisco devices without authentication",
            "description": "Cisco devices that do not require authentication"
      },
      "key": "-8001",
      "meta": { "href": "/api/configuration/telnet/pattern_sets/-8001" }
    },
    {
      "body": { "name": "General Telnet",
            "description": "General Telnet servers (for example, Linux telnetd)"
      },
      "key": "-8002",
      "meta": { "href": "/api/configuration/telnet/pattern_sets/-8002" }
    }
  ],
  "meta": {
    "first": "/api/configuration/telnet/authentication_policies",
    "href": "/api/configuration/telnet/pattern_sets",
    "last": "/api/configuration/telnet/pattern_sets",
    "next": null,
    "parent": "/api/configuration/telnet",
    "previous": "/api/configuration/telnet/options",
    "remaining_seconds": 600,
    "transaction": "/api/transaction"
  }
}
Element Type Description
key string Contains the ID of the pattern set. The pattern set IDs can be used for specifying the active_pattern_sets JSON list at the configuration of Telnet authentication policies..
body string Contains the descriptive name of the pattern set.
name string Descriptive name of the pattern set.

To upload a telnet pattern set:

  1. Open a transaction.

    For more information, see Open a transaction.

  2. Upload the telnet pattern set file.

    POST the valid_pattern_set.tps file to the https://<IP-address-of-SPS>/api/upload/pattern_set endpoint, for example:

    curl -X POST --cookie cookies --insecure https://<IP-address-of-SPS>/api/upload/pattern_set --data-binary @<path-to-pattern_set.tps>

    The following is a sample response received:

    For details of the meta object, see Message format.

    {
       "body": {
         "description": "Test Pattern Set description",
         "name": "Test Pattern Set"
       },
       "key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
       "meta": {
         "href": "/api/configuration/telnet/pattern_sets/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
         "parent": "/api/configuration/telnet/pattern_sets"
       }
    }
    					
    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
    400 PatternSetValidationFailed The validation of the telnet pattern set file failed.
    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.
  3. Commit your changes.

    For more information, see Commit a transaction.

Note the following points:

  • Built-in telnet pattern sets cannot be deleted. The ID of built-in pattern sets begins with "-".

  • Existing pattern sets cannot be re-loaded, only if you delete them beforehand.

Operations with the /pattern_sets endpoint
  • /api/configuration/telnet/pattern_sets: GET

  • /api/configuratation/telnet/pattern_sets/<id>: GET, DELETE

  • /api/upload/pattern_set: POST

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
404 NotFound The requested object does not exist.
405 DeleteNotAllowedOnBuiltInPatternSet The deletion of built-in telnet pattern sets is not allowed.

VNC connections

Topics:

VNC connections

List of endpoints for configuring the policies, options and connection rules of VNC connections.

URL
GET https://<IP-address-of-SPS>/api/configuration/vnc
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 more information on authentication, see Authenticate to the SPS REST API.

NOTE: 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 available settings for configuring for VNC connections.

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

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

For more information on the meta object, see Message format.

{
  "items": [
    {
      "key": "channel_policies",
      "meta": {
        "href": "/api/configuration/vnc/channel_policies"
      }
    },
    {
      "key": "connections",
      "meta": {
        "href": "/api/configuration/vnc/connections"
      }
    },
    {
      "key": "options",
      "meta": {
        "href": "/api/configuration/vnc/options"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/aaa",
    "href": "/api/configuration/vnc",
    "last": "/api/configuration/x509",
    "next": "/api/configuration/x509",
    "parent": "/api/configuration",
    "previous": "/api/configuration/troubleshooting",
    "transaction": "/api/transaction"
  }
}
Item Description
channel_policies List of the default and custom channel policies.

connections

List of the VNC connection policies.

options List of global VNC options that affect all connections.
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.

VNC connection policies

Connection policies determine if a server can be accessed from a particular client. Connection policies reference other resources (policies, usergroups, keys) that must be configured and available before creating a connection policy.

Caution:

The connection policies of this protocol are available in READ-ONLY mode on the REST API. Also, the returned data is incomplete, it does not include any protocol-specific settings, only the parameters that are common to every supported protocol.

To modify the connection policies of this protocol, you must use the SPS web interface.

Using the REST API, you can modify the connection policies of the RDP and SSH protocols.

URL
GET https://<IP-address-of-SPS>/api/configuration/vnc/connections/
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 more information on authentication, see Authenticate to the SPS REST API.

NOTE: 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 VNC connection policies.

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

The following command retrieves the properties of a specific policy.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/vnc/connections/<connection-key>
관련 문서

The document was helpful.

평가 결과 선택

I easily found the information I needed.

평가 결과 선택