Gestire le autorizzazioni del dashboard usando l'API dell'area di lavoro

Articolo
06/26/2024

Questa esercitazione illustra come gestire le autorizzazioni del dashboard usando l'API dell'area di lavoro. Ogni passaggio include una richiesta e una risposta di esempio e spiegazioni su come usare insieme gli strumenti e le proprietà dell'API.

Prerequisiti

È necessario un token di accesso personale per connettersi all'area di lavoro. Vedere Autenticazione del token di accesso personale di Azure Databricks.
È necessario l'ID area di lavoro dell'area di lavoro a cui si vuole accedere. Vedere Nomi, URL e ID dell'istanza dell'area di lavoro
Familiarità con le informazioni di riferimento sull'API REST di Databricks.

Parametri del percorso

Ogni richiesta di endpoint in questo articolo richiede due parametri di percorso e workspace_object_typeworkspace_object_id.

workspace_object_type: per i dashboard di Lakeview, il tipo di oggetto è dashboards.
workspace_object_id: corrisponde all'oggetto resource_id associato al dashboard. È possibile usare GET /api/2.0/workspace/list o GET /api/2.0/workspace/get-status per recuperare tale valore. Si tratta di una stringa di 32 caratteri simile a 01eec14769f616949d7a44244a53ed10.

Vedere Passaggio 1: Esplorare una directory dell'area di lavoro per un esempio di elenco degli oggetti dell'area di lavoro. Per informazioni dettagliate sull'API Elenco aree di lavoro, vedere GET /api/2.0/workspace/list .

Ottenere i livelli di autorizzazione per gli oggetti dell'area di lavoro

Questa sezione usa l'endpoint Ottenere i livelli di autorizzazione per gli oggetti dell'area di lavoro per ottenere i livelli di autorizzazione che un utente può avere in un dashboard. Vedere GET /api/workspace/workspace/getpermissionlevels.

Nell'esempio seguente la richiesta include parametri di percorso di esempio descritti in precedenza. La risposta include le autorizzazioni che possono essere applicate al dashboard indicato nella richiesta.

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

Ottenere i dettagli delle autorizzazioni per gli oggetti dell'area di lavoro

L'endpoint Ottenere le autorizzazioni per gli oggetti dell'area di lavoro ottiene le autorizzazioni assegnate per un oggetto area di lavoro specifico. Vedere GET /api/workspace/workspace/getpermissions.

L'esempio seguente mostra una richiesta e una risposta per il dashboard nell'esempio precedente. La risposta include informazioni dettagliate sul dashboard e gli utenti e i gruppi con autorizzazioni per il dashboard. Le autorizzazioni per questo oggetto sono state ereditate per entrambi gli elementi nella access_control_list parte della risposta. Nella prima voce le autorizzazioni vengono ereditate da una cartella nell'area di lavoro. La seconda voce mostra le autorizzazioni ereditate dall'appartenenza al gruppo , 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/"
                ]
        }
]
}
]
}

Impostare le autorizzazioni per gli oggetti dell'area di lavoro

È possibile impostare le autorizzazioni per i dashboard usando l'endpoint Imposta autorizzazioni per gli oggetti dell'area di lavoro. Vedere PUT /api/workspace/workspace/setpermissions.

Nell'esempio seguente viene data l'autorizzazione CAN EDIT a tutti gli utenti dell'area workspace_object_id di lavoro per nella richiesta PUT.

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

Request body:

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

Per i dashboard di Lakeview, è possibile usare il gruppo All account users per assegnare l'autorizzazione di visualizzazione a tutti gli utenti registrati nell'account Azure Databricks. Vedere Condividere un dashboard pubblicato.

Aggiornare le autorizzazioni per gli oggetti dell'area di lavoro

L'endpoint Aggiorna autorizzazioni per gli oggetti dell'area di lavoro esegue funzioni in modo analogo all'endpoint Imposta autorizzazioni per gli oggetti dell'area di lavoro. Assegna le autorizzazioni usando una PATCH richiesta anziché una PUT richiesta.

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

Condividi tramite