authentication स्कोप वाली किसी नामित API कुंजी का उपयोग करें।
नीचे की हर कॉल आपके एप्लिकेशन की Authentication प्रबंधन API पर जाती है। MANAGEMENT_BASE यह है:
openapi-authentication.json में Setup टैग के अंतर्गत किया गया है, और सर्वर SDK इसी से जनरेट होते हैं।
किस क्रेडेंशियल का उपयोग करें
तीनों में से कोई भी क्रेडेंशियल काम करता है, और हर एक उसके मालिक द्वारा स्वीकृत दायरे तक सीमित रहता है।
इन क्रेडेंशियल्स को हर सेटअप रूट पर, अनुरोध जो भी माँगे,
403 के साथ अस्वीकार किया जाता है:
- एप्लिकेशन का प्राथमिक सीक्रेट।
POST /programmatic/loginसे मिला टोकन, जो कंसोल के बजाय एप्लिकेशन के लिए जारी होता है।authenticationस्कोप के बिना कोई कुंजी, जिसमें हर संसाधन के लिए उसके उच्चतम स्तर के साथ बनाई गई कुंजी भी शामिल है: उन्हें पूर्ण पहुँच के रूप में सूचीबद्ध किया जाता है,scopesखाली रहता है और इन रूटों पर स्वीकार नहीं किया जाता।- किसी दूसरे एप्लिकेशन की कुंजी, केवल
didit:verificationवाला ग्रांट, और किसी दूसरे संगठन के लिए स्वीकृत ग्रांट।
401 लौटाता है। ग्रांट या कुंजी की अपनी सीमाएँ भी लागू रहती हैं: ग्रांट की सीमा उसके स्कोप, संगठनों और व्यक्ति की भूमिका से तय होती है, और कुंजी की सीमा उसके स्कोप, IP अनुमति सूची और समाप्ति से।
पहुँच स्वीकृत करें
नामित API कुंजी के साथ
Business Console में Developers -> API keys खोलें और जिस एप्लिकेशन का सेटअप कर रहे हैं उसके लिए एक कुंजी बनाएँ। उसेauthentication संसाधन पर read या write अनुमति दें: read सेटअप पढ़ने वाली हर कॉल (GET) को कवर करता है; write सेटअप बदलने वाली हर कॉल (POST, PUT, PATCH, DELETE) को कवर करता है और सेटअप को पढ़ता भी है। समाप्ति, IP अनुमति सूची और रोटेशन के लिए API keys देखें; कुंजी एक ही एप्लिकेशन से जुड़ी होती है और केवल उसी के लिए काम करती है।
MCP कनेक्शन के माध्यम से
Didit MCP सर्वर से जुड़ा एजेंट उस अनुमति का उपयोग करता है जिसे उसके मालिक ने सहमति स्क्रीन पर स्वीकृत किया है, और उस ग्रांट मेंdidit:management शामिल होता है। देखें MCP प्रमाणीकरण।
बिना पासवर्ड वाले मालिक के लिए
डिवाइस-कोड ग्रांट (RFC 8628) उस मालिक को, जो Google, पासकी या ईमेल से भेजे गए कोड से साइन इन करता है, किसी भी ब्राउज़र से वही पहुँच स्वीकृत करने देता है, बिना पासवर्ड टाइप किए। देखें ब्राउज़र के बिना साइन इन करें।ईमेल कोड सक्षम करें
PUT methods/{name}/ के लिए enabled लिया जाता है, और जिस विधि को क्रेडेंशियल की ज़रूरत नहीं होती, उसके लिए इसके अलावा कुछ नहीं।
credential_source: null शामिल होता है। जो विधियाँ हमेशा चालू रहती हैं उन्हें बंद नहीं किया जा सकता: ऐसे अनुरोध का उत्तर {"enabled": "always_on"} होता है।
Google सक्षम करें
सोशल मेथड के लिए आप अपने OAuth ऐप के क्रेडेंशियल दे सकते हैं, या किसी सैंडबॉक्स एप्लिकेशन पर Didit का टेस्ट ऐप इस्तेमाल कर सकते हैं।अपने Google ऐप के साथ
callback_uri अपने प्रोवाइडर पर रजिस्टर करें। सीक्रेट केवल-लिखने योग्य है: कोई भी रिस्पॉन्स उसे वापस नहीं देता, और client_id ही वह हिस्सा है जिसे आप वापस पढ़ सकते हैं। अगर पहले कोई क्रेडेंशियल सहेजे नहीं गए थे, तो बिना क्रेडेंशियल के कोई मेथड चालू करने पर {"credentials": "required"} जवाब आता है।
Didit के टेस्ट ऐप (didit_test) के साथ
एक सैंडबॉक्स एप्लिकेशन आपके ऐप की जगह Didit के अपने सोशल ऐप इस्तेमाल कर सकता है। सेटअप पूरा करने और उसे काम करता हुआ साबित करने के लिए यह पर्याप्त है:
didit_test Google, Microsoft, Apple और GitHub को कवर करता है, और यह केवल सैंडबॉक्स एप्लिकेशन पर उपलब्ध है:
कॉन्फ़िगरेशन पर
GET करने पर didit_test_credentials में वे प्रोवाइडर दिखते हैं जिन्हें इस एप्लिकेशन के लिए टेस्ट ऐप सर्व कर सकता है। लाइव एप्लिकेशन पर इन चारों के लिए यह मान false होता है।
सेटअप को फिर से पढ़ें
MANAGEMENT_BASE पर GET ही रीड-बैक है: इसमें हर विधि के enabled और credential_source के साथ कॉलबैक URL, सत्र नियम और साइन-अप नीति मिलती है।
GET से पता चल जाता है कि कौन-सी चालू है और कौन-सी नहीं। जब एप्लिकेशन के लिए Authentication अक्षम होता है, तब सबसे ऊपर enabled का मान false होता है। किसी मैनेजमेंट ग्रांट या नामित कुंजी से की गई किसी भी सेटअप बदलाव की कोशिश पर 409 मिलता है, जिसके साथ {"detail": "product_disabled"} लौटता है, और कुछ भी लिखा नहीं जाता। कोई भी सेटअप कॉल Authentication चालू नहीं करती: यह काम कोई व्यक्ति कंसोल में एप्लिकेशन के लिए करता है, और उसके बाद आपकी कॉल काम करने लगती हैं।
बाकी सेटअप
कोई ग्रांट या API कुंजी सेटअप और उसके काउंटर पढ़ सकती है, लेकिन कभी एंड-यूज़र डेटा नहीं:
users/, sessions/, sign-ins/, overview/, ग्राहक संगठन, भूमिकाएँ, इंपोर्ट, एजेंट सत्र और टेस्ट ईमेल के लिए अब भी कंसोल सत्र चाहिए।
agent_humans_only सेटिंग पूरे एप्लिकेशन पर लागू होती है। इसे केवल संगठन का स्वामी या एडमिन बदल सकता है। नामित कुंजी को 403 owner_or_admin_required मिलता है। इस सेटिंग को चालू करने के लिए एक पंजीकृत पासकी भी आवश्यक है (passkey_required)।