Správa oprávnění řídicího panelu pomocí rozhraní API pracovního prostoru

Článek
07/18/2024

Tento kurz ukazuje, jak spravovat oprávnění řídicího panelu pomocí rozhraní API pracovního prostoru. Každý krok obsahuje ukázkový požadavek a odpověď a vysvětlení o tom, jak společně používat nástroje a vlastnosti rozhraní API.

Požadavky

Pro připojení k pracovnímu prostoru potřebujete osobní přístupový token. Viz ověřování tokenů pat azure Databricks.
Potřebujete ID pracovního prostoru pracovního prostoru, ke které chcete získat přístup. Zobrazení názvů, adres URL a ID instancí pracovního prostoru
Znalost referenčních informací k rozhraní REST API služby Databricks

Parametry cesty

Každý požadavek na koncový bod v tomto článku vyžaduje dva parametry workspace_object_type cesty a workspace_object_id.

workspace_object_type: U řídicích panelů AI/BI je dashboardstyp objektu .
workspace_object_id: Odpovídá resource_id přidruženému k řídicímu panelu. K načtení této hodnoty můžete použít get /api/2.0/workspace/list nebo GET /api/2.0/workspace/get-status . Jedná se o řetězec 32 znaků podobný 01eec14769f616949d7a44244a53ed10.

Viz krok 1: Prozkoumejte adresář pracovního prostoru, například výpis objektů pracovního prostoru. Podrobnosti o rozhraní API seznamu pracovních prostorů najdete v tématu GET /api/2.0/workspace/list .

Získání úrovní oprávnění objektu pracovního prostoru

Tato část používá koncový bod Získat úrovně oprávnění objektu pracovního prostoru k získání úrovní oprávnění, které může uživatel mít na řídicím panelu. Viz GET /api/workspace/workspace/getpermissionlevels.

V následujícím příkladu požadavek obsahuje parametry ukázkové cesty popsané výše. Odpověď zahrnuje oprávnění, která je možné použít na řídicí panel uvedený v požadavku.

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"
                }
        ]
}

Získání podrobností o oprávněních k objektu pracovního prostoru

Koncový bod oprávnění k získání oprávnění k objektu pracovního prostoru získá přiřazená oprávnění ke konkrétnímu objektu pracovního prostoru. Viz GET /api/workspace/workspace/getpermissions.

Následující příklad ukazuje požadavek a odpověď na řídicí panel v předchozím příkladu. Odpověď obsahuje podrobnosti o řídicím panelu a uživatelích a skupinách s oprávněními na řídicím panelu. Oprávnění k tomuto objektu byla zděděna pro obě položky v access_control_list části odpovědi. V první položce se oprávnění dědí ze složky v pracovním prostoru. Druhá položka zobrazuje oprávnění zděděná členstvím ve skupině . admins


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/"
                ]
        }
]
}
]
}

Nastavení oprávnění objektu pracovního prostoru

Oprávnění na řídicích panelech můžete nastavit pomocí koncového bodu Nastavit oprávnění objektu pracovního prostoru. Viz PUT /api/workspace/workspace/setpermissions.

Následující příklad poskytuje oprávnění CAN EDIT všem uživatelům pracovního prostoru pro workspace_object_id požadavek PUT.

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

Request body:

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

U řídicích panelů AI/BI můžete pomocí skupiny All account users přiřadit oprávnění k zobrazení všem uživatelům zaregistrovaným k účtu Azure Databricks. Viz Sdílení publikovaného řídicího panelu.

Aktualizace oprávnění objektu pracovního prostoru

Koncový bod oprávnění k objektu aktualizovat pracovní prostor provádí funkce podobně jako koncový bod Nastavit oprávnění objektu pracovního prostoru. Přiřazuje oprávnění pomocí PATCH požadavku místo PUT požadavku.

Viz 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"
    }
  ]
}

Sdílet prostřednictvím