One Identity Safeguard for Privileged Sessions 8.0 LTS

One Identity Safeguard for Privileged Sessions 8.0 LTS - REST API Reference Guide

Authenticate to the SPS REST API using X.509 certificate Listing SPS login methods Retrieve user information Checking the transaction status Open a transaction Commit a transaction Delete a transaction Reviewing the changelog of a transaction Defaults query parameter Application level error codes Navigating the configuration of SPS Modifying the configuration of SPS

Delete an object Create a new object Change an object

Generating SPS support bundle using REST

Basic settings

Retrieve basic firmware and host information Listing integrated products with SPS Firmware management

Retrieving information about SPS firmware image slots Testing new SPS firmware before upgrade Upgrading SPS to a new firmware Uploading new firmware to SPS Downloading and installing SPS firmware through HTTP

Network settings

Network configuration options DNS servers Routing between interfaces Naming options Network addresses Routing table Local services of SPS Local services: Web login for administrators Local services: Web login for users Local services: cluster interface System backup policy Encrypting system backup policy

Date and time

Date & time NTP servers Timezone

Logs, monitoring and alerts

Management options

Web gateway authentication

Syslog server settings Disk fill-up prevention Mail settings Health monitoring SNMP settings SNMP traps Local services: access for SNMP agents Alerting System alerts Traffic alerts

Trust stores Enabling One Identity Safeguard Remote Access without Starling Join Managing Starling Join

Retrieving the status of services related to Starling Join/Unjoin

User management and access control

User management and access control Login settings Privileges of usergroups Audit data access rules Active sessions Manage users and usergroups locally on SPS Manage usergroups locally on SPS Manage users locally on SPS Configuring LDAP servers Configuring SPS login methods Configuring the SAML2 Service Provider settings

Managing SPS

Troubleshooting options Internal certificates Passwords stored on SPS Private keys stored on SPS Private keys generated on SPS Certificates stored on SPS Local services: enabling SSH access to the SPS host Manage the SPS license Change contact information SIEM forwarder Manage SPS clusters

Promote a SPS node to be the Central Management node in a new cluster Join node(s) to the cluster Query join status Assign a role to a node Query nodes Query one particular node Query the status of all nodes in the cluster Query the status of one particular node Upload and enable a configuration synchronization plugin Disable a configuration synchronization plugin

Configuration tools in SPS

Resolving hostnames to IP addresses Testing LDAP server connection

General connection settings

Channel policy Policies Archive/Cleanup policy

Running audit data cleanup policies immediately

Audit policies Backup policy Real-time content monitoring with Content Policies LDAP servers Signing CA policies Time policy Trusted Certificate Authorities Local user databases User lists

HTTP connections

HTTP connections HTTP connection policies HTTP channels HTTP authentication policies Global HTTP options HTTP settings policies Creating custom HTTP error templates Uploading a custom logo to your custom HTTP proxy error pages

Citrix ICA connections

ICA connections ICA connection policies ICA channels Global ICA options ICA settings policies

MSSQL connections

Limitations in handling MSSQL connections MSSQL connections MSSQL connection policies MSSQL channels MSSQL authentication policies Global MSSQL options MSSQL settings policies

RDP connections

RDP connections RDP connection policies RDP channels Configuring domain membership Global RDP options RDP settings policies

SSH connections

SSH connections SSH connection policies SSH channels SSH authentication policies Global SSH options SSH settings policies SSH host keys and certificates

Telnet connections

Telnet connections Telnet connection policies Telnet channels Telnet authentication policies Global Telnet options Telnet pattern sets Telnet settings policies

VNC connections

VNC connections VNC connection policies VNC settings policies Global VNC options

Search, retrieve, download, and index sessions

Audited sessions Download audit trails Searching in the session database with the basic search method Retrieving all sessions from the session database with the advanced search method Retrieving user information from the recorded sessions

Retrieving user lists Retrieving detailed user information

Searching in connection content Generate and retrieve screenshot for content search Session statistics Session histogram Session alerts Session events Indexing sessions Session audit trail downloads Local services: configuring the indexer Indexer policies

Reporting

Reporting Reports Built-in subchapters Pre-defined reports Content subchapters Available search fields

Health and maintenance

Monitor appliance health status Monitor indexer service status Monitor SPS availability from load balancers

Advanced authentication and authorization

Usermapping policy Plugins

Upload a plugin Delete a plugin Check the integrity of a plugin

Authentication and authorization plugins

