Local services of SPS
Contains the endpoints for configuring the local services of SPS.
URL
GET https://<IP-address-of-SPS>/api/configuration/local_services
Sample request
The following command lists the local services.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/local_services
Response
The following is a sample response received when listing local services.
{
"items": [
{
"key": "admin_web",
"meta": {
"href": "/api/configuration/local_services/admin_web"
}
},
{
"key": "analytics",
"meta": {
"href": "/api/configuration/local_services/analytics"
}
},
{
"key": "cluster",
"meta": {
"href": "/api/configuration/local_services/cluster"
}
},
{
"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"
}
}
| admin_web |
Web login for administrators and users: On this address, users can, depending on their access privileges, modify the configuration of SPS, 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, One Identity Safeguard for Privileged Sessions (SPS) requires a special license. Also, depending on the number of your users and sessions, the performance and sizing of SPS 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. |
| cluster |
Configure the cluster service of SPS. |
| indexer |
Configure the indexer services of SPS, including remote indexing. |
| postgresql |
Configure direct remote access to the connection database of SPS. |
| snmp_agent |
Configure the SNMP server of SPS. |
| ssh |
Configure remote SSH access to SPS. |
| user_web |
Web login for users only: The configuration of SPS cannot be viewed or altered from this address. Users (even ones with administrator privileges) can only perform gateway authentication and 4-eyes authorization. |
| 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. |
Local services: Web login for administrators
The SPS administrators and users can, depending on their access privileges, modify the configuration of SPS, and perform authentication-related activities (gateway authentication, 4-eyes authorization). On this endpoint you can configure on which interfaces can the administrators access SPS, and optionally restrict the access to these interfaces.
URL
GET https://<IP-address-of-SPS>/api/configuration/local_services/admin_web
Sample request
The following command lists the configuration options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/local_services/admin_web
Response
The following is a sample response received when listing the configuration options.
{
"body": {
"access_restriction": {
"allowed_from": [
"10.40.0.0/16"
],
"enabled": 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"
}
}
| key |
|
|
string |
Top level element, contains the ID of the endpoint. |
| body |
|
|
Top level element (string) |
Contains the configuration options of the SPS 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 SPS accepts HTTP connections. Note that SPS automatically redirects connections from this port to the HTTPS port set in https_port. |
|
|
https_port |
integer |
The port number where SPS accepts HTTPS connections. |
| 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. |
Local services: Web login for users
The SPS users can perform authentication-related activities (gateway authentication, 4-eyes authorization). On this endpoint you can configure on which interfaces can the users access SPS, and optionally restrict the access to these interfaces.
URL
GET https://<IP-address-of-SPS>/api/configuration/local_services/user_web
Sample request
The following command lists the configuration options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/local_services/user_web
Response
The following is a sample response received when listing the configuration options.
{
"body": {
"access_restriction": {
"allowed_from": [
"10.40.0.0/16"
],
"enabled": 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": "user_web",
"meta": {
"first": "/api/configuration/local_services/user_web",
"href": "/api/configuration/local_services/user_web",
"last": "/api/configuration/local_services/user_web",
"next": "/api/configuration/local_services/indexer",
"parent": "/api/configuration/local_services",
"previous": null,
"transaction": "/api/transaction"
}
}
| key |
|
|
string |
Top level element, contains the ID of the endpoint. |
| body |
|
|
Top level element (string) |
Contains the configuration options of the SPS 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 SPS accepts HTTP connections. Note that SPS automatically redirects connections from this port to the HTTPS port set in https_port. |
|
|
https_port |
integer |
The port number where SPS accepts HTTPS connections. |
| 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. |
Local services: cluster interface
To enable cluster management, enable the cluster interface on all nodes that you want to be part of your One Identity Safeguard for Privileged Sessions (SPS) cluster. Complete the following steps on each node of the cluster.
NOTE: If you have an SPS device forwarding events to your Splunk, and you want to process and visualize these events with your own, custom dashboards, the Splunk Add-on can provide you with useful event types that you can use in your custom searches. For more information about visualizing events and customizing dashboards, see The Splunk App and Macros and search expressions.
URL
GET https://<IP-address-of-SPS>/api/configuration/local_services/cluster
Sample request
The following command lists the configuration options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/local_services/cluster
Response
The following is a sample response received when listing the configuration options.
{
"body": {
"enabled": true,
"listen_address": {
"key": "nic1.interfaces.ff7574025754b3df1647001.addresses.2553887595ce3ca7f1eae4",
"meta": {
"href": "/api/configuration/network/nics/nic1#interfaces/ff7574025754b3df1647001/addresses/2553887595ce3ca7f1eae4"
}
}
},
"key": "cluster",
"meta": {
"first": "/api/configuration/local_services/admin_web",
"href": "/api/configuration/local_services/cluster",
"last": "/api/configuration/local_services/user_web",
"next": "/api/configuration/local_services/indexer",
"parent": "/api/configuration/local_services",
"previous": "/api/configuration/local_services/analytics",
"remaining_seconds": 600,
"transaction": "/api/transaction"
}
}
| enabled |
|
|
boolean |
By default, this option is set to false. Set it to true to enable the cluster interface. |
| listen_address |
|
|
Top level element (string) |
Contains the key of the network interface that is used as the cluster interface. |
| 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. |
