One Identity Safeguard for Privileged Sessions 7.1.1

The channel policy lists the channels (for example, terminal session and SCP in SSH, Drawing, Clipboard in RDP) that can be used in a connection. The channel policy can further restrict access to each channel based on the IP address of the client or the server, a user list, user group, or a time policy. For example, all clients may access the servers defined in a connection via SSH terminal, but the channel policy may restrict SCP access only to a single client. The policies set in the channel policy are checked when the user attempts to open a particular channel type in the connection.

Channel policies are protocol specific. To list the available Channel policies for a protocol, use the following command.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/<http|ica|rdp|ssh|telnet|vnc>/channel_policies

The following sections detail the properties of Channel policy objects.

URL

GET https:<IP-address-of-SPS>/api/configuration/<http|ica|rdp|ssh|telnet|vnc>/channel_policies/<object-id>

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 properties of a specific RDP Channel policy object.

curl --cookie cookies -https:<IP-address-of-SPS>/api/configuration/<rdp>/channel_policies/<object-id>

Response

The following is a sample response received, showing the properties of Channel policy objects.

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

{
  "body": {
    "name": "terminal-only",
    "rules": [
      {
        "actions": {
          "audit": true,
          "content_policy": null,
          "four_eyes": false,
          "ids": false
        },
        "allowed_for": {
          "clients": [],
          "gateway_groups": [],
          "remote_groups": [],
          "servers": [],
          "time_policy": {
            "key": "-100",
            "meta": {
              "href": "/api/configuration/policies/time_policies/-100"
            }
          }
        },
        "channel": "#drawing"
      },
      {
        "actions": {
          "audit": true,
          "four_eyes": false,
          "ids": false
        },
        "allowed_for": {
          "clients": [],
          "gateway_groups": [],
          "remote_groups": [],
          "servers": [],
          "time_policy": {
            "key": "-100",
            "meta": {
              "href": "/api/configuration/policies/time_policies/-100"
            }
          }
        },
        "channel": "cliprdr"
      }
    ]
  }
}

Element		Type	Description
name		string	Top level element, the name of the object. This name is also displayed on the SPS web interface. It cannot contain whitespace.
rules		list of JSON objects	Top level element, contains the configuration properties of the object.
	actions	JSON object	The actions that SPS performs for the channel, for example, recording the traffic into an audit trail.
	allowed_for	JSON object	Specifies the access control rules of the channel, for example, permitted target IP addresses or usergroups.
	channel	string	The type of the channel. Note that channels are protocol specific, and different type of channels can have different parameters. For details on HTTP-specific channels, see HTTP channels. For details on Citrix ICA-specific channels, see ICA channels. For details on RDP-specific channels, see RDP channels. For details on SSH-specific channels, see SSH channels. For details on Telnet-specific channels, see Telnet channels. For example: "channel": "#drawing",

Element		Type	Description
actions		JSON object	The list of actions to perform when the Content policy matches the analyzed traffic. All actions are boolean values (true or false)
	audit	boolean	Set to true to record the activities of the channel into audit trails. Possible values: true or false
	content_policy	JSON object	Specifies the Content policy to use in the channel, otherwise its value is null (which is the default). For details on Content policies, see Real-time content monitoring with Content Policies For example: "content_policy": { "key": "<object-id>", }
	four_eyes	boolean	Set to true to require four-eyes authorization to access the channel. For details, see "Configuring four-eyes authorization" in the Administration Guide. Possible values: true or false

