यह पृष्ठ डेवलपर्स के लिए है. आपके संगठन का लॉगइन मानक है ओऑथ 2.0और ओपनआईडी कनेक्टName प्रदाता, इसलिए कोई भी अनुप्रयोग या उपकरण अपने Kamo खाते के साथ आपके लोगों को लॉगइन कर सकता है और, उनकी अनुमति के साथ, API और Kamo MCP सर्वर के माध्यम से उनके Kamo आंकड़ों के साथ काम कर सकता है. यहाँ कुछ भी एक विक्रेता या एक प्रकार के अनुप्रयोग के लिए विशिष्ट नहीं है.
प्रारंभ करने से पहले
- एक प्रशासक खोलता है विन्यास (S), तो सुरक्षा, पहचान तथा लॉगइन, जुड़े अनुप्रयोग, और आपके अनुप्रयोग को जोड़ता है (देखें एक अनुप्रयोग जोड़ें). वे एक मिलता है क्लाएंट ID, और एक वेबसाइट के लिए एक गोपनीय क्लाएंट, एक बार दिखाया.
- आपका अनुप्रयोग से बाकी सब कुछ पढ़ता है डिस्कवरी पता उदाहरण के लिए, अनुप्रयोग के कार्ड पर
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 (एक ताज़ा टोकन के साथ जुड़े रहें).
नीचे दी गई डाटा अनुमतियाँ किसी के लिए अनुप्रयोग को API का उपयोग करने देता है. प्रत्येक Kamo अनुमतियों के लिए खड़ा है जो व्यक्ति के पास पहले से ही है. एक अनुप्रयोग कभी भी अधिक नहीं कर सकता है जितना व्यक्ति Kamo में स्वयं कर सकता है: जब एक टोकन जारी किया जाता है तो यह केवल डाटा अनुमतियों को लेता है जिनकी Kamo अनुमतियाँ व्यक्ति के पास है, और हर कॉल को फिर से जाँचा जाता है कि वे उस समय क्या रखते हैं. मिटाना कभी भी एक अनुप्रयोग के लिए उपलब्ध नहीं है.
स्कोप | क्या यह अनुमति देता है | Kamo अनुमति इसकी आवश्यकता है (कोई भी) |
|---|---|---|
| संपर्क और उनके विवरण पढ़ें | संपर्क देखें |
| संपर्क बनाएँ और उनके विवरण संपादित करें | संपर्क बनाएँ, संपर्क संपादित करें |
| अपने स्थिति और इतिहास के साथ देखे जाने वाले लिड को पढ़ें | लीड्स देखें |
| लीड्स बनाएँ, उन्हें संपादित करें और उन्हें पाइपलाइन के माध्यम से खिसकाएँ | लीड्स बनाएँ, लीड्स संपादित करें, लीड स्टेज खिसकाएँ |
| अपने पंचांग और उसकी घटनाओं को पढ़ें | पंचांग देखें |
| अपने पंचांग में घटनाएँ बनाएँ तथा बदलें | पंचांग देखें |
| Kamo में खोलने योग्य डाकपेटियों को पढ़ें | मेल एक्सेस करें |
| मेलबाक्सों से ईमेल लिखें और भेजें जो आप उपयोग कर सकते हैं | मेल एक्सेस करें |
| अपनी टिप्पणियाँ और चेकलिस्ट पढ़ें | नोट्स देखें, कार्य देखें |
| टिप्पणियाँ तथा चेकलिस्ट बनाएँ तथा संपादित करें | नोट्स बनाएँ, नोट्स संपादित करें |
| दस्तावेज़ और फ़ाइलें जिन्हें आप खोल सकते हैं उन्हें पढ़ें | दस्तावेज़ देखें |
| दस्तावेज़ अपलोड करें तथा संपादित करें | दस्तावेज़ बनाएँ, दस्तावेज़ संपादित करेंName |
| अपने संगठन के ज्ञान आधार आलेखों को पढ़ें | केबी आलेख देखें |
| ज्ञान- आधार आलेख बनाएँ तथा संपादित करें | केबीए आलेख बनाएँ, केबीए आलेख संपादित करें |
| अपनी बैठकों और उनके विवरणों को पढ़ें | बैठकें देखें |
| बैठकों को सारणीबद्ध करें, बदलें और प्रारंभ करें | बैठक प्रारंभ करें, बैठक प्रबंधित करें |
उसी सूची, हमेशा वर्तमान, पर है https://api.<your domain>/api/security/oidc/scopes% 1 को%2से जोड़ा गया write अनुमति भी अनुप्रयोग को उसी प्रकार के डाटा को पढ़ने देता है.
एक अनुप्रयोग केवल उन अनुमतियों के लिए पूछ सकता है जो इसे दी गई थी. आपके प्रशासक उन्हें चुनते हैं जब अनुप्रयोग को जोड़ा जाता है: नीचे के लॉगइन वाले यह क्या देख सकता है, डाटा के नीचे एक Kamo डाटा के साथ काम करें, एक देखें और एक बदलें प्रत्येक प्रकार के आंकड़े के लिए स्विच करें, प्रत्येक Kamo अनुमति दिखाता है जिसकी उसे आवश्यकता है. उनसे पूछें कि वे ठीक उसी स्कोप पर स्विच करें जिसका आप अनुरोध करते हैं; एक के लिए पूछना जिसके लिए अनुप्रयोग को दिया नहीं गया था असफल होता है invalid_scope.
किसी को साइन इन करें (पीकेसीई के साथ प्रमाणीकरण कोड)
एक 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 पता पर पहुँच टोकन भेजें:
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. कोई भी एमसीपी क्लाएंट जो एमसीपी प्रमाणीकरण को समर्थन देता है कनेक्ट हो सकता है: अपने पहले कॉल पर यह प्राप्त करता है 401 के साथ WWW-Authenticate इस पर इशारा करने वाला शीर्षक https://api.yourcompany.com/.well-known/oauth-protected-resource/mcp, जो आपके संगठन के लॉगइन को प्राधिकार सर्वर के रूप में नामित करता है. क्लाएंट तब खुद को पंजीकृत करता है (यदि स्वीकार्य हो) या प्रशासक द्वारा दिए गए क्लाएंट आईडी का उपयोग करता है, व्यक्ति को ऊपर के रूप में साइन करता है, और भेजता है Authorization: Bearer ACCESS_TOKEN प्रत्येक MCP अनुरोध पर. औजार जो यह उपयोग कर सकता है वे बिल्कुल वही हैं जो व्यक्ति की अनुमतियाँ और टोकन के दायरे स्वीकार करते हैं.
एक टीवी या उपकरण पर लॉगइन करें
कुंजीपटल के बिना उपकरण उपकरण लॉगइन (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 सर्वर उनके लिए जवाब देना एक साथ बंद कर देता है (एक मिनट के भीतर), और ताज़ा करना असफल हो जाता है. लोग एक अनुप्रयोग को स्वयं भी हटा सकते हैं मेरा प्रोफ़ाइल, पहुँच के साथ अनुप्रयोग.
संबंधित लेख
इस प्रकार के प्रश्नों के उत्तर देने के लिये कुछ सूत्र दिए गए हैं।
एक अनुप्रयोग जोड़ें
एक अनुप्रयोग को जोड़ने में सात छोटे कदम लगते हैं. खोलें विन्यास (S), तो सुरक्षा, चुनें पहचान तथा लॉगइन, तो जुड़े अनुप्रयोग, और दबाएँ एक अनुप्रयोग जोड़ेंआप की जरूरत है जुड़े अनुप्रयोगों का प्रबंधन करें अनुमति दें. तब तक…
अनुप्रयोगों को स्वयं कनेक्ट होने दें
कुछ अनुप्रयोग, जैसे कि AI सहायक जो MCP और कमांड-लाइन उपकरणों का उपयोग करते हैं, अपने आप को आपके संगठन के लॉगइन से जोड़ सकते हैं बजाय प्रशासक द्वारा उन्हें टाइप करने के. इसे कहा जाता है गतिशील पंजीकरणयह है बन्द जब तक आप…
जुड़े अनुप्रयोग
कनेक्टेड एप्लीकेशन आपके लोगों को अन्य वेबसाईट और अनुप्रयोगों में लॉगइन करने देता है, जैसे WordPress, Grafana, Moodle, Nextcloud या आपकी अपनी वेबसाईट, Kamo खाते के साथ जो उनके पास पहले से ही है. यह इस तरह काम करता है…
पहुँच के साथ अनुप्रयोग
आपका संगठन आपको अपने संगठन खाता के साथ अन्य वेब साइटों और अनुप्रयोगों में लॉगइन करने देता है, जैसे कि कंपनी ब्लॉग, डैशबोर्ड या प्रशिक्षण साइट. पहली बार जब आप ऐसा करते हैं, अनुप्रयोग पूछ सकता है कि यह क्या देख सकता है,…
स्वचालित प्रविष्टि
स्वचालित प्रावधान आपके पहचान प्रदाता को Kamo को अपने आप अद्यतन रखने देता है. आपके प्रदाता में जोड़ा गया कोई Kamo में दिखाई देता है, उनके कार्य शीर्षक या विभाग में परिवर्तन उन्हें अनुवर्तित करता है, और आपके प्रदाता में…
