Entity Tag Assignment

View as Markdown

Represents a tag assignment to an entity

GetGET /api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tags/{tag_key}ListGET /api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tagsCreatePOST /api/2.1/unity-catalog/entity-tag-assignmentsUpdatePATCH /api/2.1/unity-catalog/entity-tag-assignments/{tag_assignment.entity_type}/{tag_assignment.entity_name}/tags/{tag_assignment.tag_key}DeleteDELETE /api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tags/{tag_key}

EntityTagAssignment object

Represents a tag assignment to an entity

entity_namestring

The fully qualified name of the entity to which the tag is assigned

tag_keystring

The key of the tag

tag_valuestring

The value of the tag

entity_typestring

The type of the entity to which the tag is assigned.

update_timestring

The timestamp when the tag assignment was last updated

updated_bystring

The user or principal who updated the tag assignment

source_typestring

The source type of the tag assignment, e.g., user-assigned or system-assigned

Values: TAG_ASSIGNMENT_SOURCE_TYPE_UNSPECIFIED, TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION

View as Markdown

The EntityTagAssignment object

{
  "entity_name": "string",
  "tag_key": "string",
  "tag_value": "string",
  "entity_type": "string",
  "update_time": "string",
  "updated_by": "string",
  "source_type": "string"
}

Get

GET /api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tags/{tag_key}

Gets a tag assignment for an Unity Catalog entity by tag key.

API scopes: unity-catalog

Parameters

entity_namestringpath

The fully qualified name of the entity to which the tag is assigned

tag_keystringpath

Required. The key of the tag

entity_typestringpath

The type of the entity to which the tag is assigned.

Response

Returns the EntityTagAssignment object.

View as Markdown

Response

{
  "entity_name": "main.default.customer_data",
  "entity_type": "tables",
  "source_type": "TAG_ASSIGNMENT_SOURCE_TYPE_UNSPECIFIED",
  "tag_key": "Severity",
  "tag_value": "high",
  "update_time": "2026-01-15T10:30:00.000Z",
  "updated_by": "user@example.com"
}

List

GET /api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tags

List tag assignments for an Unity Catalog entity

PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

API scopes: unity-catalog

Parameters

entity_namestringpath

The fully qualified name of the entity to which the tag is assigned

entity_typestringpath

The type of the entity to which the tag is assigned.

max_resultsint32query

Optional. Maximum number of tag assignments to return in a single page

page_tokenstringquery

Optional. Pagination token to retrieve the next page of results

Response

Returns a list of EntityTagAssignment objects.

View as Markdown

Response

{
  "next_page_token": "eyJsYXN0X2V2YWx1YXRlZF9rZXkiOiAiT3duZXIifQ==",
  "tag_assignments": [
    {
      "entity_name": "main.default.customer_data.phone",
      "entity_type": "columns",
      "source_type": "TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION",
      "tag_key": "class.phone_number",
      "tag_value": "true",
      "update_time": "2026-01-14T08:15:00.000Z",
      "updated_by": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "entity_name": "main.default.customer_data.phone",
      "entity_type": "columns",
      "source_type": "TAG_ASSIGNMENT_SOURCE_TYPE_UNSPECIFIED",
      "tag_key": "Sensitivity",
      "tag_value": "high",
      "update_time": "2026-01-15T10:30:00.000Z",
      "updated_by": "user@example.com"
    },
    {
      "entity_name": "main.default.customer_data.phone",
      "entity_type": "columns",
      "source_type": "TAG_ASSIGNMENT_SOURCE_TYPE_UNSPECIFIED",
      "tag_key": "Owner",
      "tag_value": "data-team",
      "update_time": "2026-01-13T14:20:00.000Z",
      "updated_by": "admin@example.com"
    }
  ]
}

Create

POST /api/2.1/unity-catalog/entity-tag-assignments

Creates a tag assignment for an Unity Catalog entity.

To add tags to Unity Catalog entities, you must own the entity or have the following privileges:

