Dashboardmachtigingen beheren met behulp van de Werkruimte-API

Artikel
07/18/2024

Deze zelfstudie laat zien hoe u dashboardmachtigingen beheert met behulp van de Werkruimte-API. Elke stap bevat een voorbeeld van een aanvraag en antwoord en uitleg over het gebruik van de API-hulpprogramma's en eigenschappen.

Vereisten

U hebt een persoonlijk toegangstoken nodig om verbinding te maken met uw werkruimte. Zie persoonlijke toegangstokenverificatie van Azure Databricks.
U hebt de werkruimte-id nodig van de werkruimte die u wilt openen. Namen , URL's en id's van werkruimte-exemplaren weergeven
Bekendheid met de Databricks REST API-verwijzing.

Padparameters

Elke eindpuntaanvraag in dit artikel vereist twee padparameters en workspace_object_type workspace_object_id.

workspace_object_type: Voor AI/BI-dashboards is dashboardshet objecttype.
workspace_object_id: Dit komt overeen met de resource_id gekoppelde aan het dashboard. U kunt de GET /api/2.0/workspace/list of GET /api/2.0/workspace/get-status gebruiken om die waarde op te halen. Het is een tekenreeks van 32 tekens die vergelijkbaar is met 01eec14769f616949d7a44244a53ed10.

Zie stap 1: Een werkruimtemap verkennen voor een voorbeeld van het weergeven van werkruimteobjecten. Zie GET /api/2.0/workspace/list voor meer informatie over de API voor de werkruimtelijst.

Machtigingsniveaus voor werkruimteobjecten ophalen

In deze sectie wordt het eindpunt Machtigingsniveaus voor werkruimteobjecten ophalen gebruikt om de machtigingsniveaus op te halen die een gebruiker op een dashboard kan hebben. Zie GET /api/workspace/workspace/getpermissionlevels.

In het volgende voorbeeld bevat de aanvraag voorbeeldpadparameters die hierboven worden beschreven. Het antwoord bevat de machtigingen die kunnen worden toegepast op het dashboard dat in de aanvraag wordt aangegeven.

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

Details van machtiging voor werkruimteobject ophalen

Het eindpunt werkruimteobjectmachtigingen ophalen haalt de toegewezen machtigingen voor een specifiek werkruimteobject op. Zie GET /api/workspace/workspace/getpermissions.

In het volgende voorbeeld ziet u een aanvraag en antwoord voor het dashboard in het vorige voorbeeld. Het antwoord bevat details over het dashboard en gebruikers en groepen met machtigingen op het dashboard. Machtigingen voor dit object zijn overgenomen voor beide items in het access_control_list gedeelte van het antwoord. In de eerste vermelding worden machtigingen overgenomen van een map in de werkruimte. De tweede vermelding toont machtigingen die zijn overgenomen door lidmaatschap van de groep, 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/"
                ]
        }
]
}
]
}

Machtigingen voor werkruimteobjecten instellen

U kunt machtigingen instellen voor dashboards met behulp van het eindpunt machtigingen voor werkruimteobjecten instellen. Zie PUT /api/workspace/workspace/setpermissions.

Het volgende voorbeeld geeft CAN EDIT-machtigingen voor alle werkruimtegebruikers voor de workspace_object_id in de PUT-aanvraag.

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

Request body:

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

Voor AI/BI-dashboards kunt u de groep All account users gebruiken om weergavemachtigingen toe te wijzen aan alle gebruikers die zijn geregistreerd bij het Azure Databricks-account. Zie Een gepubliceerd dashboard delen.

Machtigingen voor werkruimteobjecten bijwerken

Het eindpunt werkruimteobjectmachtigingen bijwerken voert functies uit die vergelijkbaar zijn met het eindpunt machtigingen voor werkruimteobjecten instellen. Hiermee worden machtigingen toegewezen met behulp van een PATCH aanvraag in plaats van een PUT aanvraag.

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

Delen via