Enabling An Address Via A Change

Basic Description

This endpoint is used to enable a previously disabled Address in Taurus-PROTECT. Enabling a previously disabled address in Taurus-PROTECT means that the Address can be used once again for spending the funds held within the Address. To understand what a Address is and how to use it, please refer to the following page in the Taurus User Guides.

This endpoint would accept a POST request with a JSON payload containing the Change details that needs to be created in order to enable the Address once again. The entity, entityId , action, and changes containing the rulevalue are the four required parameters that must be included within the JSON payload. Please take a closer look to the cURL example below in this page.

❗️

Enabling a previously disabled Address in Taurus-PROTECT

When a previously disabled Address is enabled in Taurus-PROTECT, it means that the Address can now be used once again within Taurus-PROTECT to spend its funds.

Prerequisites

Required Roles

Certain API endpoints require that the user has a specific role in order to access them. Roles are used to restrict access to certain functionality within the system and ensure that only authorized users are able to perform specific actions.

Here is the list of required Roles for this particular endpoint:

• Admin
• TPUser

To find out more about roles, please refer to the following page in the Taurus User Guides.

Required Input Parameters

Certain API endpoints require specific input parameters. Here is the list of Required Input Parameters for this particular endpoint:

• entityId: The ID of the previously created Business Rule that deactivated the relevant address n Taurus-PROTECT.

📘

Preconditions

It is important to note that the selected Address needs to be already disabled in Taurus-PROTECT. If not, the request will eventually result in an error.

Call Example

You can find a basic example in cURL below.
Please note that you will need to update the BASEURL and the APITOKEN for the command to function.

export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/changes" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken" \
--data '{
   "entity":"businessrule",
   "entityId":"12",
   "action":"update",
   "changes":{
      "rulevalue":"1"
   }
}
'

This piece of code sends a POST request to https://your-protect-instance.example.com/api/rest/v1/changes with the JSON string in the request body.

👍

Call Result

A successful response for the POST call to enable a previously disabled address might look like this:

{
    "result": {
        "id": "4602"
    }
}

In this example, Taurus-PROTECT has created a new Change to enable the Address behind the Business Rule with 12 as entityId. Taurus-PROTECT responds with a JSON object containing the newly assigned Change ID. Please note that this Change then needs to be signed by an Admin for the enabling process to be finalized.

Requirements for Future Use

For this particular endpoint, we do not have any storage requirements other than the newly created Changeid that is included in the JSON Body Response.

You can find the Swagger-generated page for this endpoint in the following link.