• APPLY TAG on the entity
• USE SCHEMA on the entity's parent schema
• USE CATALOG on the entity's parent catalog

To add a governed tag to Unity Catalog entities, you must also have the ASSIGN or MANAGE permission on the tag policy. See Manage tag policy permissions.

API scopes: unity-catalog

Request body

tag_assignmentobject

Show child attributesHide child attributes

entity_namestring

The fully qualified name of the entity to which the tag is assigned

tag_keystring

The key of the tag

tag_valuestring

The value of the tag

entity_typestring

The type of the entity to which the tag is assigned.

update_timestring

The timestamp when the tag assignment was last updated

updated_bystring

The user or principal who updated the tag assignment

source_typestring

The source type of the tag assignment, e.g., user-assigned or system-assigned

Values: TAG_ASSIGNMENT_SOURCE_TYPE_UNSPECIFIED, TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION

Response

Returns the EntityTagAssignment object.

View as Markdown

Request

{
  "entity_name": "main.default.customer_data",
  "entity_type": "tables",
  "tag_key": "Severity",
  "tag_value": "high"
}

Response

{
  "entity_name": "main.default.customer_data",
  "entity_type": "tables",
  "source_type": "TAG_ASSIGNMENT_SOURCE_TYPE_UNSPECIFIED",
  "tag_key": "Severity",
  "tag_value": "high",
  "update_time": "2026-01-15T10:30:00.000Z",
  "updated_by": "user@example.com"
}

Update

PATCH /api/2.1/unity-catalog/entity-tag-assignments/{tag_assignment.entity_type}/{tag_assignment.entity_name}/tags/{tag_assignment.tag_key}

Updates an existing tag assignment for an Unity Catalog entity.

To update tags to Unity Catalog entities, you must own the entity or have the following privileges:

• APPLY TAG on the entity
• USE SCHEMA on the entity's parent schema
• USE CATALOG on the entity's parent catalog

To update a governed tag to Unity Catalog entities, you must also have the ASSIGN or MANAGE permission on the tag policy. See Manage tag policy permissions.

API scopes: unity-catalog

Parameters

tag_assignmentobjectpath

Show child attributesHide child attributes

entity_namestring

The fully qualified name of the entity to which the tag is assigned

tag_keystring

The key of the tag

tag_valuestring

The value of the tag

entity_typestring

The type of the entity to which the tag is assigned.

update_timestring

The timestamp when the tag assignment was last updated

updated_bystring

The user or principal who updated the tag assignment

source_typestring

The source type of the tag assignment, e.g., user-assigned or system-assigned

Values: TAG_ASSIGNMENT_SOURCE_TYPE_UNSPECIFIED, TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION

update_maskstringquery

Response

Returns the EntityTagAssignment object.

View as Markdown

Request

{
  "entity_name": "main.default.customer_data",
  "entity_type": "tables",
  "tag_key": "Severity",
  "tag_value": "medium"
}

Response

{
  "entity_name": "main.default.customer_data",
  "entity_type": "tables",
  "source_type": "TAG_ASSIGNMENT_SOURCE_TYPE_UNSPECIFIED",
  "tag_key": "Severity",
  "tag_value": "medium",
  "update_time": "2026-01-15T11:45:00.000Z",
  "updated_by": "user@example.com"
}

Delete

DELETE /api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tags/{tag_key}

Deletes a tag assignment for an Unity Catalog entity by its key.

To delete tags from Unity Catalog entities, you must own the entity or have the following privileges:

• APPLY TAG on the entity
• USE_SCHEMA on the entity's parent schema
• USE_CATALOG on the entity's parent catalog

To delete a governed tag from Unity Catalog entities, you must also have the ASSIGN or MANAGE permission on the tag policy. See Manage tag policy permissions.

API scopes: unity-catalog

Parameters

entity_namestringpath

The fully qualified name of the entity to which the tag is assigned

tag_keystringpath

Required. The key of the tag to delete

entity_typestringpath

The type of the entity to which the tag is assigned.

View as Markdown

Response

{}