# Manage Frameworks

The frameworks resource allows you to create and manage classification frameworks. System-created frameworks cannot be edited, so [create a clone](#post-frameworksframeworkidclone) to make any adjustments.

## Endpoints

<table><thead><tr><th>Method</th><th width="434">Endpoint</th><th>Description</th></tr></thead><tbody><tr><td><strong>GET</strong></td><td><a href="#get-frameworks"><mark style="color:blue;"><code>/frameworks</code></mark></a></td><td>Gets all the frameworks</td></tr><tr><td><strong>POST</strong></td><td><a href="#post-frameworks"><mark style="color:blue;"><code>/frameworks</code></mark></a></td><td>Creates a new framework</td></tr><tr><td><strong>DELETE</strong></td><td><a href="#delete-frameworksframeworkid"><mark style="color:blue;"><code>/frameworks/{frameworkId}</code></mark></a></td><td>Deletes a framework</td></tr><tr><td><strong>GET</strong></td><td><a href="#get-frameworksframeworkid"><mark style="color:blue;"><code>/frameworks/{frameworkId}</code></mark></a></td><td>Gets the framework with the given framework ID</td></tr><tr><td><strong>PUT</strong></td><td><a href="#put-frameworksframeworkid"><mark style="color:blue;"><code>/frameworks/{frameworkId}</code></mark></a></td><td>Updates a framework</td></tr><tr><td><strong>POST</strong></td><td><a href="#post-frameworksframeworkidclone"><mark style="color:blue;"><code>/frameworks/{frameworkId}/clone</code></mark></a></td><td>Clones a framework</td></tr><tr><td><strong>GET</strong></td><td><a href="#get-frameworksframeworkidversions"><mark style="color:blue;"><code>/frameworks/{frameworkId}/versions</code></mark></a></td><td>Gets all versions of the framework with the given framework ID</td></tr></tbody></table>

## <mark style="color:green;">`GET`</mark> `/frameworks`

Get all the frameworks in Immuta.

**Required Immuta permission**: `GOVERNANCE`

```bash
curl -X 'GET' \
    'https://www.organization.immuta.com/frameworks' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 846e9e43c86a4ct1be14290d95127d13f'
```

### Response

The response returns all the frameworks in Immuta. See the [framework reference section](#framework-reference) for details about the response schema.

## <mark style="color:green;">`POST`</mark> `/frameworks`

Create a new framework. This example creates a framework that will tag all columns in a data source with the tag "HR Framework . Internal Employee Data" when a single column within the data source has the tag "Employee Name". Then [subscription and data policies](/latest/developer-guides/api-intro/immuta-v1-api/manage-data-access/policy.md) can be built to only allow HR to access this sensitive employee data.

**Required Immuta permission**: `GOVERNANCE`

{% hint style="info" %}
**Rule limit**

Frameworks can have a maximum of 50 rules.
{% endhint %}

```bash
curl -X 'POST' \
    'https://www.organization.immuta.com/frameworks' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "active": true,
    "shortName": "HR Information",
    "name": "HR Information Framework",
    "description": "This framework finds internal employee information and tags it for HR.",
    "tags": [
    {
      "name": "HR Framework.Internal Employee Data",
      "source": "curated",
      "sensitivities": []
    }],
    "rules": [
    { "name": "HR Rule 1",
      "classificationTag": {
        "name": "HR Framework.Internal Employee Data",
        "source": "curated"
      },
      "columnTags": [],
      "neighborColumnTags": [
        {
        "name": "Employee Name",
        "source": "curated"
        }
      ],
      "tableTags": []
      }
    ]}'
```

### Body parameters

The request accepts a JSON or YAML payload. See the [framework payload description](#framework-payload) for parameter details.

### Response

The response returns the framework that was created. See the [framework reference section](#framework-reference) for details about the response schema.

```json
{
  "id": "9a6bf3b1-823c-4b2e-aef9-570dac6793cc",
  "version": "4e823e0b-8e38-455d-b23c-1f03200d203a",
  "shortName": "HR Information",
  "name": "HR Information Framework",
  "description": "This framework finds internal employee information and tags it for HR.",
  "createdBy": 2,
  "createdAt": "2023-10-19T16:14:39.109Z",
  "tags": [
    {
      "name": "HR Framework.Internal Employee Data",
      "source": "curated",
      "sensitivities": []
    }
  ],
  "rules": [
    {  "name": "HR Rule 1",
      "classificationTag": {
        "name": "HR Framework.Internal Employee Data",
        "source": "curated"
      },
      "columnTags": [],
      "neighborColumnTags": [
        {
          "name": "Employee Name",
          "source": "curated"
        }
      ],
      "tableTags": []
    }
  ],
  "active": true
}
```

## <mark style="color:green;">`DELETE`</mark> `/frameworks/{frameworkId}`

Deletes the framework you specify in the request.

**Required Immuta permission**: `GOVERNANCE`

```bash
curl -X 'DELETE' \
    'https://www.organization.immuta.com/frameworks/123456' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 846e9e43c86a4ct1be14290d95127d13f'
```

### Request parameter

| Parameter       | Description                             | Required or optional |
| --------------- | --------------------------------------- | -------------------- |
| **id** `number` | The unique identifier of the framework. | Required             |

### Response

The response returns a `204` response code if the request was successful.

## <mark style="color:green;">`GET`</mark> `/frameworks/{frameworkId}`

Gets the framework you specify in the request.

**Required Immuta permission**: `GOVERNANCE`

```bash
curl -X 'GET' \
    'https://www.organization.immuta.com/frameworks/123456' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 846e9e43c86a4ct1be14290d95127d13f'
```

### Request parameter

| Parameter       | Description                             | Required or optional |
| --------------- | --------------------------------------- | -------------------- |
| **id** `number` | The unique identifier of the framework. | Required             |

### Response

The response returns the framework specified in the request. See the [framework reference section](#framework-reference) for details about the response schema.

## <mark style="color:green;">`PUT`</mark> `/frameworks/{frameworkId}`

Update a framework. This example updates a framework to be inactive.

**Required Immuta permission**: `GOVERNANCE`

```bash
curl -X 'PUT' \
    'https://www.organization.immuta.com/frameworks/123456' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 846e9e43c86a4ct1be14290d95127d13f' \
    -d '{
    "active": false
    }'
```

### Request parameter

| Parameter       | Description                             | Required or optional |
| --------------- | --------------------------------------- | -------------------- |
| **id** `number` | The unique identifier of the framework. | Required             |

### Body parameters

The request accepts a JSON or YAML payload. See the [framework payload description](#framework-payload) for parameter options; partial updates are supported.

### Response

The response returns the framework that was updated. See the [framework reference section](#framework-reference) for details about the response schema.

```json
{
  "id": "123456",
  "version": "4e823e0b-8e38-455d-b23c-1f03200d203a",
  "shortName": "HR Information",
  "name": "HR Information Framework",
  "description": "This framework finds internal employee information and tags it for HR.",
  "createdBy": 2,
  "createdAt": "2023-10-19T16:14:39.109Z",
  "tags": [
    {
      "name": "HR Framework.Internal Employee Data",
      "source": "curated",
      "sensitivities": []
    }
  ],
  "rules": [
    { "name": "HR Rule 1",
      "classificationTag": {
        "name": "HR Framework.Internal Employee Data",
        "source": "curated"
      },
      "columnTags": [],
      "neighborColumnTags": [
        {
          "name": "Employee Name",
          "source": "curated"
        }
      ],
      "tableTags": []
    }
  ],
  "active": false
}
```

## <mark style="color:green;">`POST`</mark> `/frameworks/{frameworkId}/clone`

Clone a framework from an existing framework.

**Required Immuta permission**: `GOVERNANCE`

```bash
curl -X 'POST' \
    'https://www.organization.immuta.com/frameworks/123456/clone' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 846e9e43c86a4ct1be14290d95127d13f'
```

### Request parameter

| Parameter       | Description                             | Required or optional |
| --------------- | --------------------------------------- | -------------------- |
| **id** `number` | The unique identifier of the framework. | Required             |

### Response

The response returns the framework that was created as a clone. See the [framework reference section](#framework-reference) for details about the response schema.

```json
{
  "id": "123456",
  "version": "4e823e0b-8e38-455d-b23c-1f03200d203a",
  "shortName": "HR Information",
  "name": "HR Information Framework",
  "description": "This framework finds internal employee information and tags it for HR.",
  "createdBy": 2,
  "createdAt": "2023-10-19T16:14:39.109Z",
  "tags": [
    {
      "name": "HR Framework.Internal Employee Data",
      "source": "curated",
      "sensitivities": []
    }
  ],
  "rules": [
    { "name": "HR Rule 1",
      "classificationTag": {
        "name": "HR Framework.Internal Employee Data",
        "source": "curated"
      },
      "columnTags": [],
      "neighborColumnTags": [
        {
          "name": "Employee Name",
          "source": "curated"
        }
      ],
      "tableTags": []
    }
  ],
  "active": false
}
```

## <mark style="color:green;">`GET`</mark> `/frameworks/{frameworkId}/versions`

Gets every version of the framework you specify in the request.

**Required Immuta permission**: `GOVERNANCE`

```bash
curl -X 'GET' \
    'https://www.organization.immuta.com/frameworks/123456/versions' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 846e9e43c86a4ct1be14290d95127d13f'
```

### Request parameter

| Parameter       | Description                             | Required or optional |
| --------------- | --------------------------------------- | -------------------- |
| **id** `number` | The unique identifier of the framework. | Required             |

### Response

The response returns a copy of every version of the framework specified in the request. See the [framework reference section](#framework-reference) for details about the response schema.

## Framework payload

The framework payload is used when creating or updating a framework. See the parameters below.

| Parameter                | Description                                                                                                                                                                           | Required or optional | Default values | Accepted values                                                |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | -------------- | -------------------------------------------------------------- |
| **shortName** `string`   | The short, human-readable name for the framework.                                                                                                                                     | Required             | -              | -                                                              |
| **name** `string`        | The official, human-readable name for the framework.                                                                                                                                  | Required             | -              | -                                                              |
| **description** `string` | A description of the framework.                                                                                                                                                       | Required             | -              | -                                                              |
| **tags** `array[]`       | The tags used in the framework and the sensitivity attached to them. Each tag used must have a tags object. See the **tags** [object description](#tags-object) for child parameters. | Required             | -              | -                                                              |
| **rules** `array[]`      | The rules used to apply the tags in the framework. See the **rules** [object description](#rules-object) for child parameters.                                                        | Required             | -              | -                                                              |
| **active** `boolean`     | When `true`, the framework will be actively used on data sources in Immuta.                                                                                                           | Required             | -              | <ul><li><code>true</code></li><li><code>false</code></li></ul> |

### Tags object

The **tags** object specifies the tags created for and used in the framework. It includes metadata for the tags, like sensitivity and descriptions. The table below outlines its child parameters.

| Parameter                               | Description                                                                                        | Required or optional                 | Default values | Accepted values                                                                                                                                                                                          |
| --------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **name** `string`                       | The fully rendered name of the tag, including any parent tags.                                     | Required                             | -              | -                                                                                                                                                                                                        |
| **source** `string`                     | The catalog the tag is from. `curated` is any tag in Immuta.                                       | Required                             | -              | <ul><li><code>curated</code></li><li>The external catalog ID</li></ul>                                                                                                                                   |
| **sensitivities** `object`              | The sensitivity assigned to the tag. This sensitivity can drive the audit dashboards and monitors. | Optional                             | `[]`           | -                                                                                                                                                                                                        |
| sensitivities.**dimension** `string`    | The type of sensitivity assigned to the tag.                                                       | Required if adding **sensitivities** | -              | `confidentiality`                                                                                                                                                                                        |
| sensitivities.**sensitivity** `integer` | The sensitivity assigned to the tag.                                                               | Required if adding **sensitivities** | -              | <ul><li><code>0</code> - This tag signifies non-sensitive data.</li><li><code>1</code> - This tag signifies sensitive data.</li><li><code>2</code> - This tag signifies highly-sensitive data.</li></ul> |

### Rules object

The **rules** object specifies the rules used in the framework. The table below outlines its child parameters.

| Parameter                              | Description                                                                                                                                                         | Required or optional                              | Default values | Accepted values                                                        |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -------------- | ---------------------------------------------------------------------- |
| **name** `string`                      | The short, human-readable name for the rule.                                                                                                                        | Required                                          | -              | -                                                                      |
| **classificationTag** `object`         | The tag to apply to the data source based on the criteria.                                                                                                          | Required                                          | -              | -                                                                      |
| classificationTag.**name** `string`    | The name of the tag to apply.                                                                                                                                       | Required                                          | -              | -                                                                      |
| classificationTag.**source** `string`  | The catalog the tag is from. `curated` is any tag created in Immuta.                                                                                                | Required                                          | -              | <ul><li><code>curated</code></li><li>The external catalog ID</li></ul> |
| **columnTags** `object`                | The criteria for applying tags. Tags will be applied to a column when these tags are found on the same column.                                                      | Optional                                          | `[]`           | -                                                                      |
| columnTags.**name** `string`           | The name of the column tag. When matched, the classification tag will be applied to the same column.                                                                | Required if using **columnTags** criteria         | -              | -                                                                      |
| columnTags.**source** `string`         | The catalog the column tag is from. `curated` is any tag in Immuta.                                                                                                 | Required if using **columnTags** criteria         | -              | <ul><li><code>curated</code></li><li>The external catalog ID</li></ul> |
| **neighborColumnTags** `object`        | The criteria for applying tags. Tags will be applied to all columns within a data source if this tag is found already applied to any column within the data source. | Optional                                          | `[]`           | -                                                                      |
| neighborColumnTags.**name** `string`   | The name of the neighboring column tag. When matched, the classification tag will be applied to all columns within that data source.                                | Required if using **neighborColumnTags** criteria | -              | -                                                                      |
| neighborColumnTags.**source** `string` | The catalog the neighboring column tag is from. `curated` is any tag in Immuta.                                                                                     | Required if using **neighborColumnTags** criteria | -              | <ul><li><code>curated</code></li><li>The external catalog ID</li></ul> |
| **tableTags** `object`                 | The criteria for applying tags. Tags will be applied to all columns in a data source when this tag is found applied to the data source.                             | Optional                                          | `[]`           | -                                                                      |
| tableTags.**name** `string`            | The name of the data source tag. When matched, the classification tag will be applied to all columns within that data source.                                       | Required if using **tableTags** criteria          | -              | -                                                                      |
| tableTags.**source** `string`          | The catalog the data source tag is from. `curated` is any tag in Immuta.                                                                                            | Required if using **tableTags** criteria          | -              | <ul><li><code>curated</code></li><li>The external catalog ID</li></ul> |

## Framework reference

The framework reference is the response for many `/frameworks` requests. See the parameters described below.

| Parameter                 | Description                                                                                                                                    |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** `string`           | The Immuta-assigned unique ID for the framework.                                                                                               |
| **version** `string`      | The Immuta-assigned unique ID for the version of this framework. This can be useful when auditing the changes to frameworks.                   |
| **shortName** `string`    | The short, human-readable name for the framework.                                                                                              |
| **name** `string`         | The official, human-readable name for the framework.                                                                                           |
| **description** `string`  | A description of the framework.                                                                                                                |
| **createdBy** `integer`   | The unique ID of the user who created the framework.                                                                                           |
| **createdAt** `timestamp` | A timestamp of when the framework was created.                                                                                                 |
| **tags** `array[]`        | The tags used in the framework and the sensitivity attached to them. See the **tags** [object description](#tags-object) for child parameters. |
| **rules** `array[]`       | The rules used to apply the tags in the framework. See the **rules** [object description](#rules-object) for child parameters.                 |
| **active** `boolean`      | If `true`, the framework is actively being used on data sources in Immuta.                                                                     |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.immuta.com/latest/developer-guides/api-intro/immuta-v1-api/configure-your-instance-of-immuta/frameworks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.