使用工作區 API 管理儀錶板許可權

文章
07/18/2024

本教學課程示範如何使用工作區 API 管理儀錶板許可權。每個步驟都包含範例要求和回應，以及有關如何同時使用 API 工具和屬性的說明。

必要條件

您需要個人存取令牌才能與工作區連線。請參閱 Azure Databricks 個人存取令牌驗證。
您需要您想要存取之工作區的工作區識別碼。請參閱工作區實例名稱、URL 和識別碼
熟悉 Databricks REST API 參考。

路徑參數

本文中的每個端點要求都需要兩個路徑參數和 workspace_object_type workspace_object_id。

workspace_object_type：對於AI/BI 儀錶板，物件類型為 dashboards。
workspace_object_id：這會對應至 resource_id 與儀錶板相關聯的。您可以使用 GET /api/2.0/workspace/list 或 GET /api/2.0/workspace/get-status 來擷取該值。它是類似於 01eec14769f616949d7a44244a53ed10的 32 個字元字串。

如需列出工作區物件的範例，請參閱步驟 1：探索工作區目錄。如需工作區清單 API 的詳細資訊，請參閱 GET /api/2.0/workspace/list 。

取得工作區物件許可權等級

本節使用 取得工作區物件許可權等級 端點來取得用戶可以在儀錶板上擁有的許可權等級。請參閱 GET /api/workspace/workspace/getpermissionlevels。

在下列範例中，要求包含上述範例路徑參數。回應包含可套用至要求中所指示之儀錶板的許可權。

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

取得工作區物件許可權詳細數據

取得工作區物件許可權端點會取得特定工作區物件的指派許可權。請參閱 GET /api/workspace/workspace/getpermissions。

下列範例顯示上一個範例中儀錶板的要求和回應。回應包含儀錶板的詳細數據，以及具有儀錶板許可權的使用者和群組。回應部分的這兩個專案 access_control_list 都繼承了此對象的許可權。在第一個專案中，許可權會繼承自工作區中的資料夾。第二個項目會顯示群組中成員資格繼承的許可權。 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/"
                ]
        }
]
}
]
}

設定工作區物件許可權

您可以使用設定工作區物件許可權端點，在儀錶板 上設定許可權 。請參閱 PUT /api/workspace/workspace/setpermissions。

下列範例會為 PUT 要求中的所有工作區使用者 workspace_object_id 提供 CAN EDIT 許可權。

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

Request body:

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

針對 AI/BI 儀錶板，您可以使用群組 All account users ，將檢視許可權指派給已註冊至 Azure Databricks 帳戶的所有使用者。請參閱共用已發佈的儀錶板。

更新工作區物件許可權

更新工作區物件許可權端點會執行與設定工作區物件許可權端點類似的函式。它會使用 PATCH 要求來指派許可權，而不是 PUT 要求。

請參閱 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"
    }
  ]
}

分享方式：