One Identity Safeguard for Privileged Sessions 7.5.1

List of options that affect all Telnet connections.

URL

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

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 global Telnet options.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/telnet/options

Response

The following is a sample response received when listing the default global Telnet options.

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

{
  "body": {
      "channel_database_cleanup": {
        "enabled": false
      },
      "service": {
        "enabled": false        
      }
    }
  }
  "key": "options",
  "meta": {
    "first": "/api/configuration/telnet/channel_policies",
    "href": "/api/configuration/telnet/options",
    "last": "/api/configuration/telnet/options",
    "next": null,
    "parent": "/api/configuration/telnet",
    "previous": "/api/configuration/telnet/channel_policies",
    "transaction": "/api/transaction"
  }
}

Element			Type
key		Top level item	Contains the ID of the endpoint.
body		Top level item	Contains the elements of the global Telnet options.
	channel_database_cleanup	Top level item	Contains settings for database cleanup.
	service	Top level item	Global setting to enable Telnet connections, and specify the logging detail.

Elements of channel_database_cleanup	Type	Description
days	integer	Applies only if enabled is set to true. Global retention time for the metadata of Telnet connections, in days. Must exceed the retention time of the archiving policy (or policies) used for Telnet connections, and the connection-specific database cleanup times (if configured).
enabled	boolean	To enable the global cleanup of Telnet connection metadata, set this element to true.

Elements of channel_database_cleanup

Type

Description

days

integer

Applies only if enabled is set to true.

Global retention time for the metadata of Telnet connections, in days. Must exceed the retention time of the archiving policy (or policies) used for Telnet connections, and the connection-specific database cleanup times (if configured).

enabled

boolean

To enable the global cleanup of Telnet connection metadata, set this element to true.

Elements of service	Type	Description
log_level	integer	Applies only if enabled is set to true. Defines the logging detail of Telnet connections.
enabled	boolean	Set to true to enable Telnet connections.

Elements of service

Type

Description

log_level

integer

Applies only if enabled is set to true.

Defines the logging detail of Telnet connections.

enabled

boolean

Set to true to enable Telnet connections.

Examples

Querying the full list of global Telnet options:

{
  "body": {
    "channel_database_cleanup": {
      "enabled": true,
      "days": 365
     },
    "service": {
      "enabled": true,
      "log_level": 4
    }
  }
  "key": "options",
  "meta": {
    "first": "/api/configuration/telnet/channel_policies",
    "href": "/api/configuration/telnet/options",
    "last": "/api/configuration/telnet/options",
    "next": null,
    "parent": "/api/configuration/telnet",
    "previous": "/api/configuration/telnet/channel_policies",
    "transaction": "/api/transaction"
  }
}

Modify global Telnet settings

To modify global Telnet settings, you have to:

Open a transaction

For more information, see Open a transaction.
Modify the JSON object of the global Telnet settings endpoint.

PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/telnet/options endpoint.

You can find a detailed description of the available parameters listed in Element.

For more information about the elements of the channel_database_cleanup item, see Elements of channel_database_cleanup.

For more information about the elements of the service item, see Elements of service.
Commit your changes

For more information, see Commit a transaction.

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
201	Created	The new resource was successfully created.
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 the SPS REST API attempted to access, but could not retrieve.
403	Unauthorized	The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that the SPS REST API attempted to access, but could not retrieve.
404	NotFound	The requested object does not exist.

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.txt 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:

Open a transaction.

For more information, see Open a transaction.

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.txt --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.

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.

Telnet settings policies

Telnet settings policies define protocol-level settings. You can create multiple policies and choose the appropriate one for each Telnet connection.

URL

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

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 Telnet settings policies.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/telnet/settings_policies

The following command retrieves the properties of a specific policy.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/telnet/settings_policies/<policy-id>

Response

The following is a sample response received when listing Telnet settings policies.

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

{

    "items": [

        {

            "body": {

                "banner": "",

                "client_tls_security_settings": {

                    "cipher_strength": {

                        "selection": "recommended"

                    },

                    "minimum_tls_version": "TLSv1_2"

                },

                "inactivity_timeout": {

                    "enabled": false

                },

                "name": "default",

                "preconnect_channel_check": false,

                "server_tls_security_settings": {

                    "cipher_strength": {

                        "selection": "recommended"

                    },

                    "minimum_tls_version": "TLSv1_2"

                },

                "timeout": 600

            },

            "key": "-302",

            "meta": {

                "href": "/api/configuration/telnet/settings_policies/-302"

            }

        }

    ],

    "meta": {

        "first": "/api/configuration/telnet/authentication_policies",

        "href": "/api/configuration/telnet/settings_policies",

        "last": "/api/configuration/telnet/settings_policies",

        "next": null,

        "parent": "/api/configuration/telnet",

        "previous": "/api/configuration/telnet/pattern_sets",

        "remaining_seconds": 600,

        "transaction": "/api/transaction"

    }

}

When retrieving the endpoint of a specific policy, the response is the following.