Configuring Authentication and Authorization plugin instances

Credential store plugins Credential stores

Completing the Welcome Wizard using REST

Enable and configure analytics using REST

Enable One Identity Safeguard for Privileged Analytics Configure One Identity Safeguard for Privileged Analytics

REST API examples

Examples

User management and access control

Detailed information about this topic

User management and access control

Privileges of usergroups

Audit data access rules

Active sessions

Manage users and usergroups locally on SPS

Manage usergroups locally on SPS

Manage users locally on SPS

Configuring LDAP servers

Configuring SPS login methods

Configuring the SAML2 Service Provider settings

User management and access control

User management and access control > User management and access control

The AAA endpoint contains the configuration endpoints for the authentication, authorization, and account (AAA) settings of the users who access SPS.

URL

GET https://<IP-address-of-SPS>/api/configuration/aaa/

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 AAA configuration endpoints.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/aaa/

Response

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

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

{

  "items": [

    {

      "key": "acls",

      "meta": {

        "href": "/api/configuration/aaa/acls"

      }

    },

    {

      "key": "ldap_servers",

      "meta": {

        "href": "/api/configuration/aaa/ldap_servers"

      }

    },

    {

      "key": "local_database",

      "meta": {

        "href": "/api/configuration/aaa/local_database"

      }

    },

    {

      "key": "login_methods",

      "meta": {

        "href": "/api/configuration/aaa/login_methods"

      }

    },

    {

      "key": "saml2",

      "meta": {

        "href": "/api/configuration/aaa/saml2"

      }

    },

    {

      "key": "settings",

      "meta": {

        "href": "/api/configuration/aaa/settings"

      }

    }

  ],

  "meta": {

    "first": "/api/configuration/aaa",

    "href": "/api/configuration/aaa",

    "last": "/api/configuration/x509",

    "next": "/api/configuration/alerting",

    "parent": "/api/configuration",

    "previous": null,

    "transaction": "/api/transaction"

  }

}

Element	Description
acls	Access control settings for usergroups.
ldap_servers	LDAP server configuration for authentication, authorization, and accounting.
local_database	Local users and usergroups.
login_methods	Multiple login method configuration for SPS.
saml2	SAML2 Service Provider settings.
settings	Authentication and user database settings.

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.

Login settings

User management and access control > Login settings

Use login settings to control the web login access of administrators and users to SPS. With the /aaa/settings endpoint you can configure the following three security enhancing measures:

Protecting against brute-force attacks
Authentication banner
Web interface timeout

For more information, see the corresponding sections in One Identity Safeguard for Privileged Sessions Administration Guide.

URL

POST https://<IP-address-of-SPS>/api/configuration/aaa/settings

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).

Operations

Operations with the /aaa/settings endpoint include:

Operation	HTTP method	URL	Notes
Creating login settings	GET	/api/configuration/aaa/settings
Retrieving login settings	POST	/api/configuration/aaa/settings

Sample request

The following command lists the login settings.

curl -X GET -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/configuration/aaa/settings

Response

The following is a sample response received when listing login settings.

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

{
     "key": "settings",
     "body": {
       "authentication_banner": "",
       "bruteforce_protection": {
         "attempt_limit": 20,
         "lockout_minutes": 10
       },
       "webinterface_timeout": 10
     }
   }

Elements of the request message body include:

Element	Type	Description	Notes
authentication_banner	string	Displays a banner with a configurable text on the web and console login screen of SPS. Users will see the banner every time they try to log in to SPS. The login screen displays the banner text as plain text, with whitespaces preserved.	If you specify an empty string, then no authentication banner will show.
bruteforce_protection	JSON object	Protects the web login addresses of administrators and users against brute-force attacks. After the users reach the configured number of unsuccessful login attempts, SPS denies all following attempts for the configured time.
bruteforce_protection.attempt_limit	number	The number of unnsuccessful login attempts before the user name or the IP address is locked out. If the number of subsequent unsuccessful login attempts exceeds this limit, the IP address or the user name will be blocked for a period, which is specified in bruteforce_protection.lockout_minutes.	Value range: 1-50 attempts Default value: 20 attempts
bruteforce_protection.lockout_minutes	number	The period of time for which the user or the IP address is locked out from using the SPS appliance. It is measured in minutes.	Value range: 1-720 minutes Default value: 10 minutes
webinterface_timeout	number	The period of inactivity after which SPS terminates the web session of a user. It is measured in minutes.	Value range: 5-720 minutes Default value: 10 minutes

