Hantera behörigheter för instrumentpanel med hjälp av arbetsytans API

Den här sidan visar hur du hanterar instrumentpanelsbehörigheter med hjälp av arbetsytans API. Varje steg innehåller en exempelbegäran och ett svar och förklaringar om hur du använder API-verktygen och egenskaperna tillsammans. För att hantera behörigheter med användargränssnittet, se Dela en instrumentpanel.

Förutsättningar

Sökvägsparametrar

Varje slutpunktsbegäran i den här artikeln kräver två sökvägsparametrar workspace_object_type och workspace_object_id.

  • workspace_object_type: För AI/BI-instrumentpaneler är objekttypen dashboards.
  • workspace_object_id: Detta motsvarar den resource_id som är associerad med instrumentpanelen. Du kan använda GET /api/2.0/workspace/list eller GET /api/2.0/workspace/get-status för att hämta värdet. Det är en sträng på 32 tecken som liknar 01eec14769f616949d7a44244a53ed10.

Se Steg 1: Utforska en arbetsytekatalog för ett exempel på en lista över arbetsyteobjekt. Mer information om API:et för arbetsytelista finns i /api/2.0/workspace/list.GET

Hämta behörighetsnivåer för arbetsyteobjekt

Det här avsnittet använder slutpunkten Hämta behörighetsnivåer för arbetsyteobjekt för att hämta de behörighetsnivåer som en användare kan ha på en instrumentpanel. Se GET /api/workspace/workspace/getpermissionlevels.

I följande exempel innehåller begäran exempelsökvägsparametrar som beskrivs ovan. Svaret innehåller de behörigheter som kan tillämpas på instrumentpanelen som anges i begäran.

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

Hämta behörighetsinformation för arbetsytans objekt

Slutpunkten Hämta arbetsyteobjektbehörigheter hämtar de tilldelade behörigheterna för ett specifikt arbetsyteobjekt. Se GET /api/workspace/workspace/getpermissions.

I följande exempel visas en begäran och ett svar för instrumentpanelen i föregående exempel. Svaret innehåller information om instrumentpanelen och användare och grupper med behörigheter på instrumentpanelen. Behörigheter för det här objektet har ärvts för båda posterna i access_control_list-delen av svaret. I den första posten ärvs behörigheter från en mapp på arbetsytan. Den andra posten visar behörigheter som ärvts av medlemskap i gruppen, 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/"
                ]
        }
]
}
]
}

Ange behörigheter för arbetsyteobjekt

Du kan ange behörigheter för dashboards med hjälp av slutpunkten Ange arbetsyteobjekt behörigheter. Se PUT /api/workspace/workspace/setpermissions.

I följande exempel ges behörigheten KAN REDIGERA till alla arbetsyteanvändare för workspace_object_id i PUT-begäran.

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

Request body:

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

För AI/BI-instrumentpaneler kan du använda gruppen All account users för att tilldela visningsbehörighet till alla användare som är registrerade på Azure Databricks-kontot. Se Hur man delar en publicerad instrumentpanel.

Uppdatera behörigheter för arbetsyteobjekt

Slutpunkten Uppdatera arbetsyteobjektbehörigheter utför funktioner på samma sätt som slutpunkten Ange arbetsyteobjektbehörigheter . Den tilldelar behörigheter med hjälp av en PATCH begäran i stället för en PUT begäran.

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