Activate a Detect Framework

Required:

• Collaborate with your Immuta representative to turn on Classification.
• Immuta permission: GOVERNOR

To activate a framework using the Immuta API:

1. Make the following request to retrieve your instance's frameworks:

   curl -X 'GET' \
   'https://<your-immuta-url>.com/frameworks' \
   -H 'Authorization: <your_token>'
   

   A successful request will have the code 200 and a body of the frameworks in your Immuta instance:

   {
   "frameworks": [
       {
       "id": "9bd62bdc-b667-4ff2-8a78-c9b1219ef5d7",
       "version": "b5e97359-a3da-4647-a437-4fb8c9668d5f",
       "shortName": "Immuta DSF",
       "name": "Immuta Data Security Framework",
       "description": "Seeded by Immuta. Carefully curated by Immuta for broad alignment with best current practice in
           data security, governance and compliance.",
       "createdBy": 1,
       "createdAt": "2023-01-18T20:08:28.157Z",
       "tags": [<list of tags>
       ],
       "active": true
       }
   ]
   }
   

2. Note the id value for the framework you want to turn on.

3. Activate the framework by running the following request with the active value set to true:

   curl -X 'PUT' \
   'https://<your-immuta-url>.com/frameworks/<framework_id>' \
   -H 'Content-Type: application/json' \
   -H 'Authorization: <your_token>' \
   -d '{
   "active": true
   }'
   

   A successful request will have the code 200 and a body with the framework activated from the request.