Admin - InformationProtection RemoveLabelsAsAdmin

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Remove sensitivity labels from Power BI items (such as reports or dashboards) by item ID.

For a usage example, see Set or remove sensitivity labels.

Permissions

The user must be a Fabric administrator.
The admin user must have sufficient usage rights to delete labels.

Required Scope

Tenant.ReadWrite.All

Limitations

Maximum 25 requests per hour.
Each request can update up to 2,000 Power BI items.

POST https://api.powerbi.com/v1.0/myorg/admin/informationprotection/removeLabels

Request Body

Name	Type	Description
dashboards	ArtifactId[]	A list of unique dashboard IDs
dataflows	ArtifactId[]	A list of unique dataflow IDs
datasets	ArtifactStringId[]	A list of unique dataset IDs
reports	ArtifactId[]	A list of unique report IDs

Responses

Name	Type	Description
200 OK	InformationProtectionChangeLabelResponse	OK

Examples

Example

Sample request

POST https://api.powerbi.com/v1.0/myorg/admin/informationprotection/removeLabels

Request Body

{
  "dashboards": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a"
    },
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b"
    }
  ],
  "reports": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c"
    }
  ],
  "datasets": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542e"
    },
    {
      "id": "myDatabaseName"
    }
  ],
  "dataflows": [
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8g"
    }
  ]
}

Sample response

Status code:: 200

{
  "dashboards": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542a",
      "status": "NotFound"
    },
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8b",
      "status": "Failed"
    }
  ],
  "reports": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542c",
      "status": "Succeeded"
    }
  ],
  "datasets": [
    {
      "id": "fe472f5e-636e-4c10-a1c6-7e9edc0b542e",
      "status": "InsufficientUsageRights"
    },
    {
      "id": "myDatabaseName",
      "status": "FailedToGetUsageRights"
    }
  ],
  "dataflows": [
    {
      "id": "476fcafe-b514-495d-b13f-ca9a4f0b1d8g",
      "status": "Succeeded"
    }
  ]
}

Definitions

Name	Description
ArtifactId	The unique ID of a Power BI item in UUID format. Dashboard, report, and dataflow IDs are in UUID format, and dataset IDs can be in UUID or string format.
ArtifactStringId	The unique ID of a Power BI item in string or UUID format. Dashboard, report, and dataflow IDs are in UUID format, and dataset IDs can be in UUID or string format.
ChangeLabelStatus	The unique ID and information protection label change status of a Power BI item
InformationProtectionArtifactsChangeLabel	A composite of Power BI item IDs for each item type. The IDs specify which Power BI items require an information protection label update.
InformationProtectionChangeLabelResponse	A composite of the ID and information protection label change status for one or more Power BI items organized by type
status	The status of an information protection label change operation

ArtifactId

The unique ID of a Power BI item in UUID format. Dashboard, report, and dataflow IDs are in UUID format, and dataset IDs can be in UUID or string format.

Name	Type	Description
id	string	An ID in UUID format

ArtifactStringId

The unique ID of a Power BI item in string or UUID format. Dashboard, report, and dataflow IDs are in UUID format, and dataset IDs can be in UUID or string format.

Name	Type	Description
id	string	An ID in string or UUID format

ChangeLabelStatus

The unique ID and information protection label change status of a Power BI item

Name	Type	Description
id	string	The unique ID of a Power BI item. The ID is in UUID format for dashboards, reports, and dataflows; and in UUID or string format for datasets.
status	status	The status of an information protection label change operation

InformationProtectionArtifactsChangeLabel

A composite of Power BI item IDs for each item type. The IDs specify which Power BI items require an information protection label update.

Name	Type	Description
dashboards	ArtifactId[]	A list of unique dashboard IDs
dataflows	ArtifactId[]	A list of unique dataflow IDs
datasets	ArtifactStringId[]	A list of unique dataset IDs
reports	ArtifactId[]	A list of unique report IDs

InformationProtectionChangeLabelResponse

A composite of the ID and information protection label change status for one or more Power BI items organized by type

Name	Type	Description
dashboards	ChangeLabelStatus[]	A list containing the unique ID and information protection label change status of one or more dashboards
dataflows	ChangeLabelStatus[]	A list containing the unique ID and information protection label change status of one or more dataflows
datasets	ChangeLabelStatus[]	A list containing the unique ID and information protection label change status of one or more datasets
reports	ChangeLabelStatus[]	A list containing the unique ID and information protection label change status of one or more reports

status

The status of an information protection label change operation

Name	Type	Description
Failed	string	Failed to set a new label. Please retry.
FailedToGetUsageRights	string	Failed to set a new label. The Power BI item has a sensitivity label with protection settings, and Power BI was unable to verify that the user has sufficient usage rights to change the label.
InsufficientUsageRights	string	Failed to set a new label. The Power BI item has a sensitivity label with protection settings, and the admin user (and the delegated user, if provided) doesn't have sufficient usage rights to change the label.
NotFound	string	The Power BI item ID or label wasn't found
Succeeded	string	The Power BI item label was changed

Share via