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

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

Defines the Transport Layer Security (TLS) settings for the connection between SPS and the client. For example:

"client_side_transport_security": {
    "selection": "disabled"
},

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 Telnet protocol are available at the api/configuration/telnet/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. Note that currently you cannot create or modify Telnet Authentication Policies using the REST API. Use the web UI instead.

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 Telnet channel policies at the /api/configuration/telnet/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).

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

Defines the Transport Layer Security (TLS) settings for the connection between SPS and the server. For example:

"server_side_transport_security": {
    "selection": "disabled"
},

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.

Sets how SPS authenticates the peers. To permit connections from peers without requesting a certificate, set "enabled": false, for example:

"peer_certificate_check": {
    "enabled": false
}

To validate the certificate of the peer, set "enabled": true, and reference a trusted certificate authority list, for example:

"peer_certificate_check": {
    "enabled": true,
    "trusted_ca": "cfc815e5-dadb-4eb9-a628-12ae0c12d358"
}

Sets the encryption settings used between SPS and the client. When the connection is encrypted, SPS has to show a certificate to the client, so you must configure the sps_certificate option as well. The possible values of selection are:

• starttls

  Enable encrypted connections that use the STARTTLS method. Note that the peer must use the STARTTLS method. Unencrypted connections will be terminated after a brief period.

• tls

  Require encryption.

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.

Sets how SPS authenticates the peers. To permit connections from peers without requesting a certificate, set "enabled": false, for example:

"peer_certificate_check": {
    "enabled": false
}

To validate the certificate of the peer, set "enabled": true, and reference a trusted certificate authority list, for example:

"peer_certificate_check": {
    "enabled": true,
    "trusted_ca": "cfc815e5-dadb-4eb9-a628-12ae0c12d358"
}

Sets the encryption settings used between SPS and the server. If SPS has to show a certificate to the peer, so you must configure the sps_certificate option as well. The possible values of selection are:

• none

  Do not use encryption.

• starttls

  Enable encrypted connections that use the STARTTLS method. Note that the peer must use the STARTTLS method. Unencrypted connections will be terminated after a brief period.

• tls

  Require encryption.