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

URL

GET https://<IP-address-of-SPS>/api/configuration/telnet/pattern_sets

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"
  }
}

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.