Contains the network addresses configured for each physical NIC.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/network/nics
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 endpoints for the physical network interfaces.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/network/nics/
The following commands retrieve the properties of a specific physical network interface.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/network/nics/nic1
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/network/nics/nic2
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/network/nics/nic3
The following is a sample response received when listing physical network interfaces. For details of the meta object, see Introduction.
{ "items": [ { "key": "nic1", "meta": { "href": "/api/configuration/network/nics/nic1" } }, { "key": "nic2", "meta": { "href": "/api/configuration/network/nics/nic2" } }, { "key": "nic3", "meta": { "href": "/api/configuration/network/nics/nic3" } } ], "meta": { "first": "/api/configuration/network/dns", "href": "/api/configuration/network/nics", "last": "/api/configuration/network/routing", "next": "/api/configuration/network/routing", "parent": "/api/configuration/network", "previous": "/api/configuration/network/naming", "transaction": "/api/transaction" } }
When retrieving the endpoint of a specific physical network interface, the response is the following.
{ "body": { "interfaces": { "@order": [ "ff7574025754b3df1647001" ], "ff7574025754b3df1647001": { "addresses": { "1": "192.168.56.101/24", "4323998795727ae1ab8750": "192.168.56.151/24", "@order": [ "1", "4323998795727ae1ab8750" ] }, "mtu": 1500, "name": "default", "source_based_routes": [], "vlantag": 0 } }, "name": "eth0", "speed": "auto" }, "key": "nic1", "meta": { "first": "/api/configuration/network/nics/nic1", "href": "/api/configuration/network/nics/nic1", "last": "/api/configuration/network/nics/nic3", "next": "/api/configuration/network/nics/nic2", "parent": "/api/configuration/network/nics", "previous": null, "transaction": "/api/transaction" } }
Element | Type | Description | |
---|---|---|---|
key | string | Top level element, contains the ID of the physical network interface (nic1, nic2 or nic3). | |
body | Top level element (string) | Contains the properties of the physical network interface. | |
interfaces | Top level item | Contains the configuration of all virtual interfaces on the physical NIC. | |
mtu | integer | Maximum Transmission Unit (MTU) to set per network interface (VLAN or network interface card). Default value: 1500 | |
name | string | The system name of the physical network interface (eth0, eth1 or eth2). Do not change this value. | |
speed | string |
The speed of the physical network interface. The default value is auto. Change this setting only for troubleshooting purposes. Possible values are:
|
Elements of interfaces | Type | Description | ||||
---|---|---|---|---|---|---|
@order | list |
Lists the keys of the interfaces in the order they are be displayed on the Safeguard for Privileged Sessions web UI. | ||||
<key-of-an-interface> | string |
Contains the addresses, name, and vlantag of the network interface. Each physical NIC has an automatically created interface key, where the value of the vlanid element is set to 0. To add a valid virtual network interface to the physical NIC, create an additional interface, and assign a value between 1 and 4094 to its vlanid element. | ||||
addresses | string | Contains the addresses of the interface, and their display order. | ||||
<key-of-address> | string | Contains the IP address range. | ||||
@order | list | Lists the keys of the addresses in the order they are be displayed on the Safeguard for Privileged Sessions web UI. | ||||
name | string | The name of the interface, as displayed on the Safeguard for Privileged Sessions web UI. | ||||
vlantag | string |
The ID of the interface. For the physical interface, the value is 0. For virtual interfaces, the value is between 1 and 4094.
|
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. |
Contains the address of the gateway server for each configured subnet.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/network/routing
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 configured subnets and the corresponding gateway servers.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/network/routing
The following is a sample response received when viewing the routing table. For details of the meta object, see Introduction.
{ "body": [ { "gateway": "192.168.56.1", "target_network": "0.0.0.0/0" } ], "key": "routing", "meta": { "first": "/api/configuration/network/dns", "href": "/api/configuration/network/routing", "last": "/api/configuration/network/routing", "next": null, "parent": "/api/configuration/network", "previous": "/api/configuration/network/nics", "transaction": "/api/transaction" } }
Element | Type | Description | |
---|---|---|---|
key | string | Top level element, contains the ID of the endpoint. | |
body | Top level element (list) | Contains the routing table. | |
gateway | string | The IP address of the gateway server. | |
target_network | string | The network id (IP address and subnet mask) of the subnet. |
To add a subnet, 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/network/routing endpoint. You can find a detailed description of the available parameters listed in Routing table.
For details, see Commit a transaction.
To modify the routing table, 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/netowrk/routing endpoint. You can find a detailed description of the available parameters listed in Routing table.
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. |
Contains the endpoints for configuring the local services of Safeguard for Privileged Sessions.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/local_services
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 local services.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/local_services
The following is a sample response received when listing local services. For details of the meta object, see Introduction.
{ "items": [ { "key": "admin_web", "meta": { "href": "/api/configuration/local_services/admin_web" } }, { "key": "analytics", "meta": { "href": "/api/configuration/local_services/analytics" } }, { "key": "indexer", "meta": { "href": "/api/configuration/local_services/indexer" } }, { "key": "postgresql", "meta": { "href": "/api/configuration/local_services/postgresql" } }, { "key": "snmp_agent", "meta": { "href": "/api/configuration/local_services/snmp_agent" } }, { "key": "ssh", "meta": { "href": "/api/configuration/local_services/ssh" } }, { "key": "user_web", "meta": { "href": "/api/configuration/local_services/user_web" } } ], "meta": { "first": "/api/configuration/aaa", "href": "/api/configuration/local_services", "last": "/api/configuration/x509", "next": "/api/configuration/management", "parent": "/api/configuration", "previous": "/api/configuration/ica", "transaction": "/api/transaction" } }
Element | Description |
---|---|
admin_web | Web login for administrators and users: On this address, users can, depending on their access privileges, modify the configuration of Safeguard for Privileged Sessions, and perform authentication-related activities (gateway authentication, 4-eyes authorization). |
analytics |
Enables One Identity Safeguard for Privileged Analytics. To enable One Identity Safeguard for Privileged Analytics and analyze the behavior of your users, Safeguard for Privileged Sessions requires a special license. Also, depending on the number of your users and sessions, the performance and sizing of Safeguard for Privileged Sessions must be considered. If you are interested in One Identity Safeguard for Privileged Analytics, contact our Sales Team, or your One Identity representative. For details on One Identity Safeguard for Privileged Analytics, see the One Identity One Identity Safeguard for Privileged Analytics website. For details on enabling One Identity Safeguard for Privileged Analytics, see Safeguard for Privileged Analytics Configuration Guide. |
indexer | Configure the indexer services of Safeguard for Privileged Sessions, including remote indexing. |
postgresql | Configure direct remote access to the connection database of Safeguard for Privileged Sessions. |
snmp_agent | Configure the SNMP server of Safeguard for Privileged Sessions. |
ssh | Configure remote SSH access to Safeguard for Privileged Sessions. |
user_web |
Web login for users only: The configuration of Safeguard for Privileged Sessions cannot be viewed or altered from this address. Users (even ones with administrator privileges) can only perform gateway authentication and 4-eyes authorization. |
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. |
The Safeguard for Privileged Sessions administrators and users can, depending on their access privileges, modify the configuration of Safeguard for Privileged Sessions, and perform authentication-related activities (gateway authentication, 4-eyes authorization). On this endpoint you can configure on which interfaces can the administrators access Safeguard for Privileged Sessions, and optionally restrict the access to these interfaces.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/local_services/admin_web
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 configuration options.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/local_services/admin_web
The following is a sample response received when listing the configuration options. For details of the meta object, see Introduction.
{ "body": { "access_restriction": { "allowed_from": [ "10.40.0.0/16" ], "enabled": true }, "bruteforce_protection": true, "listen": [ { "address": { "key": "nic1.interfaces.ff7574025754b3df1647001.addresses.1", "meta": { "href": "/api/configuration/network/nics/nic1#interfaces/ff7574025754b3df1647001/addresses/1" } }, "http_port": 80, "https_port": 443 } ] }, "key": "admin_web", "meta": { "first": "/api/configuration/local_services/admin_web", "href": "/api/configuration/local_services/admin_web", "last": "/api/configuration/local_services/user_web", "next": "/api/configuration/local_services/indexer", "parent": "/api/configuration/local_services", "previous": null, "transaction": "/api/transaction" } }
Element | Type | Description | ||
---|---|---|---|---|
key | string | Top level element, contains the ID of the endpoint. | ||
body | Top level element (string) | Contains the configuration options of the Safeguard for Privileged Sessions web interface. | ||
access_restriction |
JSON object |
Enables and configures limitations on the clients that can access the web interface, based on the IP address of the clients. | ||
allowed_from |
list |
The list of IP networks from where the administrators are permitted to access this management interface. To specify the IP addresses or networks, use the IPv4-Address/prefix format, for example, 10.40.0.0/16. | ||
enabled |
boolean |
Set it to true to restrict access to the specified client addresses. | ||
bruteforce_protection | boolean | Enables protection against brute-force attacks by denying access after failed login attempts for increasingly longer period. Enabled by default. | ||
listen | list | Selects the network interface, IP address, and port where the clients can access the web interface. | ||
address | JSON object |
A reference to a configured network interface and IP address where this local service accepts connections. For example, if querying the interface /api/configuration/network/nics/nic1#interfaces/ff7574025754b3df1647001/addresses/ returns the following response: { "body": { "interfaces": { "@order": [ "ff7574025754b3df1647001" ], "ff7574025754b3df1647001": { "addresses": { "1": "10.40.255.171/24", "@order": [ "1" ] }, "name": "default", "vlantag": 0 } }, "name": "eth0", "speed": "auto" }, "key": "nic1", "meta": { "first": "/api/configuration/network/nics/nic1", "href": "/api/configuration/network/nics/nic1", "last": "/api/configuration/network/nics/nic3", "next": "/api/configuration/network/nics/nic2", "parent": "/api/configuration/network/nics", "previous": null, "transaction": "/api/transaction" } } Then the listening address of the local service is the following. nic1.interfaces.ff7574025754b3df1647001.addresses.1 This is the format you have to use when configuring the address of the local service using REST: "address": "nic1.interfaces.ff7574025754b3df1647001.addresses.1" When querying a local services endpoint, the response will contain a reference to the IP address of the interface in the following format: "address": { "key": "nic1.interfaces.ff7574025754b3df1647001.addresses.1", "meta": { "href": "/api/configuration/network/nics/nic1#interfaces/ff7574025754b3df1647001/addresses/1" } }, | ||
http_port | integer | The port number where Safeguard for Privileged Sessions accepts HTTP connections. Note that Safeguard for Privileged Sessions automatically redirects connections from this port to the HTTPS port set in https_port. | ||
https_port | integer | The port number where Safeguard for Privileged Sessions accepts HTTPS connections. |
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. |
© ALL RIGHTS RESERVED. Feedback Terms of Use Privacy