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

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

Telnet channels

The available Telnet channel types and their functionalities are described below.

Channel Special options Description
telnet Yes

telnet: Enables access to the server's terminal. This channel must be enabled for Telnet to work.

Channel-specific actions:

  • content_policy reference: The ID of the Content policy to apply to the connection.

For example:

"actions": {
  "audit": true,
  "four_eyes": true,
  "content_policy": {
    "key": "433849548566ab327522e6"
    "meta": {
      "href": "/api/configuration/policies/content_policies/44287216854f482e7f2b24"
    }
  },
}

Telnet authentication policies

Lists the configured authentication methods that can be used in a connection. Each connection policy uses an authentication policy to determine how the client can authenticate on the SPS gateway.

URL
GET https://<IP-address-of-SPS>/api/configuration/telnet/authentication_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 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 Telnet authentication policies.

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

The following command retrieves the properties of a specific policy.

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

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

For details of the meta object, see Message format.

{
  "items": [
    {
      "key": "-200",
      "meta": {
        "href": "/api/configuration/telnet/authentication_policies/-200"
      }
    },
    {
      "key": "-304002001",
      "meta":  { 
        "href": "/api/configuration/telnet/authentication_policies/-304002001" }

      }
    }
  ],
  "meta": {
    "first": "/api/configuration/telnet/authentication_policies",
    "href": "/api/configuration/telnet/authentication_policies",
    "last": "/api/configuration/telnet/settings_policies",
    "next": "/api/configuration/telnet/channel_policies",
    "parent": "/api/configuration/telnet",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

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

{
    "body": {
        "active_pattern_sets": [],
        "backend": {
        "selection": "ldap"
        },
        "name": "telnet_auth_policy_with_ldap"
}
Element Type Description
key string Top level element, contains the ID of the policy.
body Top level element Contains the elements of the policy.
name string The name of the object. This name is also displayed on the SPS web interface. It cannot contain whitespace.
active_pattern_sets JSON list

The list of patterns to use to extract the username from the sessions. For details, see "Extracting username from Telnet connections" in the Administration Guide. For example:

"active_pattern_sets": ["-8000","-8001","-8002"]
backend Top level item Client-side gateway authentication settings. The value of selection defines which authentication method is used.
selection string

Defines the authentication method for client-side gateway authentication. Possible values are:

  • none

    Disables client-side gateway authentication.

  • ldap

    Uses the LDAP server selected for the connection policy. LDAP servers can be configured in the /api/configuration/policies/ldap_servers endpoint).

  • local

    Uses the local user database configured in the /api/configuration/policies/user_databases/ endpoint.

    To use this option, you must also configure the user_database element.

  • radius

    Uses one or more Radius servers for authentication.

    To use this option, you must also configure the authentication_protocol and servers elements.
Elements of servers Type Description
address Top level element Defines the address of a RADIUS server.
selection string

Required child of the address element. Possible values are:

  • ip

    The value element contains the IP of the RADIUS server.

  • fqdn

    The value element contains the FQDN of the RADIUS server.

value string The IP or the FQDN address of the RADIUS server.
port int The port number of the RADIUS server.
shared_secret string

References the key of the shared secret for the RADIUS server. You can configure shared secrets at the /api/configuration/passwords/ endpoint.

To modify or add a shared secret, use the value of the returned key as the value of the shared_secret element, and remove any child elements (including the key).

Alternatively, you can include the new password as plain text.

"shared_secret": {
    "plain": "<new-password>"
}
Examples:

Querying base authentication policy without gateway authentication:

{
  "key": "-304002001",
  "body": {
    "name": "base",
    "backend": {
      "selection": "none"
    }
  }
}

Querying authentication policy with LDAP backend:

{
  "key": "telnet-auth-pol-2",
  "body": {
    "name": "telnet_ldap",
    "backend": {
      "selection": "ldap",
      "timeout": 3600,
      "keepalive": true
    }
  }
}

Querying authentication policy with local backend:

{
  "key": "telnet-auth-pol-3",
  "body": {
    "name": "telnet_local",
    "backend": {
      "selection": "local",
      "user_database": {
        "key": "local-user-database-1",
        "meta": { "href": "/api/configuration/policies/user_databases/local-user-database-1" }
      },
      "timeout": 3600,
      "keepalive": true
    }
  }
}

Querying authentication policy with RADIUS backend:

{
  "key": "telnet-auth-pol-4",
  "body": {
    "name": "telnet_radius",
    "backend": {
      "selection": "radius",
      "servers": [
        {
          "address": {
            "selection": "ip",
            "value": "1.2.3.4"
          },
          "port": 1812,
          "shared_secret": {
            "key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "meta": { "href": "/api/configuration/passwords#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" }
          }
        }
      ],
      "authentication_protocol": "pap",
      "timeout": 3600,
      "keepalive": true
    }
  }
}
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.
400 InvalidQuery The requested filter or its value is invalid.
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.
Add a Telnet authentication policy

To add a Telnet authentication policy, you have to:

  1. Open a transaction.

    For details, see Open a transaction.

  2. Create the JSON object for the new policy.

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

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

    {
  "key": "6f924f39-e4c9-4b0f-8018-8842e2115ebd",
  "meta": {
    "href": "/api/configuration/telnet/authentication_policies/6f924f39-e4c9-4b0f-8018-8842e2115ebd",
    "parent": "/api/configuration/telnet/authentication_policies",
    "transaction": "/api/transaction"
  }
}
  3. Commit your changes.

    For details, see Commit a transaction.

Modify a Telnet authentication policy

To modify a Telnet authentication policy, you have to:

  1. Open a transaction.

    For details, see Open a transaction.

  2. Modify the JSON object of the policy.

    PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/telnet/authentication_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in Telnet authentication policies.

  3. Commit your changes.

    For details, see Commit a transaction.

Global Telnet options

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

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

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

For details of the meta object, see Message format.

{
  "body": {
    "audit": {
      "cleanup": {
        "enabled": false
      },
      "timestamping": {
        "selection": "local",
        "signing_interval": 30
      }
    },
    "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"
  }
}
Element Type Description
key Top level item Contains the ID of the endpoint.
body Top level item Contains the elements of the global Telnet options.
audit Top level item Contains settings for timestamping and cleanup.
service Top level item Global setting to enable Telnet connections, and specify the logging detail.
enabled boolean Set to true to enable Telnet connections.
log_level int Defines the logging detail of Telnet connections.
Elements of audit Type Description
cleanup Top level item Global retention settings for Telnet connection metadata. To configure retention time for a specific connection policy, use the archive_cleanup_policy element at the endpoint of the policy instead.
channel_database_cleanup_days int 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.
timestamping Top level item Global timestamping settings for Telnet connections.
selection string

Configures local or remote timestamping.

  • Set local to use SPS for timestamping.

  • Set remote to configure a remote timestamping server.

server_url string

Required for remote timestamping.

The URL of the timestamping server. Note that HTTPS and password-protected connections are not supported.

oid Top level item The Object Identifier of the policy used for timestamping.
enabled boolean

Required for remote timestamping.

Set to true to configure the Object Identifier of the timestamping policy on the timestamping remote server.

policy_oid string

Required if the oid is enabled.

The Object Identifier of the timestamping policy on the remote timestamping server.

signing_interval int Time interval for timestamping open connections, in seconds.
Examples:

Set SPS as the timestamping server:

{
  "audit": {
    "cleanup": {
      "enabled": false
    },
    "timestamping": {
      "selection": "local",
      "signing_interval": 30
    }
  },
  "service": {
    "enabled": true,
    "log_level": 4
  }
}

Enable cleanup, and set it to occur every 10 days:

{
  "audit": {
    "cleanup": {
      "channel_database_cleanup_days": 10,
      "enabled": true
    },
    "timestamping": {
      "selection": "local",
      "signing_interval": 30
    }
  },
  "service": {
    "enabled": true,
    "log_level": 4
  }
}

Change timestamping to a remote server, without specifying a timestamping policy:

{
  "audit": {
    "cleanup": {
      "channel_database_cleanup_days": 10,
      "enabled": true
    },
    "timestamping": {
        "oid": {
          "enabled": false
        },
        "selection": "remote",
        "server_url": "<url-of-timestamping-server>",
        "signing_interval": 30
      }
  },
  "service": {
    "enabled": true,
    "log_level": 4
  }
}

Change timestamping to a remote server, and specify the 1.2.3 timestamping policy:

{
  "audit": {
    "cleanup": {
      "channel_database_cleanup_days": 10,
      "enabled": true
    },
    "timestamping": {
        "oid": {
          "enabled": true,
          "policy_oid": "1.2.3"
        },
        "selection": "remote",
        "server_url": "<url-of-timestamping-server>",
        "signing_interval": 30
      }
  },
  "service": {
    "enabled": true,
    "log_level": 4
  }
}
Modify global Telnet settings

To modify global Telnet settings, you have to:

  1. Open a transaction.

    For details, see Open a transaction.

  2. 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 . The elements of the audit item are described in Elements of audit.

  3. Commit your changes.

    For details, 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.

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 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 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 details of the meta object, see Message format.

{
  "items": [
    {
      "body": { "name": "Cisco devices" },
      "key": "-8000",
      "meta": { "href": "/api/configuration/telnet/pattern_sets/-8000" }
    },
    {
      "body": { "name": "Cisco devices without authentication" },
      "key": "-8001",
      "meta": { "href": "/api/configuration/telnet/pattern_sets/-8001" }
    },
    {
      "body": { "name": "General Telnet" },
      "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.

NOTE: The pattern set files (the available pattern sets) can only be uploaded through the Web UI. REST API only provides read-only access.

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.
관련 문서

The document was helpful.

평가 결과 선택

I easily found the information I needed.

평가 결과 선택