One Identity Safeguard for Privileged Sessions 7.3 - REST API Reference Guide

To create a new password, POST a JSON object containing the password or the hash of the password to the https://<IP-address-of-SPS>/api/configuration/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.

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.

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 plaintext password in the request, include the salted password hash:

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./"}'

For more information on the hash format, see CRYPT(5).

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 more information on 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.

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.

1. Open a transaction

   For more information, see Open a transaction.

2. 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/configuration/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.

3. 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>"}'

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

1. Open a transaction

   For more information, see Open a transaction.

2. 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/configuration/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.

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

4. 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"
   }

5. Commit your changes

   For more information, see Commit a transaction.

Change the user password

After logging in, you can change your password by completing the following steps.

1. Open a transaction

   For more information, see Open a transaction.

2. Select either of the following options:

   • Create a new password object and after that change the password of the user.

     To create a new password object:

     To create a new password, POST a JSON object containing the password or the hash of the password to the https://<IP-address-of-SPS>/api/configuration/passwords endpoint.

     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.

     To 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>"}'

   • 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"
     								}
     						}

3. Commit your changes

   For more information, see Commit a transaction.