Zarządzanie uprawnieniami pulpitu nawigacyjnego przy użyciu interfejsu API obszaru roboczego

W tym samouczku pokazano, jak zarządzać uprawnieniami pulpitu nawigacyjnego przy użyciu interfejsu API obszaru roboczego. Każdy krok zawiera przykładowe żądanie i odpowiedź oraz wyjaśnienia dotyczące sposobu używania narzędzi interfejsu API i właściwości razem.

Wymagania wstępne

• Do nawiązania połączenia z obszarem roboczym potrzebny jest osobisty token dostępu. Zobacz Uwierzytelnianie osobistego tokenu dostępu w usłudze Azure Databricks.
• Potrzebny jest identyfikator obszaru roboczego obszaru roboczego, do którego chcesz uzyskać dostęp. Zobacz Nazwy, adresy URL i identyfikatory wystąpień obszaru roboczego
• Znajomość dokumentacji interfejsu API REST usługi Databricks.

Parametry ścieżki

Każde żądanie punktu końcowego w tym artykule wymaga dwóch parametrów ścieżki i workspace_object_type workspace_object_id.

• workspace_object_type: W przypadku pulpitów nawigacyjnych AI/BI typ obiektu to dashboards.
• workspace_object_id: odpowiada resource_id to skojarzonemu z pulpitem nawigacyjnym. Aby pobrać wartość, możesz użyć polecenia GET /api/2.0/workspace/ list lub GET /api/2.0/workspace/get-status . Jest to ciąg 32-znakowy podobny do 01eec14769f616949d7a44244a53ed10.

Zobacz Krok 1. Eksplorowanie katalogu obszaru roboczego, aby zapoznać się z przykładem wyświetlania listy obiektów obszaru roboczego. Aby uzyskać szczegółowe informacje na temat interfejsu API listy obszarów roboczych, zobacz GET /api/2.0/workspace/list .

Pobieranie poziomów uprawnień obiektu obszaru roboczego

W tej sekcji użyto punktu końcowego Uzyskiwanie poziomów uprawnień obiektu obszaru roboczego, aby uzyskać poziomy uprawnień, które użytkownik może mieć na pulpicie nawigacyjnym. Zobacz GET /api/workspace/workspace/getpermissionlevels.

W poniższym przykładzie żądanie zawiera przykładowe parametry ścieżki opisane powyżej. Odpowiedź zawiera uprawnienia, które można zastosować do pulpitu nawigacyjnego wskazanego w żądaniu.

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

Pobieranie szczegółów uprawnień obiektu obszaru roboczego

Punkt końcowy Uzyskiwanie uprawnień obiektu obszaru roboczego pobiera przypisane uprawnienia do określonego obiektu obszaru roboczego. Zobacz GET /api/workspace/workspace/getpermissions.

Poniższy przykład przedstawia żądanie i odpowiedź dla pulpitu nawigacyjnego w poprzednim przykładzie. Odpowiedź zawiera szczegółowe informacje o pulpicie nawigacyjnym i użytkownikach i grupach z uprawnieniami na pulpicie nawigacyjnym. Uprawnienia do tego obiektu zostały odziedziczone dla obu elementów w access_control_list części odpowiedzi. W pierwszym wpisie uprawnienia są dziedziczone z folderu w obszarze roboczym. Drugi wpis zawiera uprawnienia dziedziczone przez członkostwo w grupie . 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/"
                ]
        }
]
}
]
}

Ustawianie uprawnień obiektu obszaru roboczego

Uprawnienia na pulpitach nawigacyjnych można ustawić przy użyciu punktu końcowego Ustawianie uprawnień obiektu obszaru roboczego. Zobacz PUT /api/workspace/workspace/setpermissions.

Poniższy przykład daje uprawnienie CAN EDIT wszystkim użytkownikom obszaru roboczego dla workspace_object_id żądania PUT.

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

Request body:

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

W przypadku pulpitów nawigacyjnych sztucznej inteligencji/analizy biznesowej możesz użyć grupy All account users do przypisania uprawnień widoku do wszystkich użytkowników zarejestrowanych na koncie usługi Azure Databricks. Zobacz Udostępnianie opublikowanego pulpitu nawigacyjnego.

Aktualizowanie uprawnień obiektu obszaru roboczego

Punkt końcowy Aktualizuj uprawnienia obiektu obszaru roboczego wykonuje funkcje podobne do punktu końcowego Ustawianie uprawnień obiektu obszaru roboczego. Przypisuje uprawnienia przy użyciu PATCH żądania zamiast PUT żądania.

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