Halaman ini untuk pengembang. Log masuk organisasi Anda adalah standar OAuth 2.0 dan OpenID Connect provider, sehingga aplikasi atau alat apapun dapat log masuk dengan Kamo akun mereka dan, dengan izin mereka, bekerja dengan Kamo data mereka melalui API dan Kamo server MCP. Tidak ada di sini yang spesifik untuk satu vendor atau satu jenis aplikasi.
Sebelum Anda Memulai
- Seorang administrator membuka Pengaturan, maka Keamanan, Identitas & Login, Aplikasi Terhubung, dan menghubungkan aplikasi Anda (lihat Sambungkan Aplikasi). Mereka mendapatkan ID klien, dan untuk situs web a klien rahasia, ditampilkan sekali.
- Aplikasi Anda membaca segalanya dari discovery address pada kartu aplikasi, misalnya
https://login.yourcompany.com/.well-known/openid-configurationOrganisasi tanpa alamat web mereka sendiri memiliki satu sepertihttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configurationSetiap alamat lain di halaman ini dimulai dengan yang sama penerbit.
Keizinan (Skope)
Sebuah aplikasi meminta izin dengan scope. Keizinan masuk adalah openid (selalu diperlukan), profile, email, phone, kamo.org, kamo.roles dan offline_access (Tetap terhubung dengan token refresh).
Keizinan data di bawah ini memungkinkan aplikasi menggunakan API atas nama seseorang. Masing-masing mewakili Kamo izin yang sudah dimiliki orang tersebut. Sebuah aplikasi tidak pernah bisa melakukan lebih dari yang orang dapat lakukan di Kamo sendiri: ketika sebuah token dikeluarkan, ia hanya membawa izin data yang Kamo izinnya dipegang oleh orang tersebut pada saat itu, dan setiap panggilan dicek lagi dengan apa yang dipegang pada saat itu. Penghapusan tidak pernah tersedia untuk sebuah aplikasi.
Skop | Apa yang memungkinkan | Kamo izin yang dibutuhkan (apapun dari) |
|---|---|---|
| Baca kontak dan rinciannya | Lihat Kontak |
| Buat kontak dan sunting rinciannya | Buat Kontak, Sunting Kontak |
| Baca petunjuk yang bisa Anda lihat, dengan status dan sejarah mereka | Lihat Leads |
| Buat leads, edit mereka dan pindahkan mereka melalui pipa | Buat Lead, Ubah Lead, Pindah Lead Stage |
| Baca kalender dan peristiwanya | Tampilkan Kalender |
| Buat dan ubah peristiwa pada kalender Anda | Tampilkan Kalender |
| Baca kotak surat yang dapat Anda buka di Kamo | Akses Surat |
| Tulis dan kirim surel dari kotak surat yang dapat Anda gunakan | Akses Surat |
| Baca catatan dan daftar periksa Anda | Lihat Catatan, Lihat Tugas |
| Buat dan sunting catatan dan daftar periksa | Buat Catatan, Sunting Catatan |
| Baca dokumen dan berkas yang dapat Anda buka | Lihat Dokumen |
| Unggah dokumen dan sunting mereka | Buat Dokumen, Sunting Dokumen |
| Baca artikel basis pengetahuan organisasi Anda | Lihat Artikel KB |
| Buat dan sunting artikel basis pengetahuan | Buat Artikel KB, Sunting Artikel KB |
| Baca rapat Anda dan rinciannya | Tampilkan Rapat |
| Jadwal, ubah dan mulai rapat | Mulai Rapat, Urus Rapat |
Daftar yang sama, selalu saat ini, adalah di https://api.<your domain>/api/security/oidc/scopesDan... write izin ini juga memungkinkan aplikasi untuk membaca jenis data yang sama.
Sebuah aplikasi hanya dapat meminta izin yang telah diberikan. Administrator Anda memilihnya saat menghubungkan aplikasi: yang masuk di bawah Apa yang bisa dilihat, data yang di bawah Bekerja Dengan Data Kamo, satu Lihat dan satu Ubah switch per jenis data, masing-masing menampilkan Kamo izin yang dibutuhkannya. Minta mereka untuk menyalakan tepat pada skop yang Anda minta; meminta untuk satu aplikasi tidak diberikan gagal dengan invalid_scope.
Daftarkan Seseorang (Kode Otorisasi Dengan PKCE)
Kirim peramban orang ke alamat otorisasi dengan tantangan PKCE:
https://login.yourcompany.com/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID
&redirect_uri=https%3A%2F%2Fapp.example.com%2Fcallback&scope=openid%20profile%20contacts.read%20offline_access
&state=RANDOM&code_challenge=BASE64URL_SHA256_OF_VERIFIER&code_challenge_method=S256Mereka masuk, lihat apa yang aplikasi Anda meminta dalam kata-kata sederhana, dan tekan Izinkan. Alamat redirect Anda menerima code, state dan iss. Tukar kode untuk token:
curl -X POST https://login.yourcompany.com/oauth/token \
-u YOUR_CLIENT_ID:YOUR_CLIENT_SECRET \
-d grant_type=authorization_code -d code=THE_CODE \
-d redirect_uri=https://app.example.com/callback -d code_verifier=THE_VERIFIERAplikasi yang tidak dapat menyimpan rahasia (satu halaman, ponsel, desktop, baris perintah) kirim client_id=YOUR_CLIENT_ID bukan -uJawabannya ada access_token (yaitu) tanda (yang menunjukkan kebenaran), id_token (yang mendaftar), refresh_token (hanya dengan offline_access) dan scope (apa yang benar-benar membawa token).
Panggil API
Kirim token akses ke alamat API organisasi Anda:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 dengan
WWW-Authenticate: Bearer error="invalid_token": token telah habis berlaku, telah dicabut, atau orang tersebut tidak lagi memiliki akses. Ulangi atau masuk lagi. - 403 dengan
error="insufficient_scope", scope="contacts.write": token tidak membawa izin yang diperlukan oleh alamat. Minta pada saat login. - Reading (
GET) membutuhkanreadizin dari jenis data itu; apapun yang mengubah data perluwrite.
Biarkan Aplikasi Anda Terdaftar Sendiri
Jika administrator menyalakan Biarkan Aplikasi Terhubung Sendiri (lihat artikel itu), sebuah aplikasi dapat mendaftar tanpa ada yang mengetiknya, menggunakan permintaan pendaftaran standar (RFC 7591). Alamatnya ada dalam dokumen penemuan sebagai registration_endpoint:
curl -X POST https://login.yourcompany.com/oauth/register -H "Content-Type: application/json" -d '{
"client_name": "My Tool", "redirect_uris": ["http://127.0.0.1:33418/callback"],
"token_endpoint_auth_method": "none", "grant_types": ["authorization_code", "refresh_token"],
"scope": "openid contacts.read leads.read offline_access" }'Jawabannya ada padamu client_id (dan client_secret untuk aplikasi yang menyimpan satu) dan kamo_status. TERJADI artinya administrator harus menyetujuinya di Aplikasi Terhubung sebelum siapapun dapat masuk; sampai saat itu masuk menunjukkan "Aplikasi ini menunggu persetujuan". Ketika pendaftaran dimatikan alamat menjawab 404.
Sambungkan Asisten AI Atau Klien MCP
Server MCP Kamo berada di https://api.yourcompany.com/mcp. Setiap klien MCP yang mendukung otorisasi MCP dapat terhubung: pada panggilan pertamanya ia mendapatkan 401 dengan a WWW-Authenticate header menunjuk ke https://api.yourcompany.com/.well-known/oauth-protected-resource/mcp, yang menamai log masuk organisasi Anda sebagai server otorisasi. Klien kemudian mendaftarkan dirinya sendiri (jika diizinkan) atau menggunakan ID klien yang diberikan oleh administrator, log masuk orang seperti di atas, dan mengirim Authorization: Bearer ACCESS_TOKEN pada setiap permintaan MCP. alat yang bisa digunakan adalah persis yang diizinkan oleh orang dan skop token.
Daftar Masuk di TV Atau Perangkat
Perangkat tanpa papan ketik menggunakan log masuk perangkat (RFC 8628). Aplikasi ini membutuhkan TV Atau Perangkat type, or the device login on on:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"Tunjukkan pada orang itu user_code (seperti WDJB-MJHT) dan verification_uri, lalu poll setiap interval detik:
curl -X POST https://login.yourcompany.com/oauth/token -d grant_type=urn:ietf:params:oauth:grant-type:device_code \
-d device_code=THE_DEVICE_CODE -d client_id=YOUR_CLIENT_IDTerus polling sementara jawabannya adalah authorization_pending; on slow_down tunggu 5 detik lebih setiap kali kodenya bertahan 10 menit
When Someone Leaves
Menghapus akses seseorang di Kamo mengakhiri token mereka: API dan server MCP berhenti menjawab untuk mereka dengan segera (dalam satu menit), dan refresh gagal. Orang juga dapat menghapus aplikasi sendiri di Profilku, Aplikasi dengan Akses.
Artikel Terkait
Panduan lain yang menjawab pertanyaan yang dekat dengan ini.
Sambungkan Aplikasi
Menghubungkan aplikasi membutuhkan tujuh langkah singkat. Buka Pengaturan, maka Keamanan, pilih Identitas & Login, maka Aplikasi Terhubung, dan tekan Sambungkan AplikasiKau butuh Manage Connected Apps Permisi. Tidak ada…
Biarkan Aplikasi Terhubung Sendiri
Beberapa aplikasi, seperti AI asisten yang menggunakan MCP dan alat baris perintah, dapat menghubungkan diri mereka sendiri ke log masuk organisasi Anda daripada administrator mengetik mereka. Ini disebut pendaftaran…
Aplikasi Terhubung
Aplikasi Terhubung memungkinkan orang-orang Anda untuk masuk ke situs dan aplikasi lain, seperti WordPress, Grafana, Moodle, Nextcloud atau situs Anda sendiri, dengan akun Kamo yang mereka miliki. Berfungsi seperti ini…
Aplikasi dengan Akses
Organisasi Anda dapat membiarkan Anda masuk ke situs web dan aplikasi lain dengan akun organisasi Anda, seperti blog perusahaan, dashboard atau situs pelatihan. Kali pertama Anda melakukannya, aplikasi mungkin bertanya…
Provisioning Otomatis
Provisioning otomatis memungkinkan penyedia identitas Anda untuk memperbarui Kamo sendiri. Seseorang yang ditambahkan ke penyedia Anda muncul di Kamo, perubahan pada jabatan atau departemen mereka mengikuti mereka, dan…
