Mengelola izin dasbor menggunakan API Ruang Kerja

Halaman ini menunjukkan cara mengelola izin dasbor menggunakan API Ruang Kerja. Setiap langkah mencakup permintaan sampel dan respons dan penjelasan tentang cara menggunakan alat dan properti API bersama-sama. Untuk mengelola izin menggunakan UI, lihat Berbagi dasbor.

Prasyarat

Parameter jalur

Setiap permintaan titik akhir dalam artikel ini memerlukan dua parameter jalur, workspace_object_type dan workspace_object_id.

  • workspace_object_type: Untuk dasbor AI/BI, jenis objeknya adalah dashboards.
  • workspace_object_id: Ini sesuai dengan resource_id yang berhubungan dengan dasbor. Anda dapat menggunakan GET /api/2.0/workspace/list atau GET /api/2.0/workspace/get-status untuk mengambil nilai tersebut. Ini adalah string 32 karakter yang mirip dengan 01eec14769f616949d7a44244a53ed10.

Lihat Langkah 1: Menjelajahi direktori ruang kerja untuk contoh mencantumkan objek ruang kerja. Lihat GET /api/2.0/workspace/list untuk detail tentang API Daftar Ruang Kerja.

Mendapatkan tingkat izin objek ruang kerja

Bagian ini menggunakan titik akhir Ambil tingkat izin objek ruang kerja untuk mendapatkan tingkat izin yang bisa dimiliki pengguna di dasbor. Lihat GET /api/workspace/workspace/getpermissionlevels.

Dalam contoh berikut, permintaan menyertakan parameter jalur sampel yang dijelaskan di atas. Respons mencakup izin yang dapat diterapkan ke dasbor yang ditunjukkan dalam permintaan.

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

Dapatkan detail izin objek ruang kerja

Titik akhir Dapatkan izin objek ruang kerja memperoleh izin yang ditetapkan pada objek ruang kerja tertentu. Lihat GET /api/workspace/workspace/getpermissions.

Contoh berikut menunjukkan permintaan dan respons untuk dasbor dalam contoh sebelumnya. Respons mencakup detail tentang dasbor dan pengguna serta grup-grup dengan izin atas dasbor. Izin pada objek ini telah diwariskan untuk kedua item dalam access_control_list bagian respons. Dalam entri pertama, izin diwariskan dari folder di ruang kerja. Entri kedua menunjukkan izin yang diperoleh dari keanggotaan dalam grup, 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/"
                ]
        }
]
}
]
}

Mengatur izin objek ruang kerja

Anda dapat menetapkan izin pada dasbor menggunakan titik akhir Set izin objek ruang kerja. Lihat PUT /api/workspace/workspace/setpermissions.

Contoh berikut memberikan izin CAN EDIT kepada semua pengguna ruang kerja untuk workspace_object_id dalam permintaan PUT.

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

Request body:

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

Untuk dasbor AI/BI, Anda dapat menggunakan grup All account users untuk menetapkan izin tampilan ke semua pengguna yang terdaftar di akun Azure Databricks. Lihat Bagikan dasbor yang sudah diterbitkan.

Memperbarui izin objek ruang kerja

Titik akhir Perbarui izin objek ruang kerja melakukan fungsi yang mirip dengan titik akhir Atur izin objek ruang kerja. Ini memberikan izin dengan menggunakan permintaan PATCH alih-alih permintaan PUT.

Lihat 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"
    }
  ]
}
  • Last updated on