メインコンテンツまでスキップ

ワークスペース APIを使用してダッシュボードのアクセス許可を管理する

このチュートリアルでは、ワークスペース APIを使用してダッシュボードの権限を管理する方法を示します。 各ステップには、サンプルの要求と応答、および API ツールとプロパティを一緒に使用する方法の説明が含まれています。

前提 条件​

Path パラメーター​

この記事の各エンドポイント要求には、 workspace_object_type と workspace_object_idの 2 つのパスパラメーターが必要です。

  • workspace_object_type : AI/BI ダッシュボードの場合、オブジェクト タイプは dashboardsです。
  • workspace_object_id : これは、ダッシュボードに関連付けられているresource_idに対応します。GET /api/2.0/ワークスペース/list または 、GET /api/2.0/workspace/get-status を使用してその値を取得します。 これは、 01eec14769f616949d7a44244a53ed10に似た 32 文字の文字列です。

ワークスペース・オブジェクトのリスト例については、 ステップ 1: ワークスペース・ディレクトリーの表示 を参照してください。GET /api/2.0/ワークスペース/listを参照してください。 詳細については、「ワークスペース リスト APIを参照してください。

ワークスペース オブジェクトのアクセス許可レベルを取得する​

このセクションでは、 ワークスペース オブジェクトのアクセス許可レベルの取得 エンドポイントを使用して、ユーザーがダッシュボードで持つことができるアクセス許可レベルを取得します。 「GET /api/ワークスペース/ワークスペース/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/ワークスペース/ワークスペース/getpermissions」を参照してください。

次の例は、前の例のダッシュボードの要求と応答を示しています。 応答には、ダッシュボードと、ダッシュボードに対する権限を持つユーザーとグループに関する詳細が含まれます。 このオブジェクトに対するアクセス許可は、応答の access_control_list 部分の両方の項目に対して継承されています。 最初のエントリでは、アクセス許可はワークスペース内のフォルダーから継承されます。 2 番目のエントリは、グループのメンバーシップによって継承された権限を示しています 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/ワークスペース/ワークスペース/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 を使用して、Databricks アカウントに登録されているすべてのユーザーに表示アクセス許可を割り当てることができます。 「公開されたダッシュボードの共有」を参照してください。

ワークスペース オブジェクトのアクセス許可を更新する​

ワークスペース オブジェクトのアクセス許可の更新 エンドポイントは、 ワークスペース オブジェクトのアクセス許可の設定 エンドポイントと同様に機能します。PUT 要求ではなく PATCH 要求を使用してアクセス許可を割り当てます。

「PATCH /api/ワークスペース/ワークスペース/updatepermissions」を参照してください。


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

Request body:

{
  "access_control_list": [
    {
      "group_name": "account userS",
      "permission_level": "CAN_VIEW"
    }
  ]
}
に最終更新