Safeguard for Privileged Sessions On Demand Hosted

Configures debug logging and the retention time of core dump files.

Debug logging increases the log level of the non-network-related events, adding the commands executed by the SPS web interface to the log.
SPS automatically generates core dump files if an important software component of the system crashes. These core dump files can be of great help to the One Identity Support Team to identify problems. To download the generated core dump files, navigate to Basic Settings > Troubleshooting > Core files on the web interface of SPS.

URL

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

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 details 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 queries the troubleshooting settings.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/troubleshooting

Response

The following is a sample response received.

For details of the meta object, see Message format.

{
  "body": {
    "core_files": {
      "retention_days": 14
    },
    "debug_logging": {
      "enabled": true
    }
  },
  "key": "troubleshooting",
  "meta": {
    "first": "/api/configuration/aaa",
    "href": "/api/configuration/troubleshooting",
    "last": "/api/configuration/x509",
    "next": "/api/configuration/vnc",
    "parent": "/api/configuration",
    "previous": "/api/configuration/telnet",
    "transaction": "/api/transaction"
  }
}

Element			Type	Description
key			string	Top level element, contains the ID of the endpoint.
body			Top level element (string)	Contains the troubleshooting settings.
	core_files		Top level item	Contains the settings for core dump file retention.
		retention_days	int	Retention time for core files, in days.
	debug_logging		Top level item	Settings for debug logging.
		enabled	boolean	Set to true to increase the log level of the non-network-related events, adding the commands executed by the SPS web interface to the log.

Modify troubleshooting settings

To modify troubleshooting settings, you have to:

Open a transaction.

For more information, see Open a transaction.
Modify the JSON object of the troubleshooting options.

PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/troubleshooting endpoint. You can find a detailed description of the available parameters listed in Element .
Commit your changes.

For more information, see Commit a transaction.

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

Internal certificates

This endpoint references the certificates of SPS's internal Certificate Authority, Timestamping Authority, and the SSL certificate of the web and REST interface.

URL

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

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 details 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 internal certificates of SPS.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/certificates

Response

The following is a sample response received when listing the internal certificates of SPS.

For details of the meta object, see Message format.

