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

Collection of access policies. Access policies define who can authorize and audit a connection.

Retention time, in days. Must not exceed the retention time of the archive_cleanup_policy, and the retention time configured in the global settings of the protocol.

The global settings of the SSH protocol are available at the api/configuration/ssh/options endpoint.

References the identifier of the indexing policy. You can configure indexing policies at the /api/configuration/policies/indexing/ endpoint.

To modify or add an indexing policy, use the value of the returned key as the value of the policy element, and remove any child elements (including the key).

Specifies the indexing priority for the connection. Possible values are:

• 5

  Very low priority.

• 4

  Low priority.

• 3

  Normal (default) priority.

• 2

  High priority.

• 1

  Very high priority.

• 0

  Near real-time priority.

Set to true to log audit trail downloads.

Specifies the verbosity level of sessions handled by this connection policy. The log level of other connection policies is not affected. If disabled, the log level set at the /api/configuration/<protocol>/options endpoint is used.

• To use the default log level, disable this option:

  "override_log_level": {
      "enabled": false
  },

• To use a custom log level for the connection policy, enable this option and set the log level to use:

  "override_log_level": {
      "enabled": true,
      "log_level": 5
  },

References the identifier of the AA plug-in. You can configure AA plug-ins at the /api/configuration/plugins/aa/ endpoint.

To modify or add an AA plug-in, use the value of the returned key as the value of the aa_plugin element, and remove any child elements (including the key).

References the identifier of the analytics policy. You can configure analytics policies at the /api/configuration/analytics/ endpoint.

To add or modify an analytics policy, use the value of the returned key as the value of the analytics element, and remove any child elements (including the key).

References the identifier of the archive/cleanup policy. You can configure archive and cleanup policies at the /api/configuration/policies/archive_cleanup_policies/ endpoint.

To modify or add an archive/cleanup policy, use the value of the returned key as the value of the archive_cleanup_policy element, and remove any child elements (including the key).

Cannot be null.

References the identifier of the audit policy. You can configure audit policies at the /api/configuration/policies/audit_policies/ endpoint.

To modify or add an audit policy, use the value of the returned key as the value of the audit_policy element, and remove any child elements (including the key).

Cannot be null.

References the identifier of the authentication policy. You can configure authentication policies at the /api/configuration/ssh/authentication_policies/ endpoint.

To modify or add an authentication policy, use the value of the returned key as the value of the authentication_policy element, and remove any child elements (including the key).

References the identifier of the backup policy. You can configure backup policies at the /api/configuration/policies/backup_policies/ endpoint.

To modify or add a backup policy, use the value of the returned key as the value of the backup_policy element, and remove any child elements (including the key).

References the identifier of the channel policy. The value of this option cannot be null.

To modify or add a channel policy, use the value of the returned key as the value of the channel_policy element, and remove any child elements (including the key).

You can configure SSH channel policies at the /api/configuration/ssh/channel_policies/ endpoint.

References the identifier of the credential store.

You can configure credential stores at the /api/configuration/policies/credentialstores/ endpoint.

To modify or add a credential store, use the value of the returned key as the value of the credential_store element, and remove any child elements (including the key).

References the identifier of the LDAP server. You can configure LDAP servers at the /api/configuration/policies/ldap_servers/ endpoint.

To modify or add an LDAP server, use the value of the returned key as the value of the ldap_server element, and remove any child elements (including the key).

References the identifier of the settings policy. The value of this option cannot be null.

To modify or add a settings policy for this protocol, use the value of the returned key as the value of the settings element, and remove any child elements (including the key).

You can configure SSH settings policies at the /api/configuration/ssh/settings_policies/ endpoint.

References the identifier of a Usermapping Policy. You can configure Usermapping Policies at the /api/configuration/policies/usermapping_policies/ endpoint.

To modify or add a Usermapping Policy, use the value of the returned key as the value of the usermapping_policies element, and remove any child elements (including the key).

Settings for verifying the server's identity using plain host keys and X.509 host certificates.

At least one of the options (plain_hostkey or X509_hostkey) must be enabled.

Configures Source Network Address Translation. Possible values are:

