Choosing a handshake

Ini adalah dokumentasi untukAuthentication metode Handshake. Personalisasi menawarkanset metode Handshake yang berbeda.

Sebelum pengguna Anda dapat mengakses konten yang dipersonalisasi, mereka harus diautentikasi. Mintlify mendukung empat metode Handshake Autentikasi:

1. Password: Konfigurasikan set password global untuk situs dokumentasi Anda.
2. JWT: Gunakan alur login Anda sendiri untuk mengautentikasi pengguna Anda melalui JWT di URL.
3. OAuth 2.0: Integrasikan dengan server OAuth Anda untuk mengaktifkan login pengguna melalui alur Authorization Code standar.
4. Mintlify Dashboard: Izinkan semua pengguna dashboard Anda untuk mengakses dokumentasi Anda, tanpa konfigurasi yang diperlukan.

Prasyarat

Password

• Persyaratan keamanan Anda memungkinkan berbagi password antara pembaca dokumentasi.

• Persyaratan keamanan Anda memungkinkan berbagi password antara pembaca dokumentasi.

• Anda memiliki alur login yang sudah ada.
• Anda dapat menambahkan langkah terakhir dalam alur login ini yang membuat JWT dan mengarahkan ke dokumentasi.

• Anda memiliki server OAuth yang sudah ada yang mendukung alur Authorization Code.
• Anda dapat membuat endpoint API baru yang dapat diakses oleh token akses OAuth yang dikembalikan.

• Pembaca dokumentasi Anda juga merupakan editor dokumentasi Anda.

Pro & Kontra

Password

Pros:

• Pengaturan sangat sederhana
• Tidak ada konfigurasi yang diperlukan untuk menambahkan pengguna baru - cukup bagikan passwordnya

Cons:

• Sulit untuk mencabut akses ke dokumentasi Anda tanpa mengatur ulang password
• Kehilangan fitur personalisasi, karena tidak ada cara untuk membedakan pengguna dengan password yang sama

Pros:

• Pengaturan sangat sederhana
• Tidak ada konfigurasi yang diperlukan untuk menambahkan pengguna baru - cukup bagikan passwordnya

Cons:

• Sulit untuk mencabut akses ke dokumentasi Anda tanpa mengatur ulang password
• Kehilangan fitur personalisasi, karena tidak ada cara untuk membedakan pengguna dengan password yang sama

Pros:

• Mengurangi risiko penyalahgunaan endpoint API
• Konfigurasi CORS nol
• Tidak ada batasan pada URL API

Cons:

• Harus dapat terhubung ke alur login Anda yang sudah ada

Pros:

• Standar keamanan yang lebih tinggi

Cons:

• Memerlukan pekerjaan yang signifikan jika menyiapkan server OAuth untuk pertama kalinya
• Mungkin berlebihan untuk beberapa aplikasi

Pros:

• Pengaturan tanpa konfigurasi

Cons:

• Memerlukan semua pembaca dokumentasi untuk memiliki akun di dashboard Mintlify Anda