List of endpoints for configuring the policies, options and connection rules of HTTP connections.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http
Header 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 Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists the available settings for configuring for HTTP connections.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http
The following is a sample response received when listing the configuration settings. For details of the meta object, see Introduction.
{ "items": [ { "key": "channel_policies", "meta": { "href": "/api/configuration/http/channel_policies" } }, { "key": "options", "meta": { "href": "/api/configuration/http/options" } }, { "key": "settings_policies", "meta": { "href": "/api/configuration/http/settings_policies" } } ], "meta": { "first": "/api/configuration/aaa", "href": "/api/configuration/http", "last": "/api/configuration/x509", "next": "/api/configuration/ica", "parent": "/api/configuration", "previous": "/api/configuration/datetime", "transaction": "/api/transaction" } }
Item | Description |
---|---|
channel_policies | List of the default and custom channel policies. |
options | List of global HTTP options that affect all connections. |
settings_policies | List of protocol-level settings (idle and session timeout). You can create multiple variations, and choose the appropriate one for each connection policy. |
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
Connection policies determine if a server can be accessed from a particular client. Connection policies reference other resources (policies, usergroups, keys) that must be configured and available before creating a connection policy.
|
Caution:
The connection policies of this protocol are available in READ-ONLY mode on the REST API. Also, the returned data is incomplete, it does not include any protocol-specific settings, only the parameters that are common to every supported protocol. To modify the connection policies of this protocol, you must use the Safeguard for Privileged Sessions web interface. Using the REST API, you can modify the connection policies of the RDP and SSH protocols. |
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/connections/
Header 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 Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists RDP connection policies.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/connections/
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/connections/<connection-key>
List of options that affect all HTTP connections.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/options
Header 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 Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists global HTTP options.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/options
The following is a sample response received when listing global HTTP options. For details of the meta object, see Introduction.
{ "body": { "audit": { "cleanup": { "enabled": false }, "timestamping": { "selection": "local", "signing_interval": 30 } }, "service": { "enabled": true, "log_level": 4 } }, "key": "options", "meta": { "first": "/api/configuration/http/channel_policies", "href": "/api/configuration/http/options", "last": "/api/configuration/http/settings_policies", "next": "/api/configuration/http/settings_policies", "parent": "/api/configuration/http", "previous": "/api/configuration/http/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 HTTP options. | ||
audit | Top level item | Contains settings for timestamping and cleanup. | ||
service | Top level item | Global setting to enable HTTP connections, and specify the logging detail. | ||
enabled | boolean | Set to true to enable HTTP connections. | ||
log_level | int | Defines the logging detail of HTTP connections. |
Elements of audit | Type | Description | ||
---|---|---|---|---|
cleanup | Top level item | Global retention settings for HTTP 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 HTTP connections, in days. Must exceed the retention time of the archiving policy (or policies) used for HTTP connections, and the connection-specific database cleanup times (if configured). | ||
enabled | boolean | To enable the global cleanup of HTTP connection metadata, set this element to true. | ||
timestamping | Top level item | Global timestamping settings for HTTP connections. | ||
selection | string |
Configures local or remote timestamping.
| ||
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. |
Set Safeguard for Privileged Sessions 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 } }
To modify global HTTP settings, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/options endpoint. You can find a detailed description of the available parameters listed in Global HTTP options. The elements of the audit item are described in Global HTTP options.
For details, see Commit a transaction.
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
HTTP settings policies define protocol-level settings for idle and session timeout. You can create multiple policies, and choose the appropriate one for each HTTP connection.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/settings_policies
Header 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 Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists HTTP settings policies.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/settings_policies
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/settings_policies/<policy-id>
The following is a sample response received when listing HTTP settings policies. For details of the meta object, see Introduction.
{ "items": [ { "key": "-3040010", "meta": { "href": "/api/configuration/http/settings_policies/-3040010" } } ], "meta": { "first": "/api/configuration/http/channel_policies", "href": "/api/configuration/http/settings_policies", "last": "/api/configuration/http/settings_policies", "next": null, "parent": "/api/configuration/http", "previous": "/api/configuration/http/options", "transaction": "/api/transaction" } }
When retrieving the endpoint of a specific policy, the response is the following.
{ "body": { "name": "default", "session_timeout": 900, "timeout": 300 }, "key": "-3040010", "meta": { "first": "/api/configuration/http/settings_policies/-3040010", "href": "/api/configuration/http/settings_policies/-3040010", "last": "/api/configuration/http/settings_policies/-3040010", "next": null, "parent": "/api/configuration/http/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 HTTP settings policy. | |
name | string | Name of the HTTP settings policy. Cannot contain whitespace. | |
session_timeout | int | Session timeout, in seconds. | |
timeout | int | Idle timeout, in seconds. Note that the Safeguard for Privileged Sessions web UI displays the same value in milliseconds. |
To add a settings policy, you have to:
For details, see Open a transaction.
POST the JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/settings_policies/ endpoint. You can find a detailed description of the available parameters listed in HTTP settings policies.
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/http/settings_policies/3848c708-2e1d-4463-b232-0c8c5875ff55", "parent": "/api/configuration/http/settings_policies", "transaction": "/api/transaction" } }
For details, see Commit a transaction.
To modify a settings policy, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/http/settings_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in HTTP settings policies.
For details, see Commit a transaction.
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
© ALL RIGHTS RESERVED. Feedback Terms of Use Privacy