Bagikan melalui

Mengaktifkan atau menonaktifkan aplikasi OAuth mitra

Artikel ini menjelaskan cara mengaktifkan dan menonaktifkan aplikasi OAuth mitra untuk akun Azure Databricks Anda.

Aplikasi Dbt Core, Power BI, Tableau Desktop, dan Tableau Cloud OAuth diaktifkan secara default untuk akun Anda.

Catatan

Pembaruan untuk aplikasi OAuth dapat memakan waktu 30 menit untuk diproses.

Mengaktifkan aplikasi OAuth kustom menggunakan UI Azure Databricks

Anda dapat menggunakan antarmuka pengguna Azure Databricks untuk mengaktifkan aplikasi OAuth kustom tambahan.

Untuk mengaktifkan aplikasi OAuth kustom di UI, lakukan hal berikut:

  1. Masuk ke konsol akun dan klik ikon Pengaturan di bar samping.

  2. Pada tab Koneksi aplikasi, klik Tambahkan koneksi.

  3. Masukkan rincian berikut:

    1. Nama untuk koneksi Anda.

    2. URL pengalihan untuk koneksi OAuth Anda.

    3. Untuk Cakupan Akses, cakupan menentukan API mana yang harus diakses aplikasi.

      • Untuk aplikasi BI, SQL cakupan diperlukan untuk memungkinkan aplikasi yang terhubung mengakses API SQL Databricks.
      • Untuk aplikasi yang perlu mengakses API Databricks untuk tujuan selain kueri, ALL APIs cakupan diperlukan.

      Cakupan berikut secara otomatis diizinkan:

      • openid, , emailprofile: Diperlukan untuk menghasilkan token ID.
      • offline_access: Diperlukan untuk menghasilkan token refresh.

      Jika Anda tidak ingin mengizinkan cakupan ini untuk aplikasi, Anda dapat mengelola cakupan terperinci dengan menggunakan POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations API untuk membuat aplikasi kustom Anda.

    4. Token akses time-to-live (TTL) dalam hitungan menit. Standar: 60.

    5. Token refresh time-to-live (TTL) dalam hitungan menit. Standar: 10080.

    6. Apakah akan menghasilkan rahasia klien. Ini diperlukan untuk klien non-publik (rahasia).

      Kotak dialog Koneksi yang dibuat menampilkan ID klien koneksi dan rahasia klien Anda, jika berlaku.

  4. Jika Anda memilih Buat rahasia klien, salin dan simpan rahasia klien dengan aman. Anda tidak dapat mengakses kunci rahasia klien di kemudian hari.

Anda dapat mengedit URL pengalihan, token TTL, dan refresh token TTL untuk aplikasi OAuth kustom yang ada di UI dengan mengklik nama aplikasi pada halaman Pengaturan>Koneksi aplikasi di konsol akun. Anda juga dapat melihat aplikasi OAuth yang sudah diterbitkan (dbt Core, Power BI, Tableau) di UI.

Anda dapat menonaktifkan aplikasi OAuth yang diterbitkan dan kustom di UI dengan mengklik nama aplikasi atau menu kebab di samping nama aplikasi, lalu mengklik Hapus.

Catatan

Menonaktifkan aplikasi merusak koneksi aplikasi, jadi berhati-hatilah saat menonaktifkan aplikasi OAuth. Jika Anda menonaktifkan aplikasi OAuth yang diterbitkan di UI, aplikasi tersebut tidak dapat diaktifkan kembali di UI. Untuk mengaktifkan kembali aplikasi yang diterbitkan, lihat Mengaktifkan kembali aplikasi Dbt Core, Power BI, Tableau Desktop, atau Tableau Cloud OAuth menggunakan CLI.

Catatan

Anda hanya dapat mengonfigurasi fitur keamanan OAuth tambahan (seperti token refresh sekali pakai) melalui API. Lihat Token refresh sekali pakai untuk mengaktifkan token refresh sekali pakai untuk keamanan yang ditingkatkan.

Mengaktifkan atau menonaktifkan aplikasi menggunakan Databricks CLI

Bagian ini menjelaskan cara menggunakan Databricks CLI untuk menonaktifkan aplikasi OAuth mitra yang diaktifkan secara default untuk akun Anda, dan cara mengaktifkannya kembali setelah dinonaktifkan. Ini juga menjelaskan cara mengaktifkan dan menonaktifkan Tableau Server, yang tidak diaktifkan secara default.

Sebelum Anda mulai

