هذه الصفحة للمطورين OAuth 2.0 و OpenID Connect يقوم هذا البرنامج بتسجيل المستخدمين في حسابات Kamo الخاصة بهم، وبإذن منهم، يعمل مع بيانات Kamo الخاصة بهم من خلال واجهة برمجة التطبيقات وخادم Kamo MCP. لا شيء هنا محدد لبائع واحد أو نوع واحد من التطبيقات.
قبل أن تبدأ
- يفتتح أحد المديرين الإعداداتإذاً ألف - الأمن, الهوية والتسجيل, التطبيقات المتصلة, ويربط تطبيقك (انظر ربط تطبيقوهم يحصلون على هوية العميلوإنشاء موقع على شبكة الإنترنت(أ) عميل سري, يظهر مرة واحدة.
- تطبيقك يقرأ كل شيء آخر من عنوان الاكتشاف على بطاقة التطبيق، على سبيل المثال
https://login.yourcompany.com/.well-known/openid-configuration:: المنظمات التي ليس لها عنوان خاص بها على شبكة الإنترنت لها عنوان شبكي مثلhttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configurationكل عنوان آخر في هذه الصفحة يبدأ بنفس الرمز الجهة المصدرة.
الإذن (النطاقات)
التطبيق يطلب الإذن مع scope. أذون الدخول هي openid (مطلوب دائما)، profile, email, phone, kamo.org, kamo.roles و offline_access (ابقى متصلاً برمز تحديث)
تسمح إجازة البيانات أدناه للتطبيق باستخدام واجهة برمجة التطبيقات نيابة عن شخص ما. كل منها يمثل Kamo إجازة يملكها الشخص بالفعل. التطبيق لا يستطيع أبداً أن يفعل أكثر مما يستطيع الشخص أن يفعله في Kamo نفسه: عندما يتم إصدار رمز، فإنه يحمل فقط أذونات البيانات التي يملك الشخص Kamo من أذوناتها في ذلك الوقت، ويتم التحقق من كل مكالمة مرة أخرى مقارنة بما يملكه في ذلك الوقت.
ثانيا - النطاق | ما يسمح به | Kamo الإذن الذي يحتاجه (أي من) |
|---|---|---|
| قراءة جهات الاتصال وتفاصيلها | رؤية الاتصالات |
| إنشاء جهات الاتصال وتحرير تفاصيلها | إنشاء جهات الاتصال، تعديل جهات الاتصال |
| اقرأ الأدلة التي يمكنك رؤيتها، مع وضعها وتاريخها | رؤية النتائج |
| إنشاء فرص جديدة وتحريرها ونقلها عبر قناة التوريد | إنشاء قنوات، وتحرير القنوات، ونقل مرحلة القنوات |
| قراءة تقويمك وأحداثه | انظر التقويم |
| إنشاء وتغيير الأحداث في تقويمك | انظر التقويم |
| قراءة صناديق البريد التي يمكنك فتحها في Kamo | البريد الإلكتروني |
| كتابة وإرسال البريد الإلكتروني من صناديق البريد التي يمكنك استخدامها | البريد الإلكتروني |
| اقرأ ملاحظاتك وقوائمك المرجعية | عرض الملاحظات، عرض المهام |
| إنشاء وتحرير الملاحظات والقوائم المرجعية | إنشاء الملاحظات، تحرير الملاحظات |
| قراءة الوثائق والملفات التي يمكنك فتحها | عرض الوثائق |
| تحميل الوثائق وتحريرها | إنشاء وثائق، تحرير وثائق |
| اقرأ مقالات قاعدة معارف منظمتك | مقالات قاعدة البيانات |
| إنشاء وتحرير مقالات قاعدة المعارف | إنشاء مقالات المعرفة، وتحرير مقالات المعرفة |
| اقرأ اجتماعاتك وتفاصيلها | انظر الاجتماعات |
| تحديد مواعيد الاجتماعات وتغييرها وبدءها | بدء الاجتماع، إدارة الاجتماع |
ويمكن الاطلاع على القائمة ذاتها، المستكملة دائما، على العنوان التالي: https://api.<your domain>/api/security/oidc/scopesألف - write الإذن أيضا يسمح التطبيق لقراءة نفس النوع من البيانات.
يمكن للتطبيق أن يطلب فقط الإذن الممنوح له. يختار مديرك هذه الإذن عند اتصال التطبيق: إذن الدخول تحت ما يمكن أن يرىالبيانات الواردة تحت العمل مع Kamo بيانات, واحد انظر وواحدة التغيير لكل نوع من أنواع البيانات، يبين كل منها Kamo أطلب منهم أن يشغلوا بالضبط النطاقات التي تطلبها؛ طلب واحد لم يمنح التطبيق يفشل مع invalid_scope.
تسجيل شخص ما (رمز الإذن مع PKCE)
أرسل متصفح الشخص إلى عنوان الإذن مع تحدي 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=S256يسجلون ، يرون ما يطلبه تطبيقك بكلمات بسيطة ، ويضغطون على السماح. يتلقى عنوان إعادة التوجيه الخاص بك code, state و issاستبدل الرمز بالرموز:
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_VERIFIERالتطبيقات التي لا تستطيع الاحتفاظ بسر (صفحة واحدة، الهاتف المحمول، سطح المكتب، سطر الأوامر) client_id=YOUR_CLIENT_ID بدلا من -uالإجابة هي access_token (رمز حامل) id_token )الذي وقع(، refresh_token )باستثناء offline_access) و scope (ما تحمل الرموز حقاً)
استدعاء API
أرسل رمز الدخول إلى عنوان API لمنظمتك:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 مع
WWW-Authenticate: Bearer error="invalid_token": انتهت صلاحية الرموز، أو ألغيت، أو لم يعد الشخص قادراً على الوصول إليها، فتحديثها أو الدخول مرة أخرى. - 403 مع
error="insufficient_scope", scope="contacts.write": لا تحمل الرموز الإذن الذي يحتاجه العنوان. اسأل عنها عند الدخول. - قراءة )
GET) يحتاج إلىreadأي شيء يغير احتياجات البياناتwrite.
دع تطبيقك يسجل نفسه
إذا قام أحد المديرين بتشغيل السماح للتطبيقات بالاتصال بنفسها (انظر تلك المقالة)، يمكن للتطبيق أن يسجل دون أن يكتبها أي شخص، باستخدام طلب التسجيل القياسي (RFC 7591) 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" }'الجواب هو لديك client_id )و client_secret بالنسبة للتطبيقات التي تحتفظ بواحد) و kamo_status. معلقة يعني أنه يجب على المدير الموافقة عليه في التطبيقات المتصلة قبل أن يتمكن أي شخص من التسجيل؛ حتى ذلك الحين يظهر التسجيل "هذا التطبيق ينتظر الموافقة". عندما يكون التسجيل منقطعًا، يجيب العنوان 404.
اتصال مساعد AI أو عميل MCP
الخادم Kamo MCP هو على https://api.yourcompany.com/mcpأي عميل MCP الذي يدعم MCP الإذن يمكن أن يربط: في أول استدعاء يحصل 401 مع WWW-Authenticate العنوان يشير إلى https://api.yourcompany.com/.well-known/oauth-protected-resource/mcpثم يسجل العميل نفسه (إذا كان مسموحاً به) أو يستخدم هوية عميل أعطها لك المدير، ويدخل الشخص كما هو مذكور أعلاه، ويرسل Authorization: Bearer ACCESS_TOKEN الأدوات التي يمكنه استخدامها هي بالضبط تلك التي تسمح بها تصاريح الشخص ونطاقات الرموز
تسجيل الدخول على جهاز تلفزيون أو جهاز
تستخدم الأجهزة التي لا تحتوي على لوحة مفاتيح تسجيل الدخول بالجهاز (RFC 8628) التلفزيون أو الجهاز النوع، أو تسجيل الدخول إلى الجهاز:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"أظهر للشخص user_code )مثل WDJB-MJHT)و( verification_uriثم اﻻستفتاء كل interval ثانية:
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_IDإستمروا بالاستفتاء حتى تكون الإجابة authorization_pending؛ واحد slow_down انتظر 5 ثواني إضافية في كل مرة مدة الشفرة 10 دقائق
عندما يغادر شخص ما
إزالة وصول شخص ما في Kamo تنتهي رموزهم: API و MCP الخادم توقف الرد لهم على الفور (خلال دقيقة)، وإعادة التحديث يفشل. يمكن للناس أيضا إزالة تطبيق أنفسهم في ملفي الشخصي, التطبيقات التي تتيح الوصول.
المقالات ذات الصلة
أدلة أخرى تجيب على أسئلة قريبة من هذا.
ربط تطبيق
يتطلب ربط التطبيق سبع خطوات قصيرة الإعداداتإذاً ألف - الأمن, اختار الهوية والتسجيلإذاً التطبيقات المتصلة، ثم اضغط ربط تطبيقأنت بحاجة إلى إدارة التطبيقات المتصلة إذن. لا يحفظ شيء حتى التطبيق على الخطوة 6، ولا أحد يتأثر…
السماح للتطبيقات بالاتصال بنفسها
بعض التطبيقات، مثل المساعدين AI الذين يستخدمون MCP وأدوات سطر الأوامر، يمكنهم الاتصال بأنفسهم بتسجيل الدخول لمنظمتك بدلاً من أن يقوم المدير بكتابتهم التسجيل الديناميإنه معطلة ما لم تشغله أين هو مفتوح الإعداداتإذاً ألف -…
التطبيقات المتصلة
التطبيقات المتصلة تسمح لعملائك بالدخول إلى مواقع وتطبيقات أخرى، مثل WordPress، Grafana، Moodle، Nextcloud أو موقعك الخاص، مع الحساب Kamo الذي لديهم بالفعل تسجيل الدخول باستخدام Googleحساب واحد وكلمة مرور واحدة لكل شيء،…
التطبيقات التي تتيح الوصول
قد تسمح لك مؤسستك بالدخول إلى مواقع وتطبيقات أخرى باستخدام حساب المؤسسة، مثل مدونة الشركة أو لوحات الأدوات أو موقع التدريب. في المرة الأولى التي تقوم فيها بذلك، قد يسألك التطبيق ما الذي يمكنه رؤيته، وتختار ما تريد رؤيته…
التخصيص التلقائي
يجعل الإمداد التلقائي مقدم هويتك Kamo يبقى محدثاً بنفسه. يظهر شخص أضيف في مقدم هويتك في Kamo، ويتبعه تغيير في لقب وظيفته أو إدارته، ويتم إنهاء شخص أزيل من مقدم هويتك في Kamo. المعيار وراء ذلك يسمى نظام المعلومات…