• box_address

  Default. Uses the network address of the logical interface of SPS.

• original

  Uses the IP address of the client, as seen by SPS.

• fix

  Uses a fixed address when connecting to the remote server.

  Must be used with the address element.

Must be used if the value of the selection element is set to fix.

The IP address to use as the source address in server-side connections.

By default, any user can perform gateway authentication for the connections. You can restrict authentication to members of specific usergroups. Define the usergroups at the /api/configuration/aaa/local_database/groups/ endpoint, and list the name of each group here.

The usergroup (local or LDAP) who can authorize or audit the connection.

Local usergroups can be added or modified at the /api/configuration/aaa/local_database/groups/ endpoint.

Defines the permissions of the authorizer usergroup. Possible values are:

• audit

  The usergroup with the audit permission can monitor ongoing connections, and download the audit trails of a closed and indexed connection.

• authorize

  The usergroup with the authorize permission can authorize connection requests.

• audit_and_authorize

  The usergroup with the audit_and_authorize permission can authorize connection requests, monitor connections, and download the audit trail of closed and indexed connections.

The usergroup (local or LDAP) that is subject to the access control policy.

Local usergroups can be added or modified at the /api/configuration/aaa/local_database/groups/ endpoint.

Configures the RSA key SPS shows to the clients.

References the identifier of the RSA key. You can add RSA keys at the /api/configuration/private_keys/ endpoint.

To modify or add an RSA key, use the value of the returned key as the value of the rsa_key element, and remove any child elements (including the key).

Set to true to allow presenting X.509 host keys to clients.

You must enable either plain_hostkey or x509_hostkey (or both).

Possible values:

• fix

  Presents the same certificate for every connection.

  Must be used with the x509_identity element.

• generate

  Generates a X.509 certificate for the connection policy.

  Must be used with the signing_CA element.

Must be used when generating the X.509 certificate.

References the signing Certificate Authority (CA). You can configure signing CAs at the /api/configuration/policies/signing_cas/ endpoint.

To modify or add a signing CA, use the value of the returned key as the value of the rsa_key element, and remove any child elements (including the key).

Configures a DNS server that is used to reverse-resolve the hostname if the Channel Policy contains the address of the target as a hostname instead of an IP address. By default, this is disabled and SPS uses the DNS server set in the /api/configuration/network/dns endpoint.

• To use the default DNS, disable this option:

  "server_address": {
      "custom_dns": {
          "enabled": false
      },
      ...
  },

• To use a custom DNS, enable this option and set the IP address of the domain name server to use:

  "server_address": {
      "custom_dns": {
          "enabled": true,
          "server": "192.168.1.1"
      },
      ...
  },

Configures the address where the clients connect to. Possible values are:

• original

  Connect to the same address specified by the client.

• nat

  Perform a network address translation on the target address.

  Must be used with the network element.

• fix

  Must be used with the address and port elements.

• inband

  Extract the address of the server from the username.

  Must be used with the domains element.

  Optional elements: exception_domains, dns_server, and dns_suffixes.

Must be used if selection is set to nat.

The target address in IP/prefix format. Example: "10.20.30.40/24".

Must be used if selection is set to fix.

The IP address of the target server.

Must be used if selection is set to fix.

The port of the target server.

Must be used if selection is set to inband.

Specifies if the target address range is provided as a domain or as an IP range. Possible values are:

• address

  The value of the target address is an IP range.

• domain

  The value of the target address is a domain.

The address range of the target server(s).

Use the selection element to specify if the address is an IP range, or a domain.

Can only be used if selection is set to inband.

Lists the address ranges that are excluded from the connection policy.

Specifies if the excluded address(es) are provided as a domain or as an IP range. Possible values are:

• address

  The value of the excluded address is an IP range.

• domain

  The value of the excluded address is a domain.

The excluded address(es).

Use the selection element to specify if the address is an IP range, or a domain.

Can only be used if selection is set to inband.

IP address or the hostname of the domain name server used to resolve the address of the target server.

Set to true to enable plain host key checking.

If enabled, the hostkey_check element is mandatory.

Defines the method for checking the host keys of the target server. Possible values are:

• disabled

  Disables host key verification.

