The /api/info endpoint contains generic information about the Safeguard for Privileged Sessions host. Note that part of this information is available without authentication.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/info
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 displays the information about Safeguard for Privileged Sessions that is available without authentication.
curl https://10.40.255.171/api/info
The following command displays the information about Safeguard for Privileged Sessions that is available for authenticated users.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/info
The following is a sample response received by an anonymous user. For details of the meta object, see Message format.
{ "body": { "domainname": "balabit", "hostname": "scbwriter", "nickname": null, "support_link": "mailto:scb-administrator@example.com" }, "key": "about_info", "meta": { "href": "/api/info", "parent": "/api" } }
The following is a sample response received by an authenticated user.
{ "body": { "analytics_enabled": false, "build_date": "2018-06-15T20:18:40+00:00", "config_hash": "2abde4c81d9b544bf53fae4f4b9657fc", "domainname": "balabit", "firmware_version": "5.7.0", "hostname": "scbwriter", "nickname": null, "roles": [ "central-management", "search-master" ], "support_link": "mailto:scb-administrator@example.com", "version": "5 F7" }, "key": "about_info", "meta": { "href": "/api/info", "remaining_seconds": 9889 "parent": "/api" } }
Element | Description |
---|---|
analytics_enabled |
Indicates whether or not the One Identity Safeguard for Privileged Analytics module has been enabled. |
build_date | Build date of the Safeguard for Privileged Sessions firmware. This element is included in the response only for authenticated users. |
config_hash |
Contains the hash of the XML database running on the given SPS host. |
domainname | Name of the domain used on the network. You can configure this parameter on the /api/configuration/network/naming endpoint. For details, see Naming options. |
hostname | Name of the machine running Safeguard for Privileged Sessions. You can configure this parameter on the /api/configuration/network/naming endpoint. For details, see Naming options. |
nickname | The nickname of the Safeguard for Privileged Sessions host. Use it to distinguish the devices. It is displayed in the core and boot login shells. You can configure this parameter on the /api/configuration/network/naming endpoint. For details, see Naming options. |
support_link | The e-mail address of the Safeguard for Privileged Sessions administrator, as set in the admin_address parameter of the /api/configuration/management/email endpoint. For details, see Mail settings. |
firmware_version | The version number of the firmware running on Safeguard for Privileged Sessions, for example, 4.3.2a. This element is included in the response only for authenticated users. |
version | The name of the major release running on Safeguard for Privileged Sessions, for example, 4 F3. This element is included in the response only for authenticated users. |
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
Configuration options for the web interface of Safeguard for Privileged Sessions.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/management/webinterface
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 for the Safeguard for Privileged Sessions web interface.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/management/webinterface
The following is a sample response received when listing the configuration options of the Safeguard for Privileged Sessions web interface. For details of the meta object, see Introduction.
{ "body": { "timeout": 10 }, "key": "webinterface", "meta": { "first": "/api/configuration/management/certificates", "href": "/api/configuration/management/webinterface", "last": "/api/configuration/management/webinterface", "next": null, "parent": "/api/configuration/management", "previous": "/api/configuration/management/syslog", "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. | |
timeout | int | Session timeout, in minutes. Safeguard for Privileged Sessions terminates sessions that are idle for this period. This setting applies sessions that access the Safeguard for Privileged Sessions web interface and the Safeguard for Privileged Sessions REST interface. |
To modify the configuration of the web interface, 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/management/webinterface endpoint. You can find a detailed description of the available parameters listed in Web interface.
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