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

One Identity Safeguard for Privileged Sessions 7.5.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 REST API examples

MSSQL channels

The available MSSQL channel types and their functionalities are described below. For details on configuring channel policies, see Channel policy.

Channel Special options Description
mssql Yes

mssql: Enables access to the MSSQL server. This channel must be enabled for MSSQL 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"
    }
  },
}

MSSQL 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/mssql/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 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 MSSQL authentication policies.

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

The following command retrieves the properties of a specific policy.

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

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

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

{
  "items": [
    {
      "key": "-200",
      "meta": {
        "href": "/api/configuration/mssql/authentication_policies/-200"
      }
    },
    {
      "key": "-304002001",
      "meta":  { 
        "href": "/api/configuration/mssql/authentication_policies/-304002001"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/mssql/authentication_policies",
    "href": "/api/configuration/mssql/authentication_policies",
    "last": "/api/configuration/mssql/settings_policies",
    "next": "/api/configuration/mssql/channel_policies",
    "parent": "/api/configuration/mssql",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

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

{
  "body": {
    "backend": {
      "selection": "ldap"
    },
    "name": "mssql_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.
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).

    To use this option, you must also configure the certificate, password, and public_key elements.

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

servers Top level list

Only if selection is set to radius

Defines the properties of the RADIUS servers used for client-side authentication.

A valid list item consists of the address, port and shared_secret elements.

authentication_protocol Top level item

Only if selection is set to radius

RADIUS setting. Set to pap to use the Password Authentication Protocol. To use the Challenge-Handshake Authentication Protocol, set it to chap.

user_database string

Only if selection is set to local

References the key of the local user database. You can configure local user databases at the /api/configuration/policies/user_databases/ endpoint.

To modify or add a local user database, use the value of the returned key as the value of the user_database element, and remove any child elements (including the key).

timeout integer (seconds) Specify the time remaining until a successful gateway authentication times out.
keepalive boolean Set to true to avoid interruptions for active HTTP sessions. Active HTTP sessions can extend the gateway authentication beyond the configured timeout.
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": "mssql-auth-pol-2",
  "body": {
    "name": "mssql_ldap",
    "backend": {
      "selection": "ldap",
      "timeout": 3600,
      "keepalive": true
    }
  }
}

Querying authentication policy with local backend:

{
  "key": "mssql-auth-pol-3",
  "body": {
    "name": "mssql_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": "mssql-auth-pol-4",
  "body": {
    "name": "mssql_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 MSSQL authentication policy

To add a MSSQL authentication policy, you have to:

  1. Open a transaction

    For more information, 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/mssql/authentication_policies/ endpoint. You can find a detailed description of the available parameters listed in MSSQL 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/mssql/authentication_policies/6f924f39-e4c9-4b0f-8018-8842e2115ebd",
        "parent": "/api/configuration/mssql/authentication_policies",
        "transaction": "/api/transaction"
      }
    }
  3. Commit your changes

    For more information, see Commit a transaction.

Modify a MSSQL authentication policy

To modify a MSSQL authentication policy, you have to:

  1. Open a transaction

    For more information, 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/mssql/authentication_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in MSSQL authentication policies.

  3. Commit your changes

    For more information, see Commit a transaction.

Global MSSQL options

List of options that affect all MSSQL connections.

URL
GET https://<IP-address-of-SPS>/api/configuration/mssql/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 MSSQL options.

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

The following is a sample response received when listing global MSSQL 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/mssql/channel_policies",
    "href": "/api/configuration/mssql/options",
    "last": "/api/configuration/mssql/options",
    "next": null,
    "parent": "/api/configuration/mssql",
    "previous": "/api/configuration/mssql/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 MSSQL options.
  channel_database_cleanup Top level item Contains settings for database cleanup.
  service Top level item Global setting to enable MSSQL 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 MSSQL connections, in days. Must exceed the retention time of the archiving policy (or policies) used for MSSQL connections, and the connection-specific database cleanup times (if configured).

enabled

boolean

To enable the global cleanup of MSSQL connection metadata, set enabled to true.

Elements of service Type Description
log_level integer

Applies only if enabled is set to true.

Defines the logging detail of MSSQL connections.

enabled

boolean

To enable MSSQL connections, set to true.

Examples

Querying the full list of global MSSQL options:

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

To modify global MSSQL settings,

  1. Open a transaction

    For more information, see Open a transaction.

  2. Modify the JSON object of the global MSSQL settings endpoint.

    PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/mssql/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.

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

MSSQL settings policies

MSSQL settings policies define protocol-level settings for idle and session timeout. You can create multiple policies, and choose the appropriate one for each MSSQL connection.

URL
GET https://<IP-address-of-SPS>/api/configuration/mssql/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 MSSQL settings policies.

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

The following command retrieves the properties of a specific policy.

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

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

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

{
  "items": [
    {
      "key": "-3040010",
      "meta": {
        "href": "/api/configuration/mssql/settings_policies/-3040010"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/mssql/channel_policies",
    "href": "/api/configuration/mssql/settings_policies",
    "last": "/api/configuration/mssql/settings_policies",
    "next": null,
    "parent": "/api/configuration/mssql",
    "previous": "/api/configuration/mssql/options",
    "transaction": "/api/transaction"
  }
}

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

{
  "body": {
    "client_tls_security_settings": {
        "cipher_strength": {
            "selection": "recommended"
        },
        "minimum_tls_version": "TLSv1_2"
    },
    "name": "default",
    "server_tls_security_settings": {
        "cipher_strength": {
            "selection": "recommended"
        },
        "minimum_tls_version": "TLSv1_2"
    },
    "preconnect_channel_check": false,
    "session_timeout": 900,
    "timeout": 300
  },
  "key": "-3040010",
  "meta": {
    "first": "/api/configuration/mssql/settings_policies/-3040010",
    "href": "/api/configuration/mssql/settings_policies/-3040010",
    "last": "/api/configuration/mssql/settings_policies/-3040010",
    "next": null,
    "parent": "/api/configuration/mssql/settings_policies",
    "previous": null,
    "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 MSSQL settings policy.
client_tls_security_settings JSON object Configures TLS security settings on the client side.
name string Name of the MSSQL settings policy. Cannot contain whitespace.
server_tls_security_settings JSON object Configures TLS security settings on the server side.
timeout int Idle timeout, in seconds. Note that the SPS web UI displays the same value in seconds.
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 settings options are possible:

  • 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 settings options are possible:

  • TLSv1_2: this setting only offers TLS version 1.2 during the negotiation. This is the recommended setting.

  • TLSv1_1: this setting offers TLS version 1.1 and later versions during the negotiation.

  • TLSv1_0: this setting offers TLS version 1.0 and later versions during the negotiation.

Add MSSQL settings policies

To add a settings policy, you have to:

  1. Open a transaction

    For more information, 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/mssql/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/mssql/settings_policies/3848c708-2e1d-4463-b232-0c8c5875ff55",
        "parent": "/api/configuration/mssql/settings_policies",
        "transaction": "/api/transaction"
      }
    }
  3. Commit your changes

    For more information, see Commit a transaction.

Modify MSSQL settings policies

To modify a settings policy, you have to:

  1. Open a transaction

    For more information, 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/mssql/settings_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in Element .

  3. 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.
相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级