Cara Mengelola Akun Pengguna dengan Microsoft Exchange Online Admin API
By Mirko Peters · · Updated
Jelajahi Exchange Online Admin API, alternatif berbasis REST untuk Exchange Web Services (EWS). Kelola akun pengguna Exchange Online secara efektif.
Automatically translated with AI from the original post. Read the English original
Mengelola akun pengguna sangat penting bagi setiap organisasi. Hal ini memastikan karyawan memiliki akses yang tepat ke sumber daya sekaligus menjaga keamanan informasi sensitif. Exchange Admin API membuat proses ini lebih mudah dan efisien. Dengan fitur-fiturnya yang andal, Anda dapat membuat, memperbarui, atau menghapus akun pengguna dengan cepat. Selain itu, API ini memungkinkan Anda mengelola kotak surat secara efektif. API ini menyederhanakan alur kerja Anda dan menghemat waktu sehingga Anda dapat fokus pada hal yang benar-benar penting, yaitu tim Anda.
Poin Penting
Exchange Admin API menyederhanakan pengelolaan akun pengguna, sehingga Anda dapat membuat, memperbarui, dan menghapus akun secara efisien.
Gunakan OAuth 2.0 untuk autentikasi API yang aman. Metode ini melindungi kredensial pengguna dengan menggunakan token akses sebagai pengganti kata sandi.
Selalu amankan token akses Anda untuk mencegah akses tidak sah dan potensi pelanggaran data.
Terapkan strategi penanganan kesalahan untuk mengatasi masalah umum, seperti akses tidak sah atau permintaan yang tidak valid, secara efektif.
Perhatikan batas laju (rate limit) saat menggunakan API. Pantau penggunaan Anda dan pertimbangkan untuk mengelompokkan permintaan agar tetap dalam batas.
7 Fakta Mengejutkan tentang Exchange Admin API
Jika Anda mengelola Exchange Online, Exchange Admin API dapat mengubah cara Anda mengotomatiskan, mengamankan, dan memantau lingkungan Anda. Berikut tujuh fakta mengejutkan tentang Exchange Admin API.
- API ini menyediakan pengelolaan kotak surat yang melampaui Graph API. Meskipun Microsoft Graph mencakup banyak skenario pengguna dan kotak surat, Exchange Admin API menyediakan endpoint khusus untuk konfigurasi dan pengelolaan yang spesifik untuk Exchange yang tidak tersedia di Graph, sehingga menjadi pilihan utama untuk otomatisasi Exchange Online yang mendalam.
- RBAC terperinci dan persetujuan admin diperlukan. API ini menerapkan kontrol akses berbasis peran yang berfokus pada Exchange, dan sering kali memerlukan persetujuan admin secara eksplisit untuk operasi sensitif. Oleh karena itu, pembatasan izin seminimal mungkin dan service principal khusus sangat penting untuk otomatisasi yang aman.
- Mendukung operasi batch dan massal untuk skala besar. Exchange Admin API memungkinkan pola pengelolaan bergaya batch dan massal (misalnya, memperbarui kebijakan di banyak kotak surat), yang secara signifikan mengurangi jumlah panggilan dan menyederhanakan pengelolaan penyewa dalam skala besar.
- Memiliki pembatasan dan throttling tingkat penyewa yang berbeda dari Graph. Aturan throttling dan batas permintaan berbeda dari Microsoft Graph. Anda harus merancang logika retry dan backoff secara khusus untuk perilaku Exchange Admin API agar terhindar dari kegagalan tak terduga saat beban tinggi.
- Memungkinkan kontrol kepatuhan dan audit tingkat lanjut. API ini menghadirkan fitur kepatuhan khusus Exchange, seperti aturan alur surat, penetapan kebijakan retensi, dan konfigurasi audit, sehingga kebijakan organisasi dapat ditegakkan secara terprogram dalam skala besar.
- Terintegrasi dengan lingkungan Exchange hybrid. Untuk organisasi dalam mode hybrid, Exchange Admin API dapat digunakan bersama alat pengelolaan on-premises untuk mengoordinasikan pengaturan dan kebijakan, sehingga memudahkan skenario migrasi dan koeksistensi.
- Dapat diperluas dengan PowerShell dan alur autentikasi modern. Anda dapat mengombinasikan modul Exchange Online PowerShell dan Exchange Admin API menggunakan autentikasi app-only OAuth 2.0 atau alur delegated, sehingga memungkinkan otomatisasi yang modern dan aman sekaligus mempertahankan kemampuan PowerShell lama bila diperlukan.
Gunakan Exchange Admin API untuk melengkapi Microsoft Graph dan PowerShell demi pengelolaan Exchange Online yang andal, skalabel, dan aman.
Metode Autentikasi
Sumber Gambar: unsplashIkhtisar OAuth 2.0
Saat Anda bekerja dengan Exchange Admin API, memahami OAuth 2.0 itu penting. Kerangka kerja ini meningkatkan keamanan dengan memungkinkan aplikasi mengakses sumber daya tanpa mengungkap kredensial pengguna. Alih-alih membagikan kata sandi, Anda menggunakan token akses, yang secara signifikan mengurangi risiko akses tidak sah. Berikut beberapa fitur utama OAuth 2.0 yang menjadikannya pilihan andal untuk autentikasi API:
Fitur | Deskripsi |
|---|---|
Otorisasi berbasis token mengurangi risiko terungkapnya kredensial pengguna dan menyediakan metode yang lebih aman untuk akses API. | |
Kontrol Akses Terperinci | OAuth 2.0 memungkinkan pengelolaan izin yang terperinci melalui scope, sehingga organisasi dapat mengontrol dengan tepat sumber daya apa saja yang dapat diakses oleh klien. |
Fleksibilitas | Kerangka kerja ini mendukung berbagai alur otorisasi, sehingga cocok untuk berbagai jenis aplikasi dan skenario penerapan. |
Skalabilitas | API gateway dapat menangani validasi dan pengelolaan token secara efisien, mendukung lalu lintas API bervolume tinggi tanpa mengorbankan performa. |
Memperoleh Token Akses
Untuk berinteraksi dengan Exchange Admin API, Anda perlu memperoleh token akses. Berikut panduan langkah demi langkah sederhana untuk membantu Anda melalui prosesnya:
Daftarkan aplikasi di Microsoft Entra ID.
Tetapkan izin API yang diperlukan.
Tetapkan izin RBAC.
Mengamankan token akses Anda sangat penting. Jika token tidak dilindungi, token dapat menimbulkan risiko keamanan yang serius. Berikut beberapa potensi bahaya dari token akses yang tidak aman:
API dapat membocorkan data sensitif jika tidak diamankan dengan benar.
Token akses yang tidak aman dapat menyebabkan akses tidak sah dan manipulasi data.
Meningkatnya serangan API menegaskan perlunya langkah-langkah keamanan yang andal.
Selain itu, jika seseorang menyamar sebagai Global Admin, mereka dapat memperoleh kendali penuh atas penyewa Anda, termasuk akses ke layanan seperti SharePoint Online dan Exchange Online. Hal ini dapat berujung pada pelanggaran data yang signifikan.
Untuk menetapkan peran RBAC Exchange Online kepada aplikasi untuk akses API, ikuti langkah-langkah berikut:
Untuk skenario delegated, pastikan pengguna memiliki peran RBAC yang diperlukan di Exchange Online, seperti Recipient Management atau Organization Management.
Untuk skenario app-only, tetapkan peran Microsoft Entra atau grup peran RBAC Exchange kustom ke service principal yang merepresentasikan aplikasi Anda.
Gunakan alur token akses OAuth 2.0 yang sesuai dengan jenis aplikasi Anda, baik delegated maupun app-only.
Instal Exchange Online PowerShell dan hubungkan ke sana.
Buat service principal baru dan tetapkan peran yang diperlukan.
Verifikasi penetapan peran dan uji RBAC untuk aplikasi.
Dengan mengikuti panduan ini, Anda dapat secara efektif mengelola akun pengguna sekaligus memastikan interaksi API Anda tetap aman.
Mengelola Akun Pengguna dengan Exchange Admin API
Membuat Akun Pengguna
Membuat akun pengguna dengan Exchange Admin API itu mudah. Anda perlu menyediakan bidang spesifik untuk menyiapkan pengguna baru. Berikut daftar cepat parameter yang diperlukan:
Alias: Ini adalah nama pengguna untuk akun tersebut.
Name: Nama lengkap pengguna.
FirstName: Nama depan pengguna.
LastName: Nama belakang pengguna.
DisplayName: Cara nama pengguna ditampilkan di direktori.
MicrosoftOnlineServicesID: Alamat email yang terkait dengan akun.
Password: Anda perlu meminta input ini.
ResetPasswordOnNextLogon: Parameter ini opsional, tetapi dapat diatur ke true jika Anda ingin pengguna mengubah kata sandinya saat pertama kali masuk.
Berikut contoh sederhana cara membuat akun pengguna menggunakan PowerShell:
New-MgUser -AccountEnabled $true -DisplayName "Holly Holt" -MailNickname "hollyh" -UserPrincipalName "hollyh@corp.contoso.com" -PasswordProfile @{ForceChangePasswordNextSignIn=$true; Password="YourSecurePassword"}
Memperbarui Informasi Pengguna
Memperbarui informasi pengguna sama mudahnya. Anda dapat mengubah berbagai atribut akun pengguna melalui Exchange Admin API. Berikut beberapa atribut umum yang mungkin ingin Anda perbarui:
Parameter | Deskripsi |
|---|---|
ModifiedObjectResolvedName | Nama yang mudah dipahami dari objek yang diubah. |
ModifiedProperties | Berisi nama properti yang diubah, nilai barunya, dan nilai sebelumnya. |
ExternalAccess | Menunjukkan apakah perintah dijalankan oleh pengguna internal atau personel eksternal. |
Untuk memperbarui pengguna, Anda dapat menggunakan perintah seperti ini:
Update-MgUser -UserId "<userId>" -DisplayName "Holly Holt Updated"
Perintah ini memperbarui nama tampilan pengguna dengan ID pengguna yang ditentukan.
Menghapus Akun Pengguna
Saat menghapus akun pengguna, Anda perlu mengikuti beberapa langkah agar prosesnya berjalan lancar. Berikut panduan singkatnya:
Hubungkan ke penyewa Microsoft 365 Anda menggunakan PowerShell dengan izin yang diperlukan.
Gunakan perintah
Connect-MgGraph -Scopes User.Read.All, User.ReadWrite.Alluntuk membuat koneksi.Ambil ID pengguna dengan memfilter berdasarkan nama tampilan menggunakan
Get-MgUser -Filter "displayName eq '<display name>'".Hapus akun pengguna dengan perintah
Remove-MgUser -UserId <userId> -Confirm:$false.
Proses ini memastikan Anda dapat mengelola akun pengguna secara efisien, sekaligus menjaga organisasi tetap aman dan tertata.
Mengambil Kotak Surat untuk Pengelolaan yang Efektif
Pengambilan kotak surat sangat penting untuk pengelolaan akun pengguna yang efektif. Berikut beberapa praktik terbaik yang perlu diperhatikan:
Selalu gunakan POST untuk semua operasi, termasuk cmdlet Get-*.
Sertakan hanya parameter yang didukung oleh cmdlet dalam endpoint.
Gunakan X-AnchorMailbox untuk semua operasi agar permintaan diarahkan dengan benar.
Gunakan
$selectuntuk memperkecil ukuran muatan respons, terutama saat menangani kumpulan data yang besar.Kombinasikan
$selectdengan paginasi untuk mengelola data dalam jumlah besar secara efisien.
Dengan mengikuti pedoman ini, Anda dapat merampingkan pengelolaan kotak surat dan memastikan akun pengguna Anda selalu termutakhir.
Praktik Terbaik untuk Exchange Admin API
Penanganan Error
Saat bekerja dengan Exchange Admin API, Anda mungkin menemui error. Mengetahui cara menanganinya secara efektif dapat menghemat waktu dan mengurangi frustrasi. Berikut tabel praktis yang merangkum kode error umum
Kode Error | Penyebab | Perbaikan |
|---|---|---|
401 Unauthorized | Token OAuth hilang, tidak valid, atau kedaluwarsa. Cakupan (scope) tidak tepat. | Pastikan aplikasi Anda memiliki cakupan yang tepat. Dapatkan token baru jika sudah kedaluwarsa. Verifikasi TenantID. |
403 Forbidden | Peran RBAC tidak tersedia atau objek yang dikelola berada di luar cakupan Anda. | Tetapkan peran RBAC yang diperlukan. Pastikan objek berada dalam cakupan pengelolaan Anda. |
400 Bad Request | Parameter tidak didukung atau formatnya tidak benar. | Periksa detail cmdlet. Sertakan hanya parameter yang didukung. |
Base URL salah | Base URL yang digunakan tidak sesuai dengan lingkungan Anda. | Gunakan base URL yang benar untuk organisasi Anda. |
Masalah paginasi | Parameter berubah di antara panggilan berhalaman, atau @odata.nextLink diabaikan. | Jaga konsistensi parameter. Selalu kirim POST ke @odata.nextLink. |
Kesalahan perutean | Header X-AnchorMailbox tidak ada atau tidak benar untuk operasi yang berbasis kotak surat. | Sertakan X-AnchorMailbox dengan UPN atau alamat SMTP kotak surat. Validasi nilainya. |
Ketahanan | Terapkan logika retry untuk pembatasan (throttling) dan catat ID permintaan. | Validasi parameter sebelum mengirim permintaan untuk menghindari 400 Bad Request. |
Dengan menerapkan strategi ini, Anda dapat meminimalkan gangguan dan menjaga operasi tetap berjalan lancar.
Pertimbangan Pembatasan Laju (Rate Limiting)
Pembatasan laju adalah aspek penting lain yang perlu dipertimbangkan saat menggunakan Exchange Admin API. Fitur ini membantu menjaga performa API dan memastikan penggunaan yang adil bagi semua pengguna. Berikut beberapa tips yang perlu diperhatikan:
Pahami Batasannya: Kenali batas laju yang diterapkan oleh API. Pengetahuan ini membantu Anda merencanakan permintaan dengan tepat.
Terapkan Strategi Backoff: Jika Anda mencapai batas laju, terapkan strategi backoff. Artinya, tunggu sebentar sebelum mencoba ulang permintaan. Cara ini dapat mencegah Anda terblokir.
Pantau Penggunaan Anda: Pantau terus penggunaan API Anda. Alat pemantauan dapat membantu Anda melacak berapa banyak permintaan yang Anda buat dan kapan Anda mendekati batasnya.
Kelompokkan Permintaan: Jika memungkinkan, kelompokkan permintaan Anda. Pendekatan ini dapat mengurangi jumlah panggilan yang Anda buat dan membantu Anda tetap berada dalam batas.
Dengan memperhatikan pembatasan laju (rate limiting), Anda dapat memastikan interaksi Anda dengan Exchange Admin API tetap efisien dan efektif.
Singkatnya, Exchange Admin API adalah alat yang ampuh untuk mengelola akun pengguna secara efektif. Anda dapat membuat, memperbarui, dan menghapus akun dengan mudah, sehingga operasional organisasi Anda berjalan lancar. Ingat, mengamankan token akses Anda dan memahami penanganan kesalahan sangat penting untuk pengalaman yang mulus.
Untuk mendalami Exchange Admin API, pertimbangkan sumber daya berikut:
Artikel ini memandu Anda dalam melakukan panggilan pertama yang berhasil ke Exchange Online Admin API dan menjelaskan perilaku serta pola utama yang berlaku untuk semua endpoint.
Jadi, jangan ragu! Jelajahi API ini dan lihat bagaimana API ini dapat meningkatkan proses pengelolaan pengguna Anda. Selamat berkoding! 🚀
Pertanyaan Umum
Apa itu Exchange Admin API?
Exchange Admin API memungkinkan Anda mengelola akun pengguna dan kotak surat di Microsoft Exchange Online. API ini menyederhanakan tugas seperti membuat, memperbarui, dan menghapus akun pengguna, sehingga administrasi menjadi lebih efisien.
Bagaimana cara melakukan autentikasi dengan Exchange Admin API?
Anda melakukan autentikasi menggunakan OAuth 2.0. Daftarkan aplikasi Anda di Microsoft Entra ID, tetapkan izin, lalu dapatkan token akses untuk berinteraksi dengan API secara aman.
Dapatkah saya mengotomatiskan pengelolaan akun pengguna?
Ya! Anda dapat mengotomatiskan pengelolaan akun pengguna menggunakan skrip dengan PowerShell atau bahasa pemrograman lain. Cara ini menghemat waktu dan mengurangi kesalahan manual dalam administrasi pengguna.
Apa yang harus saya lakukan jika menemui kesalahan?
Periksa kode kesalahan dan rujuk dokumentasi untuk langkah pemecahan masalah. Masalah umum meliputi token yang tidak valid atau izin yang hilang. Sesuaikan permintaan Anda sesuai kebutuhan.
Bagaimana cara memantau penggunaan API saya?
Anda dapat memantau penggunaan API dengan menerapkan logging di aplikasi Anda. Lacak jumlah permintaan yang dibuat dan perhatikan setiap peringatan batas laju untuk menghindari gangguan.
Apa itu Exchange Admin API dan bagaimana hubungannya dengan Exchange Online?
Exchange Admin API adalah API administratif berbasis REST yang baru diluncurkan Microsoft untuk mendukung tugas administrasi Exchange bagi Exchange Online dan Office 365 Exchange Online. API admin ini adalah pendekatan berbasis REST yang dirancang untuk membantu organisasi memodernisasi otomatisasi, dengan menyediakan endpoint Admin API yang menjalankan sekumpulan cmdlet dan parameter Exchange yang terfokus untuk skenario pengelolaan umum yang sebelumnya ditangani dengan EWS atau Exchange Online PowerShell.
Apakah Exchange Admin API menggantikan Exchange Web Services (EWS)?
API baru ini bukan pengganti langsung satu lawan satu untuk semua skenario EWS, tetapi dimaksudkan untuk membantu organisasi beralih dari EWS secara bertahap. Microsoft telah mengumumkan jadwal penghentian dan panduan, seperti penghentian pada Oktober 2026 untuk skenario EWS tertentu. Pratinjau publik Admin API menyediakan alternatif REST API untuk banyak skenario administrasi Exchange dan memodernisasi otomatisasi.
Tugas admin apa saja yang didukung oleh endpoint Admin API?
API ini mendukung sekumpulan terbatas tugas administrasi Exchange Online yang berfokus pada tugas manajemen Exchange seperti mengelola domain yang diterima, pengaturan izin folder kotak surat, serta penetapan delegasi dan izin, dan tugas administrasi Exchange lainnya. Admin API adalah antarmuka administratif berbasis REST yang dirancang untuk mendukung skenario administrasi Exchange umum serta memungkinkan skrip dan otomatisasi berbasis REST, berdampingan dengan cmdlet PowerShell dan skrip PowerShell.
Bagaimana dampaknya bagi administrator Office 365 dan Office 365 Exchange Online?
Bagi administrator Office 365 dan Office 365 Exchange Online, pratinjau Exchange menyediakan jalur untuk memodernisasi dengan REST API dan mengurangi ketergantungan pada kode EWS dan cmdlet Exchange. Administrator dapat menggunakan endpoint Admin API atau terus menggunakan Exchange Online PowerShell, sementara Microsoft terus memperluas kemampuan pratinjau publik Admin API yang tersedia. Hal ini membantu organisasi bermigrasi dari EWS dan mengadopsi otomatisasi modern yang terintegrasi dengan alur kerja pengelolaan Microsoft 365.
Bagaimana dengan Exchange Online PowerShell dan cmdlet PowerShell yang ada, apakah akan dihapus?
Exchange Online PowerShell dan cmdlet PowerShell tetap menjadi opsi yang didukung untuk banyak tugas. Admin API dirancang untuk melengkapi cmdlet dan parameter Exchange dengan menyediakan alternatif berbasis REST untuk skenario administrasi Exchange tertentu. Microsoft telah merilis pratinjau Exchange admin API beserta panduan untuk menggunakan skrip PowerShell dan admin API secara bersamaan. Beberapa skenario masih memerlukan Exchange Online PowerShell hingga endpoint admin API mencakup lebih banyak fungsi Exchange.
Kapan EWS akan dihentikan, dan apa yang sebaiknya dilakukan organisasi sebelum Oktober 2026?
Microsoft mengumumkan penghentian (deprecation) pada Oktober 2026 untuk penggunaan EWS tertentu, dan menganjurkan organisasi untuk merencanakan migrasi dari EWS pada skenario administrasi Exchange tertentu. Admin sebaiknya membuat inventaris kode EWS, penggunaan EWS untuk keperluan administrasi Exchange tertentu, dan semua skenario EWS di lingkungan mereka. Setelah itu, evaluasi pratinjau publik admin API, alternatif REST API, dan Exchange Online PowerShell untuk memodernisasi otomatisasi sebelum penghentian pada Oktober 2026.
Apakah admin API dapat mengelola izin mailbox seperti mailboxfolderpermission dan delegasi?
Ya, admin API mendukung pengelolaan mailboxfolderpermission dan penugasan delegasi untuk banyak skenario. Endpoint yang tersedia memungkinkan admin mengatur atau mengubah pengaturan delegasi dan izin. Meskipun pada awalnya admin API mungkin hanya menyediakan rangkaian terbatas, API ini dirancang untuk membantu organisasi mengotomatisasi tugas administrasi Exchange tertentu tanpa hanya bergantung pada kode EWS atau cmdlet Exchange.
Bagaimana cara mengakses admin API dalam pratinjau publik, dan autentikasi apa yang diperlukan?
Admin API tersedia dalam pratinjau publik dan memerlukan autentikasi modern melalui Microsoft identity platform (Azure AD/Entra). Administrator mendaftarkan aplikasi, memberikan scope yang sesuai untuk akses API Exchange Online, lalu memanggil endpoint admin API berbasis REST untuk melakukan pengelolaan Exchange. Pendekatan ini memungkinkan integrasi dengan otomatisasi, skrip, dan kerangka kerja pengelolaan Microsoft 365 yang sudah ada.
Apakah ada batasan pada admin API selama pratinjau publik?
Selama pratinjau publik admin API, API ini mungkin hanya menyediakan kemampuan yang terbatas dibandingkan dengan seluruh cmdlet Exchange atau EWS. Pratinjau ini berfokus pada tugas administrasi Exchange yang relevan dan sebagian fungsi Exchange. Organisasi sebaiknya memvalidasi skenario administrasi mereka dan memodernisasi otomatisasi dengan mengombinasikan endpoint admin API dengan Exchange Online PowerShell bila diperlukan, hingga API mendukung tugas pengelolaan Exchange yang lebih luas.
Bagaimana organisasi sebaiknya merencanakan strategi migrasi dari EWS ke admin API berbasis REST yang baru?
Organisasi sebaiknya memetakan beban kerja Exchange yang bergantung pada EWS, mengidentifikasi skenario administrasi Exchange tertentu serta skenario EWS yang dibutuhkan untuk keperluan tersebut, lalu memprioritaskan migrasi otomatisasi berdampak tinggi ke admin API atau Exchange Online PowerShell. Gunakan pratinjau publik admin API untuk menguji skenario administrasi dan memodernisasi otomatisasi, perbarui skrip PowerShell dan kode EWS jika diperlukan, serta pantau panduan Microsoft mengenai penghentian dan ketersediaan di masa mendatang hingga Oktober 2026 dan seterusnya.