{

    "body": {

        "banner": "",

        "client_tls_security_settings": {

            "cipher_strength": {

                "selection": "recommended"

            },

            "minimum_tls_version": "TLSv1_2"

        },

        "inactivity_timeout": {

            "enabled": false

        },

        "name": "default",

        "preconnect_channel_check": false,

        "server_tls_security_settings": {

            "cipher_strength": {

                "selection": "recommended"

            },

            "minimum_tls_version": "TLSv1_2"

        },

        "timeout": 600

    },

    "key": "-302",

    "meta": {

        "first": "/api/configuration/telnet/settings_policies/-302",

        "href": "/api/configuration/telnet/settings_policies/-302",

        "last": "/api/configuration/telnet/settings_policies/-302",

        "next": null,

        "parent": "/api/configuration/telnet/settings_policies",

        "previous": null,

        "remaining_seconds": 600,

        "transaction": "/api/transaction"

    }

}

Element		Type	Description
key		string	Top level element, contains the ID of the policy.
body		Top level element (string)	The elements of the Telnet settings policy.
	client_tls_security_settings	JSON object	Configures TLS security settings on the client side.
	name	string	Name of the Telnet settings policy. Cannot contain whitespace.
	preconnect_channel_check	boolean
	server_tls_security_settings	JSON object	Configures TLS security settings on the server side.
	timeout	int	Idle timeout, in seconds. NOTE: The SPS web UI displays the same value in seconds.
	inactivity_timeout		Top level element
	enabled	boolean	true: If no user activity is detected, it stops the session after the configured time has passed since the last user activity. false: No user inactivity timeout.
	value	int	Only if enabled is true The value of user activity timeout. Must be greater than or equal to the value of timeout.
	banner	string	You can display a banner message to the clients.

Elements of client_tls_security_settings and server_tls_security_settings		Type	Description
cipher_strength		JSON object	Specifies the cipher string OpenSSL will use.
	custom_cipher	string	The list of ciphers you want to permit SPS to use in the connection. For more details on customizing this list, check the openssl-ciphers manual page on your SPS appliance.
	selection	string	Specifies the cipher string OpenSSL will use. The following options are available: recommended: this setting only uses ciphers with adequate security level. custom: this setting allows you to specify the list of ciphers you want to permit SPS to use in the connection. This setting is only recommended to ensure compatibility with older systems. For more details on customizing this list, check the 'openssl-ciphers' manual page on your SPS appliance. For example: ALL:!aNULL:@STRENGTH
minimum_tls_version		string	Specifies the minimal TLS version SPS will offer during negotiation. The following options are available: TLSv1_2: Offers TLS version 1.2 during negotiation. This is the recommended setting. TLSv1_1: Offers TLS version 1.1 and later during negotiation. TLSv1_0: Offers TLS version 1.0 and later during negotiation.

Add Telnet settings policies

To add a settings policy, you must:

Open a transaction

For more information, see Open a transaction.

Create the JSON object for the new policy

POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/telnet/settings_policies/ endpoint. You can find a detailed description of the available parameters listed in Element.

If the POST request is successful, the response includes the key of the new policy. For example:

{

  "key": "3848c708-2e1d-4463-b232-0c8c5875ff55",

  "meta": {

    "href": "/api/configuration/telnet/settings_policies/3848c708-2e1d-4463-b232-0c8c5875ff55",

    "parent": "/api/configuration/telnet/settings_policies",

    "transaction": "/api/transaction"

  }

}

Commit your changes

For more information, see Commit a transaction.

Modify Telnet settings policies

To modify a settings policy, you must:

Open a transaction

For more information, see Open a transaction.
Modify the JSON object of the policy

PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/telnet/settings_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in Element.
Commit your changes

For more information, see Commit a transaction.

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
201	Created	The new resource was successfully created.
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.

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

Global Telnet options

URL

Cookies

Sample request

Response

Examples

Modify global Telnet settings

Open a transaction

Modify the JSON object of the global Telnet settings endpoint.

Commit your changes

Status and error codes

Telnet pattern sets

URL

Cookies

Sample request

Response

Status and error codes

Operations with the /pattern_sets endpoint

Status and error codes

Telnet settings policies

URL

Cookies

Sample request

Response

Add Telnet settings policies

Open a transaction

Create the JSON object for the new policy

Commit your changes

Modify Telnet settings policies

Open a transaction

Modify the JSON object of the policy

Commit your changes

Status and error codes

VNC connections

Detailed information about this topic

製品を選択してください:

サービス向上のために、「Purpose of your Chat（チャットの目的）」を記入してください。

お客様の不具合に推奨されるソリューション

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

Global Telnet options

URL

Cookies

Sample request

Response

Examples

Modify global Telnet settings

Open a transaction

Modify the JSON object of the global Telnet settings endpoint.

Commit your changes

Status and error codes

Telnet pattern sets

URL

Cookies

Sample request

Response

Status and error codes

Operations with the /pattern_sets endpoint

Status and error codes

Telnet settings policies

URL

Cookies

Sample request

Response

Add Telnet settings policies

Open a transaction

Create the JSON object for the new policy

Commit your changes

Modify Telnet settings policies

Open a transaction

Modify the JSON object of the policy

Commit your changes

Status and error codes

VNC connections

Detailed information about this topic