Verwalten der Dashboardberechtigungen mithilfe der Arbeitsbereichs-API

Artikel
02/09/2025

In diesem Tutorial wird das Verwalten von Dashboardberechtigungen mithilfe der Arbeitsbereichs-API veranschaulicht. Jeder Schritt enthält eine Beispielanforderung und -antwort sowie Erläuterungen zur gemeinsamen Verwendung der API-Tools und -Eigenschaften.

Voraussetzungen

Richten Sie die Authentifizierung für den Zugriff auf Azure Databricks-Ressourcen ein. Informationen zu Authentifizierungsoptionen und zum Abrufen von Setupanweisungen finden Sie unter Autorisierung des Zugriffs auf Azure Databricks-Ressourcen.
Sie benötigen die Arbeitsbereichs-URL(n), auf die Sie zugreifen möchten. Weitere Informationen finden Sie unter Arbeitsbereichsnamen, URLs und IDs.
Vertrautheit mit der Databricks-REST-API-Referenz

Pfadparameter

Jede Endpunktanforderung in diesem Artikel erfordert zwei Pfadparameter: workspace_object_type und workspace_object_id.

workspace_object_type: Für KI/BI-Dashboards lautet der Objekttyp dashboards.
workspace_object_id: Dies entspricht der dem Dashboard zugeordneten Ressourcen-ID (resource_id). Sie können die GET /api/2.0/workspace/list oder GET /api/2.0/workspace/get-status verwenden, um diesen Wert abzurufen. Es handelt sich um eine Zeichenfolge aus 32 Zeichen, die 01eec14769f616949d7a44244a53ed10 ähnelt.

Ein Beispiel für das Auflisten von Arbeitsbereichsobjekten finden Sie unter Schritt 1: Erkunden eines Arbeitsbereichsverzeichnisses. Details zur Arbeitsbereichslisten-API finden Sie unter GET /api/2.0/workspace/list.

Abrufen von Berechtigungsstufen für Arbeitsbereichsobjekte

In diesem Abschnitt werden mit dem Endpunkt zum Abrufen der Berechtigungsstufen für Arbeitsbereichsobjekte die Berechtigungsstufen abgerufen, die ein Benutzer für ein Dashboard haben kann. Weitere Informationen finden Sie unter GET /api/workspace/workspace/getpermissionlevels.

Im folgenden Beispiel beinhaltet die Anforderung die oben beschriebenen Beispielpfadparameter. Die Antwort enthält die Berechtigungen, die auf das in der Anforderung angegebene Dashboard angewendet werden können.

GET /api/2.0/permissions/dashboards/01eec14769f616949d7a44244a53ed10/permissionLevels

Response:
{
        "permission_levels": [
                {
                        "permission_level": "CAN_READ",
                        "description": "Can view the Lakeview dashboard"
                },
                {
                        "permission_level": "CAN_RUN",
                        "description": "Can view, attach/detach, and run the Lakeview dashboard"
                },
                {
                        "permission_level": "CAN_EDIT",
                        "description": "Can view, attach/detach, run, and edit the Lakeview dashboard"
                },
                {
                        "permission_level": "CAN_MANAGE",
                        "description": "Can view, attach/detach, run, edit, and change permissions of the Lakeview dashboard"
                }
        ]
}

Abrufen von Details zu Arbeitsbereichsobjektberechtigungen

Der Endpunkt zum Abrufen von Arbeitsbereichsobjektberechtigungen ruft die zugewiesenen Berechtigungen für ein bestimmtes Arbeitsbereichsobjekt ab. Weitere Informationen finden Sie unter GET /api/workspace/workspace/getpermissions.

Das folgende Beispiel zeigt eine Anforderung und eine Antwort für das Dashboard aus dem vorherigen Beispiel. Die Antwort enthält Details zum Dashboard und zu Benutzern und Gruppen mit Berechtigungen für das Dashboard. Berechtigungen für dieses Objekt wurden für beide Elemente im Teil access_control_list der Antwort geerbt. Im ersten Eintrag werden Berechtigungen von einem Ordner im Arbeitsbereich geerbt. Der zweite Eintrag zeigt Berechtigungen, die von der Mitgliedschaft in der Gruppe (admins) geerbt werden.


GET /api/2.0/permissions/dashboards/01eec14769f616949d7a44244a53ed10

Response:
{
"object_id": "/dashboards/490384175243923",
"object_type": "dashboard",
"access_control_list": [
  {
  "user_name": "first.last@example.com",
  "display_name": "First Last",
  "all_permissions": [
        {
          "permission_level": "CAN_MANAGE",
          "inherited": true,
          "inherited_from_object": [
                        "/directories/2951435987702195"
                ]
        }
]
},
{
"group_name": "admins",
"all_permissions": [
        {
                "permission_level": "CAN_MANAGE",
                "inherited": true,
                "inherited_from_object": [
                        "/directories/"
                ]
        }
]
}
]
}

Festlegen von Arbeitsbereichsobjektberechtigungen

Sie können Berechtigungen für Dashboards mithilfe des Endpunkts zum Festlegen von Arbeitsbereichsobjektberechtigungen festlegen. Weitere Informationen finden Sie unter PUT /api/workspace/workspace/setpermissions.

Im folgenden Beispiel wird allen Arbeitsbereichsbenutzern die Berechtigung KANN BEARBEITEN für workspace_object_id in der PUT-Anforderung erteilt.

PUT /api/2.0/permissions/dashboards/01eec14769f616949d7a44244a53ed10

Request body:

{
"access_control_list": [
{
        "group_name": "users",
        "permission_level": "CAN_EDIT"
}
]
}

Bei KI/BI-Dashboards können Sie die Gruppe All account users verwenden, um allen im Azure Databricks-Konto registrierten Benutzern die Berechtigung zum Anzeigen zuzuweisen. Siehe Freigeben eines veröffentlichten Dashboards.

Aktualisieren von Arbeitsbereichsobjektberechtigungen

Der Endpunkt zum Aktualisieren von Arbeitsbereichsobjektberechtigungen führt ähnliche Funktionen wie der Endpunkt zum Festlegen von Arbeitsbereichsobjektberechtigungen aus. Er weist Berechtigungen mithilfe einer PATCH-Anforderung anstelle einer PUT-Anforderung zu.

Weitere Informationen finden Sie unter PATCH /api/workspace/workspace/updatepermissions.


PATCH /api/2.0/permissions/dashboards/01eec14769f616949d7a44244a53ed10

Request body:

{
  "access_control_list": [
    {
      "group_name": "account userS",
      "permission_level": "CAN_VIEW"
    }
  ]
}

Freigeben über