{
  "body": {
    "ca": {
      "selection": "identity",
      "x509_identity": {
        "key": "fbd684e1-e1ac-4f34-ad25-86c560c51e24",
        "meta": {
          "href": "/api/configuration/x509/fbd684e1-e1ac-4f34-ad25-86c560c51e24"
        }
      }
    },
    "server": {
      "key": "fd1c73e8-bcb8-4d13-991f-722f492dc074",
      "meta": {
        "href": "/api/configuration/x509/fd1c73e8-bcb8-4d13-991f-722f492dc074"
      }
    },
    "tsa": {
      "key": "20e72ede-78ef-460a-b843-68a35d994142",
      "meta": {
        "href": "/api/configuration/x509/20e72ede-78ef-460a-b843-68a35d994142"
      }
    }
  },
  "key": "certificates",
  "meta": {
    "first": "/api/configuration/management/certificates",
    "href": "/api/configuration/management/certificates",
    "last": "/api/configuration/management/webinterface",
    "next": "/api/configuration/management/disk_fillup_prevention",
    "parent": "/api/configuration/management",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

Element			Type	Description
key			string	The ID of the endpoint.
body			Top level element (string)	Contains the internal certificates of SPS.
	ca		Top level item	Contains the certificate of SPS's internal Certificate Authority.
		selection	string	Must be set to identity.
		x509_identity	string	References the certificate of SPS's internal Certificate Authority. You can configure certificates at the /api/configuration/x509/ endpoint. To modify or add an X.509 certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key). For details, see Certificates stored on SPS.
	server		string	References the SSL certificate of SPS's web interface. You can configure certificates at the /api/configuration/x509/ endpoint. To modify or add an X.509 certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key). For details, see Certificates stored on SPS.
	tsa		string	References the certificate of SPS's internal Timestamping Authority. You can configure certificates at the /api/configuration/x509/ endpoint. To modify or add an X.509 certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key). For details, see Certificates stored on SPS.

Modify a certificate

To modify a certificate, you have to:

Open a transaction.

For more information, see Open a transaction.
Create a CA

Have the value of the key element of a valid X.509 CA certificate stored on SPS.
Modify the JSON object of the endpoint.

Use the X.509 certificate's key as the value of the ca element. You can find a detailed description of the available parameters listed in Element . PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/management/certificates endpoint.
Commit your changes.

For more information, see Commit a transaction.

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

Passwords stored on SPS

To create a new password, you have to POST the password or its hash as a JSON object to the https://<IP-address-of-SPS>/api/passwords endpoint. For details, see Create a new object. The body of the POST request must contain a JSON object with the parameters listed in Password parameters. The response to a successful POST message is a JSON object that includes the reference ID of the created password in its key attribute. You can reference this ID in other parts of the configuration, for example, to set the password of a user account. Note that you can use a password object for only one purpose, that is, you cannot reference a password object twice.

URL

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

Note that the GET method is not permitted on this endpoint, you cannot list the existing passwords. However, if you know the reference ID of a password, you can display its properties:
```
GET https://<IP-address-of-SPS>/api/configuration/passwords/<reference-ID-of-the-password;>
```
You cannot directly delete or modify a password, the DELETE and PUT methods are not permitted on password objects. To update a password, create a new one, then update the object that uses the old password to reference the new password.

Table 3: Headers
Header name	Description	Required	Values
Content-Type	Specifies the type of the data sent. SPS uses the JSON format	Required	application/json
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 SPS REST API.

Sample request

The following command creates a new password object.

curl -X POST -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-SPS>/api/configuration/passwords --data '{"plain": "newpassword"}'

If you do not want to include the actual password in the request, the SHA-256 hash of the password is enough:

curl -X POST -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-SPS>/api/configuration/passwords --data '{"hash": "$6$rounds=5000$If20/EFyQ4dW3dg/$xrECLfXgZlC2Xr1s257E2aZen42fM7R.sOGG9pkPy1x5ORTx6j03oPWexVlB3f5wnaZOQCBF.NjlDgyg2WEe./"}'

Table 4: Password parameters
Element	Type	Description
hash	string	Must contain the SHA-256 hash of the password to be created, for example, "hash": "ddec437eeb1da25a146a24c432d1165bc646daa7fecc6aa14c636265c83caa14".
nthash	string	Optional. Contains the NT-HASH of the password to be created, for example, "nthash": "2c01a73ad9e597f6eab0d072ed74616c"
plain	string	Contains the password in plain-text format, for example, "plain": "mypassword".

When choosing the format of your password, the request must contain one of these formats:

The password format is only in plain-text
The password format is only a hash
The password format is only a nthash
The password format can be both a hash and a nthash.

Response

The response to a successful POST message is a JSON object that includes the reference ID of the created password in its key attribute.

For details of the meta object, see Message format.

{
    "key": "faa96916-c85e-46ff-8697-f4cc5e596e7f",
    "meta": {
        "href": "/api/configuration/passwords/faa96916-c85e-46ff-8697-f4cc5e596e7f",
        "parent": "/api/configuration/passwords",
        "transaction": "/api/transaction"
    }
}

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
201	Created	The new resource was successfully created.
400	InvalidQuery	The requested filter or its value is invalid.
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.
405	MethodNotAllowed	The method <method> is not allowed for this node.

Modify or delete password

You cannot directly delete or modify a password, the DELETE and PUT methods are not permitted on password objects. To update a password, create a new one, then update the object that uses the old password to reference the new password. After you commit the transaction, SPS will automatically delete the old password. For details, see Change the admin password.

Change the admin password

To change the password of the admin user, complete the following steps.

Open a transaction.

For more information, see Open a transaction.
Create a new password object

POST a JSON object containing the password or the hash of the password to the https://<IP-address-of-SPS>/api/passwords endpoint. For details, see Password parameters. For example:
```
curl -X POST -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-SPS>/api/configuration/passwords --data '{"plain": "mypassword"}'
```
If the operation is successful, the response includes a reference key to the new password object.
Reference the key of the password in the user configuration.

Modify the JSON object of the user to reference the key of the new password object, and PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/aaa/local_database/users/<key-of-the-user> endpoint. For example:
```
curl -X PUT -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-SPS>/api/configuration/aaa/local_database/users/14322374245a7de542bbb04 --data '{"name": "admin", "password": "<key-of-the-new-password>"}'
```
Commit your changes.

For more information, see Commit a transaction.

Change the root password

To change the password of the root user, complete the following steps.

Open a transaction.

For more information, see Open a transaction.
Create a new password object

POST a JSON object containing the password or the hash of the password to the https://<IP-address-of-SPS>/api/passwords endpoint. For details, see Password parameters. For example:
```
curl -X POST -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-SPS>/api/configuration/passwords --data '{"plain": "mypassword"}'
```
If the operation is successful, the response includes a reference key to the new password object.
Configure SPS to use this password for the root user configuration.

PUT the reference key of the new password object to the https://<IP-address-of-SPS>/api/configuration/management/root_password endpoint. For example:
```
curl -X PUT -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/root_password --data '"<key-of-the-new-password>"'
```
Note that you must PUT the reference key as a JSON string, enclosed in double-quotes.
Alternatively, instead of performing the previous two steps, you can replace an existing password in a single step, PUT the following JSON object to the https://<IP-address-of-SPS>/api/configuration/management/root_password endpoint:
```
{
    "plain": "new_password"
}
```
Commit your changes.

For more information, see Commit a transaction.

Change the user password

Logged in users can change their own passwords by completing the following steps.

Open a transaction.

For more information, see Open a transaction.
Create a new password object

POST a JSON object containing the password or the hash of the password to the https://<IP-address-of-SPS>/api/passwords endpoint. For details, see Password parameters. For example:
```
curl -X POST -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-SPS>/api/configuration/passwords --data '{"plain": "mypassword"}'
```
If the operation is successful, the response includes a reference key to the new password object.

Change the password of the user.

PUT a JSON object that includes the current password in plain text and the key of the new password object to the https://<IP-address-of-SPS>/api/user/password endpoint. For example:

curl -X PUT -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-SPS>/api/user/password --data '{"current_password_in_plaintext": "<old-password>", "new_password_reference": "<key-of-the-new-password>"}'

Alternatively, instead of performing the previous two steps, you can replace an existing password in a single step, PUT the following JSON object to the https://<IP-address-of-SPS>/api/configuration/management/root_password endpoint:
```
{
    "current_password_in_plaintext": "<current_password_in_plaintext>",
    "new_password_reference": {
        "plain": "newpassword"
    }
}
```
Commit your changes.

For more information, see Commit a transaction.

製品を選択してください:

サービス向上のために、「Purpose of your Chat（チャットの目的）」を記入してください。

お客様の不具合に推奨されるソリューション

Safeguard for Privileged Sessions On Demand Hosted - REST API Reference Guide

Managing SPS

Topics:

Troubleshooting options

URL

Cookies

Sample request

Response

Modify troubleshooting settings

Open a transaction.

Modify the JSON object of the troubleshooting options.

Commit your changes.

Status and error codes

Internal certificates

URL

Cookies

Sample request

Response

Modify a certificate

Open a transaction.

Create a CA

Modify the JSON object of the endpoint.

Commit your changes.

Status and error codes

Passwords stored on SPS

URL

Sample request

Response

Status and error codes

Modify or delete password

Change the admin password

Open a transaction.

Create a new password object

Reference the key of the password in the user configuration.

Commit your changes.

Change the root password

Open a transaction.

Create a new password object

Configure SPS to use this password for the root user configuration.

Commit your changes.

Change the user password

Open a transaction.

Create a new password object

Change the password of the user.

Commit your changes.