HTTP response codes

For more information and a complete list of standard HTTP response codes, see Application level error codes.

Privileges of usergroups

User management and access control > Privileges of usergroups

This endpoint lists the usergroups configured on SPS, and the privileges (ACLs) of each group.

Note that currently you cannot edit the privileges (ACLs) of the groups using the REST API. If you change the privileges of a usergroup on the SPS web interface, the changes will apply to the users when they authenticate again on SPS, the privileges of active sessions are not affected.

URL

GET https://<IP-address-of-SPS>/api/configuration/aaa/acls

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 local users.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/aaa/acls

Response

The following is a sample response received when querying the endpoint.

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

{
    "body": [
        {
            "group": "basic-view",
            "objects": [
                "/special/basic"
            ],
            "permission": "read"
        },
        {
            "group": "basic-write",
            "objects": [
                "/special/basic"
            ],
            "permission": "write"
        },
        {
            "group": "auth-view",
            "objects": [
                "/special/auth"
            ],
            "permission": "read"
        },
        {
            "group": "auth-write",
            "objects": [
                "/special/auth"
            ],
            "permission": "write"
        },
        {
            "group": "search",
            "objects": [
                "/special/searchmenu"
            ],
            "permission": "read"
        },
        {
            "group": "changelog",
            "objects": [
                "/special/changelog"
            ],
            "permission": "read"
        },
        {
            "group": "policies-view",
            "objects": [
                "/special/pol"
            ],
            "permission": "read"
        },
        {
            "group": "policies-write",
            "objects": [
                "/special/pol"
            ],
            "permission": "write"
        },
        {
            "group": "ssh-view",
            "objects": [
                "/special/ssh"
            ],
            "permission": "read"
        },
        {
            "group": "ssh-write",
            "objects": [
                "/special/ssh"
            ],
            "permission": "write"
        },
        {
            "group": "rdp-view",
            "objects": [
                "/special/rdp"
            ],
            "permission": "read"
        },
        {
            "group": "rdp-write",
            "objects": [
                "/special/rdp"
            ],
            "permission": "write"
        },
        {
            "group": "telnet-view",
            "objects": [
                "/special/telnet"
            ],
            "permission": "read"
        },
        {
            "group": "telnet-write",
            "objects": [
                "/special/telnet"
            ],
            "permission": "write"
        },
        {
            "group": "vnc-view",
            "objects": [
                "/special/vnc"
            ],
            "permission": "read"
        },
        {
            "group": "vnc-write",
            "objects": [
                "/special/vnc"
            ],
            "permission": "write"
        },
        {
            "group": "indexing",
            "objects": [
                "/special/search/search",
                "/special/bap"
            ],
            "permission": "write"
        },
        {
            "group": "ica-view",
            "objects": [
                "/special/ica"
            ],
            "permission": "read"
        },
        {
            "group": "ica-write",
            "objects": [
                "/special/ica"
            ],
            "permission": "write"
        },
        {
            "group": "http-view",
            "objects": [
                "/special/http"
            ],
            "permission": "read"
        },
        {
            "group": "http-write",
            "objects": [
                "/special/http"
            ],
            "permission": "write"
        },
        {
            "group": "indexer-view",
            "objects": [
                "/special/indexer"
            ],
            "permission": "read"
        },
        {
            "group": "indexer-write",
            "objects": [
                "/special/indexer"
            ],
            "permission": "write"
        },
    ],
    "key": "acls",
    "meta": {
        "first": "/api/configuration/aaa/acls",
        "href": "/api/configuration/aaa/acls",
        "last": "/api/configuration/aaa/settings",
        "next": "/api/configuration/aaa/local_database",
        "parent": "/api/configuration/aaa",
        "previous": null,
        "transaction": "/api/transaction"
    }
}

Element	Type	Description
body		Top level element (JSON object)	Contains the properties of the user.
	group	string	The name of the usergroup.
	objects	list	The list of privileges that the group has access to.
	permission	read \| write	The type of the permission. The group needs write access to configure an object, or to perform certain actions.

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.

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

One Identity Safeguard for Privileged Sessions 8.0 LTS - REST API Reference Guide

User management and access control

Detailed information about this topic

User management and access control

URL

Cookies

Sample request

Response

Status and error codes

Login settings

URL

Cookies

Operations

Sample request

Response

HTTP response codes

Privileges of usergroups

URL

Cookies

Sample request

Response

Status and error codes