Sebelum Anda mengaktifkan atau menonaktifkan integrasi aplikasi OAuth mitra menggunakan Databricks CLI, lakukan hal berikut:

  • Instal Databricks CLI dan siapkan autentikasi antara Databricks CLI dan akun Databricks Anda.

  • Untuk menonaktifkan atau mengubah aplikasi OAuth yang ada, temukan ID integrasi.

    • Untuk dbt Core, Power BI, Tableau Desktop, atau Tableau Cloud, jalankan perintah berikut:

      databricks account published-app-integration list

    • Untuk aplikasi kustom, seperti Tableau Server, jalankan perintah berikut:

      databricks account custom-app-integration list

    ID integrasi unik untuk setiap aplikasi OAuth dikembalikan.

Menonaktifkan aplikasi DBT Core, Power BI, Tableau Desktop, atau Tableau Cloud OAuth menggunakan CLI

Untuk menonaktifkan aplikasi Dbt Core, Power BI, Tableau Desktop, atau Tableau Cloud OAuth, jalankan perintah berikut, ganti <integration-id> dengan ID integrasi aplikasi OAuth yang ingin Anda hapus:

databricks account published-app-integration delete <integration-id>

Mengaktifkan kembali aplikasi dbt Core, Power BI, Tableau Desktop, atau Tableau Cloud OAuth menggunakan CLI

dbt Core, Power BI, Tableau Desktop, dan Tableau Cloud diaktifkan sebagai aplikasi OAuth di akun Anda secara default. Untuk mengaktifkan kembali salah satu aplikasi OAuth ini setelah dinonaktifkan, jalankan perintah berikut, ganti <application-id> dengan databricks-dbt-adapter, , power-bitableau-desktop atau 7de584d0-b7ad-4850-b915-be7de7d58711 (Tableau Cloud):

databricks account published-app-integration create <application-id>

ID integrasi unik untuk aplikasi OAuth dikembalikan.

Mengaktifkan aplikasi OAuth kustom menggunakan CLI

Aplikasi Dbt Core, Power BI, Tableau Desktop, dan Tableau Cloud OAuth diaktifkan secara default untuk akun Anda. Anda dapat menggunakan Azure Databricks CLI untuk mengaktifkan aplikasi OAuth kustom tambahan.

Untuk langkah-langkah mengaktifkan aplikasi OAuth Tableau Server kustom, lihat Mengonfigurasi masuk Azure Databricks dari Tableau Server. Untuk langkah-langkah umum untuk mengaktifkan aplikasi OAuth kustom apa pun menggunakan CLI, lihat yang berikut ini:

  1. Jalankan perintah custom-app-integration create. Contoh berikut membuat aplikasi non-publik (rahasia):

    databricks account custom-app-integration create --confidential --json '{"name":"<name>", "redirect_urls":["<redirect-url>"], "scopes":[<scopes>]}'
    • Ganti <name> dengan nama untuk aplikasi OAuth kustom Anda.
    • Ganti <redirect-url> dengan URL pengalihan untuk aplikasi Anda.
    • Ganti <scopes> dengan daftar cakupan yang ingin Anda izinkan untuk aplikasi.
      • Untuk aplikasi BI, SQL cakupan diperlukan untuk memungkinkan aplikasi yang terhubung mengakses API SQL Databricks.
      • Untuk aplikasi yang perlu mengakses API Databricks untuk tujuan selain SQL, ALL APIs cakupan diperlukan.
      • Cakupan openid, email, dan profile diperlukan untuk menghasilkan token ID.
      • Cakupan offline_access diperlukan untuk menghasilkan token refresh.

    Untuk informasi selengkapnya tentang nilai yang didukung, lihat POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations dalam referensi REST API.

    ID klien dibuat. Untuk aplikasi non-publik (rahasia), rahasia klien juga dihasilkan. Output berikut akan dikembalikan:

    {"integration_id":"<integration-id>","client_id":"<client-id>","client_secret":"<client-secret>"}

    Catatan

    Mengaktifkan aplikasi OAuth dapat memakan waktu 30 menit untuk diproses.

  2. Simpan rahasia klien dengan aman, jika berlaku.

    Penting

    Anda tidak dapat mengakses kunci rahasia klien di kemudian hari.

Menonaktifkan aplikasi OAuth kustom menggunakan CLI

Untuk menonaktifkan aplikasi OAuth kustom yang ada, seperti Tableau Server, jalankan perintah berikut, ganti <integration-id> dengan ID integrasi aplikasi OAuth yang ingin Anda nonaktifkan:

databricks account custom-app-integration delete <integration-id>
  • Last updated on