Element		Type	Description
allowed_for		JSON object	Specifies the access control rules of the channel.
	clients	list	To restrict the availability of the channel only to certain clients, list the IP address or network of the clients allowed to use this the channel. For IPv6 addresses, use the canonized format of the address. For example: "clients": [ "192.168.1.1/24", "2001:db8:85a3::8a2e:0:0/32" Alternatively, you can also enter a hostname instead. One Identity Safeguard for Privileged Sessions (SPS) saves the hostname and resolves it when opening channels, therefore SPS can trace dynamic IP addresses. NOTE: Note the following limitations: The Domain Name Servers you set must be able to resolve the hostnames you enter into the clients and servers fields, otherwise this function (and, therefore, the sessions using this Channel Policy) will not work. SPS Channel Policies support wildcard characters in the *.example.com format. If the channel opening request contains an IP address, SPS uses a reverse lookup method to resolve this IP address into a hostname for a match. SPS uses the Domain Name Servers set in the /api/configuration/network/dns endpoint to resolve the hostnames.
	gateway_groups	list	You can control channel access during gateway authentication with blacklists or whitelists of user groups. You can use local user lists on SPS, or LDAP groups. To use this option, you must also configure web gateway authentication in the connection policy, or client-side gateway authentication back-end in the authentication policy. For example: "gateway_groups": ["group1", "group2"], To configure local user lists, see User lists.
	remote_groups	list	You can control channel access during authentication to the remote server with blacklists or whitelists of user groups. You can use local user lists on SPS, or LDAP groups. For example: "remote_groups": ["group1", "group2"], To configure local user lists, see User lists.
	servers	list	To restrict the availability of the channel only to certain servers, list the IP address or network of the servers that your clients are allowed to access using this the channel. For IPv6 addresses, use the canonized format of the address. For example: "servers": [ "192.168.1.1/24", "2001:db8:85a3::8a2e:0:0/32" Alternatively, you can also enter a hostname instead. One Identity Safeguard for Privileged Sessions (SPS) saves the hostname and resolves it when opening channels, therefore SPS can trace dynamic IP addresses. NOTE: Note the following limitations: The Domain Name Servers you set must be able to resolve the hostnames you enter into the clients and servers fields, otherwise this function (and, therefore, the sessions using this Channel Policy) will not work. SPS Channel Policies support wildcard characters in the *.example.com format. If the channel opening request contains an IP address, SPS uses a reverse lookup method to resolve this IP address into a hostname for a match. SPS uses the Domain Name Servers set in the /api/configuration/network/dns endpoint to resolve the hostnames. Alternatively, you can configure a custom DNS server to be used for target selection custom_dns field of the Connection Policy.
	time_policy	JSON object	Specifies the Time policy to use in the channel. If you do not want to restrict access, use the default 7x24 policy-100. For details on Time policies, see Time policy. For example: "time_policy": { "key": "-100", }

Policies

List of endpoints for configuring policies and settings that can be referenced when configuring connections.

URL

GET https://<IP-address-of-SPS>/api/configuration/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 the available endpoints.

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

Response

The following is a sample response received when listing the available configuration endpoints.

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

{
  "items": [
    {
      "key": "aa_plugin_instances",
      "meta": {
        "href": "/api/configuration/policies/aa_plugin_instances"
      }
    },
    {
      "key": "analytics",
      "meta": {
        "href": "/api/configuration/policies/analytics"
      }
    },
    {
      "key": "archive_cleanup_policies",
      "meta": {
        "href": "/api/configuration/policies/archive_cleanup_policies"
      }
    },
    {
      "key": "audit_policies",
      "meta": {
        "href": "/api/configuration/policies/audit_policies"
      }
    },
    {
      "key": "backup_policies",
      "meta": {
        "href": "/api/configuration/policies/backup_policies"
      }
    },
    {
      "key": "content_policies",
      "meta": {
        "href": "/api/configuration/policies/content_policies"
      }
    },
    {
      "key": "credentialstores",
      "meta": {
        "href": "/api/configuration/policies/credentialstores"
      }
    },
    {
      "key": "indexing",
      "meta": {
        "href": "/api/configuration/policies/indexing"
      }
    },
    {
      "key": "ldap_servers",
      "meta": {
        "href": "/api/configuration/policies/ldap_servers"
      }
    },
    {
      "key": "signing_cas",
      "meta": {
        "href": "/api/configuration/policies/signing_cas"
      }
    },
    {
      "key": "time_policies",
      "meta": {
        "href": "/api/configuration/policies/time_policies"
      }
    },
    {
      "key": "trusted_ca_lists",
      "meta": {
        "href": "/api/configuration/policies/trusted_ca_lists"
      }
    },
    {
      "key": "user_databases",
      "meta": {
        "href": "/api/configuration/policies/user_databases"
      }
    },
    {
      "key": "userlists",
      "meta": {
        "href": "/api/configuration/policies/userlists"
      }
    },
    {
      "key": "usermapping_policies",
      "meta": {
        "href": "/api/configuration/policies/usermapping_policies"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/aaa",
    "href": "/api/configuration/policies",
    "last": "/api/configuration/x509",
    "next": "/api/configuration/private_keys",
    "parent": "/api/configuration",
    "previous": "/api/configuration/plugins",
    "transaction": "/api/transaction"
  }
}

Endpoint	Description
aa_plugin_instances	Authentication and Authorization plugin policies
analytics	Analytics.
archive_cleanup_policies	Archive/Cleanup policies.
audit_policies	Audit trail encryption, timestamping, and signing.
backup_policies	Backup policies.
content_policies	Actions for detected commands, screen content, credit card information, and window titles.
credentialstores	Local and external credential stores.
indexing	Languages for Optical Character Recognition (OCR).
ldap_servers	LDAP servers.
signing_cas	Signing CAs for generating the server-side certificates on the fly. You can use such CAs in SSL-encrypted RDP sessions, RDP sessions that use Network Level Authentication (CredSSP), or SSH connections that use X.509-based authentication. To configure signing for audit trails, use the audit_policies endpoint.
time_policies	Time policies.
trusted_ca_lists	Trusted Certificate Authorities (CAs), and options for restricting the accepted certificates.
user_databases	Local User Databases are available for RDP, SSH and Telnet protocols, and can be used to authenticate the clients to credentials (passwords, public keys, and certificates) that are locally available on SPS.
userlists	Local white- or blacklists of usernames that allow fine-control over who can access a connection or a channel.
usermapping_policies	Usermapping policies describe who can use a specific username to access the remote server.

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.

Archive/Cleanup policy

Archiving transfers data from SPS to an external storage solution, cleanup removes (deletes) old files. Archived data can be accessed and searched, but cannot be restored (moved back) to the SPS appliance. Only those closed audit-trail files are archived where the retention time has already elapsed. To list the available Archive policies, use the following command.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/policies/archive_cleanup_policies/

The following sections detail the properties of Archive/Cleanup policy objects.

URL

GET https:<IP-address-of-SPS>/api/configuration/policies/archive_cleanup_policies/<object-id>

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 properties of a specific Archive/Cleanup policy object.

curl --cookie cookies -https:<IP-address-of-SPS>/api/configuration/policies/archive_cleanu_policies/<object-id>

Response

The following is a sample response received, showing the properties of Archive/Cleanup policy objects.

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

{
  "key": "99375192754364c2b1bd01",
  "body": {
    "name": "archive_all_with_filelist",
    "include_node_id_in_path": false,
    "notification_event": {
      "type": "all",
      "send_filelist": true,
      "file_count_limit": 123456
    },
    "target": {
      "type": "nfs",
      "server": {
        "selection": "ip",
        "value": "1.2.3.5"
      },
      "path": "/data/backup"
    },
    "start_times": [
      "10:10"
    ],
    "template": "PROTOCOL/CONNECTION/ARCHIVEDATE/",
    "retention_days": 30
  }
}

Element		Type	Description
name		string	Top level element, the name of the object. This name is also displayed on the SPS web interface. It cannot contain whitespace.
include_node_id_in_path		boolean	Include the Cluster Node ID in the path. Recommended to set to True if the SPS instance is a node in a cluster. This ensures that the ID of the node is included in the path of the relevant directory, which is required to prevent cluster nodes from archiving data to the same location, and so overwriting each other's data and resulting in data loss.
notification_event		Top level element
	type	string (all \| errors-only \| none)	all: Sends notification emails on all archive-related events. errors-only: Sends notification emails only on archive-related errors. none: Sends no archive-related notification emails.
	send_filelist	boolean	This is meaningful only if notification_event is set to all. True if the list of files are included in the notification e-mail.
	file_count_limit	integer	This is meaningful only if notification_event is set to all and send_filelist is set to True. The maximum number of files that are included in the notification e-mail.
target		Top level element	Defines the address of the archive server, which protocol to use to access it, and other parameters. SPS can be configured to use the SMB/CIFS, and NFS protocols to access the archive server.
	type	string (smb \| nfs \| none)	smb: Move data to a remote server using SMB/CIFS nfs: Move data to a remote server using NFS none: Cleanup data. Data is deleted from SPS forever and cannot be recovered.
	server	Top level element
	domain	string	Only if type is set to smb. The domain name of the target server
	protocol_version	string	Only if type is set to smb. The SMB protocol to use when SPS connects to the server. Servers are usually backwards compatible with earlier protocol versions (for example, a server that supports version 2.1 supports versions 2.0 and 1.0 as well).
	share	string	Only if type is set to smb. The name and directory path of the share in the following format: share_name/path/to/directory
	authentication	Top level element	Only if type is set to smb.
	path	string	The path to the archive directory on the target server
start_times		list of strings	The time when the archive process starts in H:MM or HH:MM format.
template		string	SPS organizes the audit trails into directories based on the date or the protocol. The subdirectories are created directly into the archive directory. The following subdirectory structures are possible: PROTOCOL/CONNECTION/ARCHIVEDATE/ ARCHIVEDATE/CONNECTION/PROTOCOL/ CONNECTIONDATE/PROTOCOL/CONNECTION/ ARCHIVEDATE/ CONNECTIONDATE/
retention_days		integer (days)	Data older than this value is archived to the external server. The archived data is deleted from SPS.

Elements of server		Type	Description
server		Top level element
	selection	string (ip \| fqdn)	ip: IP address fqdn: Hostname
	value	string	The IP address or the hostname of the remote server

Elements of authentication		Type	Description
authentication		Top level element	Only if type is set to smb.
	selection	string (password \| anonymous)	password: To log on using a username and password. anonymous: To log on anonymously.
	username	string	Only if selection is set to password. The username used to log on to the remote server
	password	string	Only if selection is set to password. The password corresponding to the username

Audit policies

The list of audit policies. An audit policy contains settings for encrypting, timestamping, and signing audit trails. To enable auditing for a connection, select an audit policy when configuring connections, and enable auditing for the appropriate protocol channels in the connection's channel policy.

NOTE: The default audit policy is pre-selected when creating connection policies. Modify that audit policy with care.

URL

GET https://<IP-address-of-SPS>/api/configuration/policies/audit_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 the audit policies.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/policies/audit_policies

The following command retrieves the properties of a specific policy.

curl --cookie cookies https://<IP-address-of-SPS>/api/policies/audit_policies/<policy-id>

Response

The following is a sample response received when listing audit policies.

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

{
  "items": [
    {
      "key": "78101850949e47437dd91d",
      "meta": {
        "href": "/api/configuration/policies/audit_policies/78101850949e47437dd91d"
      }
    },
    {
      "key": "9161063345713f11489305",
      "meta": {
        "href": "/api/configuration/policies/audit_policies/9161063345713f11489305"
      }
    },
    {
      "key": "1e089e2a-76b4-4079-94e3-c83ebc74dc2e",
      "meta": {
        "href": "/api/configuration/policies/audit_policies/1e089e2a-76b4-4079-94e3-c83ebc74dc2e"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/policies/audit_policies",
    "href": "/api/configuration/policies/audit_policies",
    "last": "/api/configuration/policies/usermapping_policies",
    "next": "/api/configuration/policies/content_policies",
    "parent": "/api/configuration/policies",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

When querying a default audit policy, the response is the following:

{
  "key": "78101850949e47437dd91d",
  "body": {
    "name": "default",
    "timestamping": {
      "enabled": false
    },
  "encryption": {
    "enabled": false
  },
  "signing": {
    "enabled": false
  },
  "signing_and_timestamping_interval": 30
  }
}

When retrieving the endpoint of a specific audit policy, you will get a similar response:

{
  "body": {
    "encryption": {
      "certificates": [
        {
          "certificate": "<cert1>",
          "four_eyes_certificate": "<cert2>"
        }
      ],
      "different_certificates_for_upstream": {
        "certificates": [
          {
            "certificate": "<cert3>",
            "four_eyes_certificate": "<cert4>"
          }
        ],
        "enabled": true
      },
      "enabled": true
    },
    "name": "<policy-name>",
    "signing": {
      "enabled": true,
      "x509_identity": {
        "key": "ec0b6604-37f6-4df6-bd2f-d7879a75b324",
        "meta": {
          "href": "/api/configuration/x509/ec0b6604-37f6-4df6-bd2f-d7879a75b324"
        }
      }
    },
    "timestamping": {
      "enabled": "false"
    },
  "key": "1e089e2a-76b4-4079-94e3-c83ebc74dc2e",
  "meta": {
    "first": "/api/configuration/policies/audit_policies/78101850949e47437dd91d",
    "href": "/api/configuration/policies/audit_policies/1e089e2a-76b4-4079-94e3-c83ebc74dc2e",
    "last": "/api/configuration/policies/audit_policies/1e089e2a-76b4-4079-94e3-c83ebc74dc2e",
    "next": null,
    "parent": "/api/configuration/policies/audit_policies",
    "previous": "/api/configuration/policies/audit_policies/9161063345713f11489305",
    "transaction": "/api/transaction"
  }
}

Element			Type	Description
key			string	Top level element, contains the ID of the policy.
body			Top level element (string)	The configuration elements of the policy.
	Elements of encryption		Top level element (JSON object)	Audit trail encryption settings. For more information, see Audit policies.
	name		string	The name of the policy. This name is also displayed on the SPS web interface. NOTE: The name and must not contain whitespaces.
	signing		Top level element (JSON object)	Audit trail signing settings.
		enabled	boolean	Set to true to enable signing your audit trails. If signing is enabled, the x509_identity element is also required.
		x509_identity	string	Required for signing audit trails. References the identifier of the X.509 certificate stored on SPS. You can configure certificates at the /api/configuration/x509/ endpoint. TIP: To modify or add an X.509 host certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key).
	timestamping		boolean	Set to true to timestamp the audit trail.
	signing_and_timestamping_interval		string	Sets the interval (in seconds) for how frequently SPS signs and timestamps your audit trails. NOTE: Accepted values: whole numbers between 10 and 100,000.

Elements of encryption			Type	Description
certificates			Top level list (JSON object)	Contains the encrypting certificates.
	certificate		string	The encrypting certificate. You can replay an encrypted audit trail with the private key of the encrypting certificate.
	four_eyes_certificate		string	Additional certificate for joint (that is, four-eyes) encryption. You can only replay a jointly encrypted audit trail with the private keys of both certificates.
different_certificates_for_upstream			Top level item (JSON object)	Configures encrypting upstream traffic separately.
	certificates		Top level list (JSON object)	The certificates for encrypting upstream traffic.
		certificate	string	The encrypting certificate. You can replay an encrypted upstream with the private key of the encrypting certificate.
		four_eyes_certificate	string	Additional certificate for joint (that is, four-eyes) encryption. You can only replay a jointly encrypted upstream with the private keys of both certificates.
	enabled		boolean	Set to true to encrypt the upstream traffic with separate certificate(s). NOTE: If upstream encryption is enabled, the certificates element is required.
enabled			boolean	Set to true to enable encrypting audit trails. NOTE: If encryption is enabled, the certificates and different_certificates_for_upstream elements are required.

Elements of signing			Type	Description
enabled			boolean	Set to true to enable audit trail signing. NOTE: If set to true, the x509_identity element is also required.
x509_identity			JSON object	Required for signing audit trails if enabled is set to true. References the identifier of the X.509 certificate stored on SPS. You can configure certificates at the /api/configuration/x509/ endpoint. TIP: To modify or add an X.509 host certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key).
	key		string	The reference ID for the x509_identity.
	meta		JSON object	The link that indicates the origin of the key. For more information, see Message format.
		href	uri	The unique REST API URI for the meta JSON object.

Elements of timestamping			Type	Description
enabled			boolean	Set to true to enable timestamping in your configuration.
server			JSON object	Configuration options for the server used for timestamping.
	selection		string	Set to local to use the built-in timestamping option of SPS. Set to remote to use an external Timestamping Authority's timestamping server.
	server_url		uri	The URI of the external Timestamping Authority's timestamping server. Only applies when selection is set to remote.
	oid		JSON object
		enabled	boolean	Set to true to enable using the policy_oid.
		policy_oid	string

Encrypting certificates

Encrypting certificates must not contain any metadata. SPS uses only the key part of the certificate, no other data (expiry, etc.) are relevant for encryption.

To use a certificate with the SPS API, remove all metadata, and substitute line breaks with \n.

The following is an example certificate, as used on the SPS web interface:

The same certificate, as accepted by the SPS API:

"certificate": "-----BEGIN CERTIFICATE-----\nMIIDnDCCAoQCCQDc536Ob5tPQTANBgkqhkiG9w0BAQUFADCBjzELMAkGA1UEBhMC\nQ0ExEDAOBgNVBAgTB09udGFyaW8xEDAOBgNVBAcTB1Rvcm9udG8xEDAOBgNVBAoT\nB0JhbGFiaXQxFjAUBgNVBAsTDURvY3VtZW50YXRpb24xEDAOBgNVBAMTB2JhbGFi\naXQxIDAeBgkqhkiG9w0BCQEWEWNhdGFpbEBiYWxhYml0Lmh1MB4XDTE2MDQyMjE2\nMDAyNloXDTE3MDQyMjE2MDAyNlowgY8xCzAJBgNVBAYTAkNBMRAwDgYDVQQIEwdP\nbnRhcmlvMRAwDgYDVQQHEwdUb3JvbnRvMRAwDgYDVQQKEwdCYWxhYml0MRYwFAYD\nVQQLEw1Eb2N1bWVudGF0aW9uMRAwDgYDVQQDEwdiYWxhYml0MSAwHgYJKoZIhvcN\nAQkBFhFjYXRhaWxAYmFsYWJpdC5odTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC\nAQoCggEBAOGa9I2jmVlVdVWEI/Wy7ahTeyaIjK52FQUXqxG8okOSD+nV74ZFUuiS\n59X+2Ow1aDqVGrDMgPNhSVpYXUvDUAUOILJW4rAIoxDY6vDU9/4v9dDiQfEPlauw\n0qNRjPS1MLzjSOQDSKqPkdivkS6HKZeX3+TFq3OxO+vIrF9zFfp9T+eDG2oSobPc\n3mV2zkvtD61CXzbezAVdArDl6WnysRyzxyH8WEhFwZepWxFD9Y5N1dzKody7Hncs\nX5kVIv0+Z6bBHfg/7wHWysJdwNuLr0ByTOvPM6WdA83k3Fy2gYNk7Rc0BbRFbQTX\nhJVfUzSUWHVhFQtAb4diKU5voqepfNMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEA\nR5DIwOHsEKoGkiI3cHC2VMnxP2rRhpTneh6El+DFnQPdjrXa+tnqV4TdnNaD+FvP\nAB1kqbmC4hJAsjMLU2b1ne6m+SLmzhRuMxcA6x+fnYvcQT57IbRdq2E/4oJGeyuy\n0jQE+nmoVD3lDytIOxCfQvZhl1tcbBE5hp5USme4PmNhY6QfUlgjsFjPfoVG7XDB\nuNaUoWS6RvZPmL5IuvF9tqe96ES6DTjC8rBfQYvSoVNjjPnUMx0C8xstRSEG7oJc\nN5+4ImYnFNxSG20hZpFy0OFDf2g7Fx+W50/NtXamUF1Sf8WlPZc03oVl1/Fzo7mt\nqYyyD1ld89OUEYZ+aJQd/A==\n-----END CERTIFICATE-----\n"

Example

Encrypting upstream traffic only (with a single certificate).

{
  "encryption": {
    "certificates": [],
    "different_certificates_for_upstream": {
      "certificates": [{
        "certificate": "<cert>",
        "four_eyes_certificate": null
      }],
       "enabled": true
    },
    "enabled": true
  },
  "name": "upstream_only",
  "signing": {
    "enabled": false
    },
  "timestamping": {
    "enabled": "false"
  }
}

Signing

You can enable signing by any of the following methods, combined with Timestamping if needed.

Examples

Enable signing, no traffic encryption.

{
  "encryption": {
    "enabled": false
  },
  "name": "sign_no_traffic_encryption",
  "signing": {
    "enabled": true,
    "x509_identity": {
      "key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "meta": {
        "href": "/api/configuration/x509/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
       }
     }
    }
  "timestamping": {
    "enabled": "false"
  }
}

Enable signing, and encrypt traffic with a single certificate (no separate upstream encryption).

{
  "encryption": {
    "certificates": [{
      "certificate": "<cert>",
      "four_eyes_certificate": null
    }],
    "different_certificates_for_upstream": {
      "enabled": false
    },
  "enabled": true
  },
  "name": "API_audit_pol",
  "signing": {
    "enabled": true,
    "x509_identity": {
      "key": "d0286f64-41aa-45e1-ab19-830ac2f99f57",
      "meta": {
        "href": "/api/configuration/x509/d0286f64-41aa-45e1-ab19-830ac2f99f57"
      }
    }
  },
  "timestamping": {
    "enabled": "false"
  }
}

Timestamping

You can configure timestamping by using the following methods:

Timestamping disabled:
Local timestamping:
External timestamping:

Examples

Timestamping disabled:

{
  "body":{
    "name": "timestamping_disabled",
    "timestamping": {
      "enabled": false
  }
}

Local timestamping:

{
  "body":{
    "name": "local_timestamping",
    "timestamping": { 
      "enabled": true,
    "server": { 
    "selection": "local" 
  } 
}

External timestamping:

{
  "body":{
    "name": "external_timestamping",
    "timestamping": { 
      "enabled": true, 
    "server": { 
      "selection": "remote", 
      "server_url": "http://tsa.example.com/", 
      "oid": { 
        "enabled": true, 
        "policy_oid": "2.3.5.3.1.5.32.322.32" 
      } 
    } 
}

Adding an audit policy

To add an audit policy

Open a transaction.

For more information, see Open a transaction.
Create the JSON object for the new audit policy.

POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/policies/audit_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 audit policy. For example:
```
{
  "key": "1e089e2a-76b4-4079-94e3-c83ebc74dc2e",
  "meta": {
    "href": "/api/configuration/policies/audit_policies/1e089e2a-76b4-4079-94e3-c83ebc74dc2e",
    "parent": "/api/configuration/policies/audit_policies",
    "transaction": "/api/transaction"
  }
}
```
Commit your changes.

For more information, see Commit a transaction.

Modifying an audit policy

To modify an audit policy, you have to:

Open a transaction.

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

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

Selecione seu produto:

Para podermos atendê-lo melhor, informe o Propósito de seu chat:

Soluções recomendadas para seu problema

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

Channel policy

URL

Cookies

Sample request

Response

Policies

URL

Cookies

Sample request

Response

Status and error codes

Archive/Cleanup policy

URL

Cookies

Sample request

Response

Audit policies

URL

Cookies

Sample request

Response

Encrypting certificates

Signing

Timestamping

Adding an audit policy

Open a transaction.

Create the JSON object for the new audit policy.

Commit your changes.

Modifying an audit policy

Open a transaction.

Modify the JSON object of the audit policy.

Commit your changes.

Status and error codes