작업 영역 API를 사용하여 대시보드 권한 관리

아티클
07/18/2024

이 자습서에서는 작업 영역 API를 사용하여 대시보드 권한을 관리하는 방법을 보여 줍니다. 각 단계에는 API 도구와 속성을 함께 사용하는 방법에 대한 샘플 요청 및 응답 및 설명이 포함됩니다.

필수 조건

작업 영역에 연결하려면 개인용 액세스 토큰이 필요합니다. Azure Databricks 개인용 액세스 토큰 인증을 참조하세요.
액세스하려는 작업 영역의 작업 영역 ID가 필요합니다. 작업 영역 인스턴스 이름, URL 및 ID 참조
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를 사용하여 해당 값을 검색할 수 있습니다. 32자로 된 문자열 01eec14769f616949d7a44244a53ed10입니다.

작업 영역 개체를 나열하는 예제는 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"
    }
  ]
}

다음을 통해 공유