• accept-first-time

  Records the key shown for the first connection, and accepts only the same key for any subsequent connections.

• accept-known-keys

  Only accepts host keys that are already stored on SPS.

  You can manage host keys at the /api/ssh-host-keys endpoint.

Set to true to enable X.509 host key verification.

If enabled, the x509_check element is mandatory.

Configures the validation of X.509 certificates. Possible values are:

• disabled

  Disables X.509 certificate verification.

• accept-first-time

  Records the X.509 certificate shown for the first connection, and accepts only the same certificate for any subsequent connections.

• accept-known-certificates

  Only accepts X.509 certificates that are already stored on SPS.

  You can add X.509 certificates at the /api/ssh-host-keys endpoint.

• accept-signed-by

  Accepts all X.509 certificates that are signed by a trusted Certificate Authority.

  Must be used with the trusted_ca element.

Agent: Forwards the SSH authentication agent from the client to the server.

X11 Forward: Forwards the graphical X-server session from the server to the client. List the address of the client in the networks field to permit X11-forwarding only to the specified clients. Specify IP addresses or networks (in IP address/Prefix format). For example:

"networks": [
  {
    "selection": "address",
    "value": "192.168.1.1"
  },
  {
    "selection": "address",
    "value": "192.168.1.2"
  }
                        
NOTE: Certain client applications send the Target address as a hostname, while others as an IP address. If you are using a mix of different client applications, you might have to duplicate the channel rules and create IP-address and hostname versions of the same rule.
Channel-specific access control rules:
networks (list): To X11-forwarding only to specific clients, list the IP addresses or networks of the clients in this field. Leave it empty to permit access to every client. For details, see Limiting addresses in port forwarding.

Local Forward: Forwards traffic arriving to a local port of the client to a remote host. To enable forwarding only between selected hosts, use the local_forwards field. If the local_forwards field is empty, local forwarding is enabled without restriction, the client may forward any traffic to the remote host.

For example:

"local_forwards": [
  {
    "host_address": {
      "selection": "address",
      "value": "192.168.100.1"
    },
    "host_port": 5555,
    "originator_address": {
      "selection": "address",
      "value": "192.168.1.1"
    }
  }
                        
Channel-specific access control rules:
local_forwards (list): To permit local forwarding only to specific addresses, list the addresses in this field. Leave it empty to enable without restriction. In this case the client may forward any traffic to the remote host.
Enter the source of the forwarded traffic into the originator_address field, the target of the traffic into the host_address field. Specify IP addresses or networks (in IP address/Prefix format). These parameters are the end-points of the forwarded traffic (that is, the local host that sends data to the remote host), and not the SSH server or the client. For example, to enable forwarding from the 192.168.20.20 host to the remote host 192.168.50.50, enter 192.168.20.20 into the originator_address, and 192.168.50.50 into the host_address field. For details, see Limiting addresses in port forwarding.

Remote Forward: Forwards traffic arriving a remote port of the server to the client. To enable forwarding only between selected hosts, enter their IP addresses into the remote_forwards field. If the remote_forwards field is empty, remote forwarding is enabled without restriction, the SSH server may forward any traffic to the client.

For example:

"remote_forwards": [
  {
    "connected_address": {
      "selection": "address",
      "value": "192.168.100.1"
    },
    "connected_port": 5555,
    "originator_address": {
      "selection": "address",
      "value": "192.168.1.1"
    }
  }
                        
Channel-specific access control rules:
remote_forwards (list): To permit only specific forwardins, list the permitted addresses in this field. Leave it empty to permit forwarding without restrictions.
Enter the source of the forwarded traffic into the originator_address, the target of the traffic into the connected_address field. Specify IP addresses or networks (in IP address/Prefix format). These parameters are the end-points of the forwarded traffic (that is, the remote host that sends data to the client), and not the SSH server. For example, to enable forwarding from the 192.168.20.20 remote host to the client 192.168.50.50, enter 192.168.20.20 into the originator_address, and 192.168.50.50 into the connected_address field. For details, see Limiting addresses in port forwarding.

Session Exec: Execute a remote command (for example rsync) without opening a session shell. List the permitted command in the execs field. You can use regular expressions to specify the commands. This field can contain only letters (a-z, A-Z), numbers (0-9), and the following special characters ({}()*?\\|[]).

Channel-specific access control rules:

• execs (list): List the permitted command in the execs field. Regular expressions may be used to specify the commands.

For example:

"execs": [
  "top",
  "ls"
                    

Session Exec SCP: Transfers files using the Secure Copy (SCP) protocol.

Channel-specific actions:

• log_transfer_to_db (list): (true|false): Make the list of file operations available in the Search > File operations column of the SPS web interface

• log_transfer_to_syslog (list): (true|false): Send the file operations into the system log

For example:

"actions": {
  "audit": false,
  "four_eyes": false,
  "ids": false,
  "log_transfer_to_db": true,
  "log_transfer_to_syslog": true
}

Session Subsystem: Use a subsystem. Enter the name of the permitted subsystem into the subsystems field.

Channel-specific access control rules:

• subsystems (list): List the permitted subsystems in this field.

For example:

"execs": [
  "top",
  "ls"
                    

Session SFTP: Transfers files using the Secure File Transfer Protocol (SFTP).

Channel-specific actions:

• log_transfer_to_db (list): (true|false): Make the list of file operations available in the Search > File operations column of the SPS web interface

• log_transfer_to_syslog (list): (true|false): Send the file operations into the system log

For example:

"actions": {
  "audit": false,
  "four_eyes": false,
  "ids": false,
  "log_transfer_to_db": true,
  "log_transfer_to_syslog": true
}

Specifies the type of the address. Possible values: address or network

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 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 password, public_key, and user_database elements.

• radius

  Uses one or more Radius servers for authentication.

  To use this option, you must also configure the authentication_protocol and servers elements.

Set it to true to enable public key-based client-side authentication.

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

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.

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.

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

Authentication based using Kerberos.

Set it to true to enable Kerberos-based client-side authentication. If required, you can select other gateway authentication methods in addition to Kerberos, and also authentication backends and related to the selected gateway authentication methods.

To use Kerberos authentication on the target server, you must use Kerberos authentication both on the SPS gateway and on the target server (in relayed_methods).

Authentication based on username and password.

Set it to true to enable password-based client-side authentication.

Authentication based using Kerberos.

Set it to true to enable Kerberos-based client-side authentication. If required, you can select other gateway authentication methods in addition to Kerberos, and also authentication backends and related to the selected gateway authentication methods.

To use Kerberos authentication on the target server, you must use Kerberos authentication both on the SPS gateway and on the target server (in relayed_methods).

Authentication based on exchanging messages between the user and the server. This method includes authentication schemes like S/Key or TIS authentication. Depending on the configuration of the SSH server, might have to be used together with password-based authentication.

Set to true to enable interactive authentication on the remote server.

Authentication based on username and password.

Set to true to enable password-based authentication on the remote server.

Authentication based on public-private encryption keypairs.

Use the selection child element to disable or configure authentication using public-private keypairs on the remote server.

Configures authenticaton on the remote server using public-private keypairs. The following values are possible:

• disabled

  Disables the authentication method.

• publish_to_ldap

  SPS generates a keypair, and uses this keypair in the server-side connection. The public key of this keypair is also uploaded to the LDAP database set in the LDAP Server of the connection policy. That way the server can authenticate the client to the generated public key stored under the user's username in the LDAP database. You can configure LDAP servers using the /api/configuration/policies/ldap_servers endpoint, and connection policies using the /api/configuration/ssh/connections endpoint.

• fix

  Uses a private key in the server-side connection.

  You have to use the private_key element to reference the private key.

• agent

  Allow the client to use agent-forwarding, and use its own keypair on the server-side.

  If this option is used, SPS requests the client to use its SSH agent to authenticate on the target server. Therefore, you must configure your clients to enable agent forwarding, otherwise authentication will fail. For details on enabling agent forwarding in your SSH application, see the documentation of the application.

Configures local or remote timestamping.

• Set local to use SPS for timestamping.

• Set remote to configure a remote timestamping server.

Required for remote timestamping.

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

Required for remote timestamping.

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

Required if the oid is enabled.

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