- लाइव एप्लिकेशन के लिए
https://<name>.auth.didit.me, - सैंडबॉक्स एप्लिकेशन के लिए
https://<name>.sandbox.auth.didit.me, - या आपका अपना कस्टम डोमेन, जब वह सक्रिय हो जाए।
DIDIT_AUTH_ISSUER को अपने issuer पर सेट करें, बिना ट्रेलिंग स्लैश के, और DIDIT_APPLICATION_ID को अपनी एप्लिकेशन ID पर सेट करें। टोकन इसे aud के रूप में रखते हैं। आपकी publishable key में issuer एन्कोड होता है: pk_live_ या pk_test_ के बाद का भाग, बिना पैडिंग वाले base64url में issuer है।
जब आपका कस्टम डोमेन सक्रिय होगा, तो वह डिफ़ॉल्ट होस्ट की जगह issuer बन जाएगा। नए टोकन उसे
iss में बताएँगे, discovery jwks_uri को उसी की ओर इंगित करेगा, और आपकी publishable key बदल जाएगी। डिफ़ॉल्ट होस्ट के तहत जारी किए गए access token तब तक GET /session/ में विफल होंगे जब तक उन्हें रिफ़्रेश नहीं किया जाता। डोमेन सक्रिय करते समय DIDIT_AUTH_ISSUER अपडेट करें, या 5 मिनट के भीतर पुराने टोकन समाप्त होने तक दोनों issuer स्वीकार करें।Discovery और कुंजियाँ
issuer यह सपोर्ट करता है:
- रिस्पॉन्स टाइप
codeऔर रिस्पॉन्स मोडquery। - Grant types
authorization_codeऔरrefresh_token। - केवल PKCE method
S256। क्लाइंट सार्वजनिक हैं: कोई client secret नहीं है, औरclient_idआपकी एप्लिकेशन ID है। - साइनिंग एल्गोरिदम
ES256(P-256 कुंजियाँ)। - Scopes
openid,email,phone,profileऔरoffline_access।
prompt=none समर्थित नहीं है। सत्र पढ़ने और जाँचने के लिए GET /session/ का उपयोग करें।
कैशिंग और रोटेशन
दोनों दस्तावेज़Cache-Control: public, max-age=300 के साथ जवाब देते हैं, इसलिए आप और shared caches इन्हें 5 मिनट तक रख सकते हैं। ये प्रति IP पते पर प्रति मिनट 1,200 और प्रति घंटे 12,000 अनुरोधों की अनुमति देते हैं, जो sign-in endpoints के लिए लागू सीमाओं से कहीं ज़्यादा है, क्योंकि कई backend instances अक्सर एक ही पता साझा करते हैं।
- हर कुंजी का एक
kidहोता है; नई key IDsk_से शुरू होते हैं। हर टोकन अपनी कुंजी कोkidहेडर में बताता है। - कुंजियाँ हर 30 दिन में रोटेट होती हैं। Didit अगली कुंजी उसके साइनिंग शुरू करने से एक दिन पहले प्रकाशित करता है, और पिछली कुंजी को साइनिंग बंद करने के बाद एक दिन तक प्रकाशित रखता है। 5 मिनट के लिए कैश किया गया JWKS इसलिए रोटेशन के दौरान भी सत्यापन जारी रखता है।
- कुंजियों को
kidसे कैश करें। जब कोई टोकन ऐसाkidबताए जो आपके पास नहीं है, तो JWKS को फिर से लाएँ, लेकिन अधिकतम एक बार प्रति मिनट, और यदि कुंजी अब भी न मिले तो टोकन अस्वीकार करें। - जब Didit किसी समझौता की गई कुंजी को रद्द करता है, तो वह उसे तुरंत JWKS से हटा देता है, और
GET /session/उस कुंजी द्वारा साइन किए गए हर टोकन को अस्वीकार करता है। नई कुंजी तुरंत साइनिंग शुरू करती है, बिना एक दिन की पूर्व-प्रकाशन अवधि के। 5 मिनट तक पुराना कैश किया गया JWKS अब भी रद्द की गई कुंजी को स्वीकार करता है और नई कुंजी को नहीं जानता, इसलिए कैश ताज़ा होने तक नए टोकन ऑफ़लाइन सत्यापन में विफल हो सकते हैं।
साइन-इन शुरू करें
होस्टेड पेज खोलें, जोauthorization_endpoint है:
क्विकस्टार्ट यह अनुरोध आपके लिए बनाते हैं।
कोड का आदान-प्रदान करें
callback कोcode और state मिलते हैं। state जाँचें, फिर 60 सेकंड के भीतर code का आदान-प्रदान करें। हर code केवल एक बार काम करता है। body JSON या form-encoded हो सकती है।
expires_in बताता है कि access token में कितने सेकंड बचे हैं। जब आप एकाधिक सत्रों का विकल्प बंद कर देते हैं, तो यह आदान-प्रदान व्यक्ति के बाकी सत्र समाप्त कर देता है।
एक्सेस टोकन के क्लेम
एक्सेस टोकन एक JWT है, जिसका हेडरalg: ES256 और typ: at+jwt है। यह अधिकतम 5 मिनट तक मान्य रहता है, और कभी भी अपने सत्र से अधिक समय तक नहीं।
ID टोकन का हेडर
typ: JWT है। इसमें वही क्लेम होते हैं, सिवाय client_id के, साथ में auth_time और email_verified, और email, name तथा phone_number तब जब उनका कोई मान हो। केवल कोड एक्सचेंज से मिले ID टोकन में nonce होता है, जब साइन-इन में वह था। उसकी जाँच वहीं करें, क्योंकि रिफ़्रेश से मिले ID टोकन में वह कभी नहीं होता। ID टोकन को कभी एक्सेस टोकन के रूप में स्वीकार नहीं किया जाता।
अपने सर्वर पर टोकन सत्यापित करें
किसी क्लेम पर भरोसा करने से पहले इन सबकी जाँच करें:algES256हो औरtypat+jwtहो।noneसहित हर दूसरे एल्गोरिदम को अस्वीकार करें।kidआपके एप्लिकेशन के JWKS में हो, और हस्ताक्षर सत्यापित हो।issआपके कॉन्फ़िगर किए गए जारीकर्ता के बराबर हो, औरaudआपकी एप्लिकेशन ID के बराबर हो।expऔरiatमान्य हों, जिसमें 60 सेकंड तक का क्लॉक अंतर स्वीकार्य है, औरsub,sidऔरjtiमौजूद हों।actnullहो। किसी AI एजेंट का एक्सेस टोकन उसी कुंजी से साइन होता है और वहीtyp,issऔरaudरखता है; केवलactउसे अलग करता है। उसे अस्वीकार करें, जब तक endpoint एजेंटों को स्वीकार करता हो। तब भी केवल वही अनुमति दें जोact.scopesदेता है।GET /session/किसी एजेंट के टोकन को हमेशा अस्वीकार करता है।
GET /session/ को कॉल करें।
सत्र जाँचें
sub, sid, application_id, vendor_data, amr, mfa_verified, email, email_verified, phone, verified_identity, verified, expires_at, post_logout_redirect_uri और organizations होते हैं। हर संगठन प्रविष्टि में organization_id, organization__name, role और custom_role होते हैं।
यह जाँच ऑफ़लाइन सत्यापन से अधिक सख़्त है। यह तब भी विफल होती है जब सत्र रद्द हो चुका हो, निष्क्रिय हो गया हो या अपनी अवधि पार कर चुका हो। यह तब भी विफल होती है जब व्यक्ति अवरुद्ध हो या उसका ईमेल अब सत्यापित न हो। यह तब भी विफल होती है जब सत्र आपकी MFA नीति को अब पूरा नहीं करता (उदाहरण के लिए, व्यक्ति द्वारा ऑथेंटिकेटर ऐप जोड़ने या संगठन एडमिन बनने के बाद)। और यह तब भी विफल होती है जब टोकन किसी रिफ़्रेश से बदल दिया गया हो। विफलता पर 401 {"detail": "invalid_token"} और WWW-Authenticate: Bearer लौटता है।
GET /session/ प्रति IP पता प्रति मिनट 30 और प्रति घंटे 300 अनुरोधों की अनुमति देता है। यह सीमा DELETE /session/ के साथ साझा है। हर अनुरोध पर टोकन ऑफ़लाइन सत्यापित करें, और यह कॉल उन क्षणों के लिए रखें जिनमें इसकी ज़रूरत हो। हर सफल कॉल को गतिविधि के रूप में गिना जाता है, इसलिए यह सत्र के idle_timeout को फिर से शुरू कर देती है।
सत्यापित ईमेल पहचान सत्यापन नहीं है। उसके लिए verified पढ़ें: यहाँ वह कोई न होने पर null होता है, जबकि टोकन में {} होता है।
रिफ़्रेश टोकन
- रिफ़्रेश टोकन एक रैंडम स्ट्रिंग है, जो सत्र समाप्त होने तक मान्य रहता है।
- पुनः उपयोग सत्र समाप्त कर देता है। जब कोई पहले से उपयोग किया जा चुका रिफ़्रेश टोकन दोबारा आता है, तो Didit इसे चोरी का संकेत मानता है। वह सत्र रद्द कर देता है और
400 {"error": "invalid_grant"}लौटाता है। सत्र के टोकन भी काम करना बंद कर देते हैं, जिनमें पिछले रिफ़्रेश से मिले टोकन भी शामिल हैं। उनका रिफ़्रेश टोकन विफल होता है और उनका एक्सेस टोकन तुरंतGET /session/में विफल होता है। हालाँकि वह समाप्त होने तक, यानी 5 मिनट के भीतर, ऑफ़लाइन सत्यापित होता रहता है। - किसी सत्र के लिए एक समय में केवल एक रिफ़्रेश चलाएँ, चाहे टैब, डिवाइस या सर्वर इंस्टेंस कोई भी हों, और तीनों टोकन एक साथ बदलें।
- यदि रिफ़्रेश
400के साथ विफल हो या उसका कोई उत्तर न आए, तो साइन-इन फिर से शुरू करें। उसे बिना सोचे दोबारा न चलाएँ, क्योंकि जो रिफ़्रेश पहले से सफल हो चुका है उसके बाद का पुनः प्रयास पुनः उपयोग माना जाएगा। 503 {"error": "temporarily_unavailable"}का अर्थ है कि रिफ़्रेश नहीं हुआ और आपका रिफ़्रेश टोकन अब भी काम करता है। बैकऑफ़ के साथ पुनः प्रयास करें।- Didit रिफ़्रेश चलने से पहले
429लौटाता है, इसलिएRetry-Afterके बाद पुनः प्रयास करें। टोकन endpoint प्रति IP पता प्रति मिनट 30 और प्रति घंटे 300 अनुरोधों की अनुमति देता है। इसके अलावा, आपके एप्लिकेशन के हरPOSTऔरDELETEसाझा बॉट सुरक्षा बकेट का उपयोग करते हैं: इन endpoints पर प्रति IP पता प्रति मिनट 60 अनुरोध, और प्रति डिवाइस प्रति मिनट 30। पूरे एप्लिकेशन के लिए, रिफ़्रेश का बकेट प्रति मिनट 6,000 का है, और बाकी हरPOSTऔरDELETE(ब्राउज़र और साइन-इन चरण सहित) का बकेट प्रति मिनट 3,000 का है, ताकि रिफ़्रेश आपके साइन-इन को कभी खत्म न करें। - 5 मिनट के एक्सेस टोकन के साथ, प्रति घंटे 300 रिफ़्रेश लगभग 25 सक्रिय लोगों के लिए पर्याप्त हैं। यदि आपका सर्वर एक ही पते से कई लोगों के लिए रिफ़्रेश करता है, तो रिफ़्रेश केवल तभी करें जब किसी अनुरोध को नए टोकन की ज़रूरत हो, और जहाँ संभव हो वहाँ ब्राउज़र या ऐप में रिफ़्रेश करें।
साइन आउट
DELETE /session/ को व्यक्ति के मौजूदा access token के साथ भेजने पर सत्र समाप्त हो जाता है और 204 लौटता है। उस सत्र का refresh token काम करना बंद कर देता है, और उसके access token तुरंत GET /session/ में विफल होने लगते हैं। जिन टोकन की जाँच आप ऑफ़लाइन करते हैं, वे अपनी समाप्ति तक मान्य रहते हैं। इसके बाद, यदि आपने post_logout_redirect_uri सेट किया है, तो व्यक्ति को उस पर भेजें।
साइन आउट के लिए ऐसा access token चाहिए जिसे GET /session/ स्वीकार करे: यानी जो समाप्त न हुआ हो और refresh द्वारा बदला न गया हो। 401 का अर्थ है कि सत्र समाप्त नहीं हुआ। refresh करें, फिर नए access token से साइन आउट करें। यदि refresh 400 के साथ विफल हो, तो वह सत्र अब उपयोग नहीं किया जा सकता।
सत्र इन स्थितियों में भी समाप्त हो जाता है:
- जब वह
session_lifetime(डिफ़ॉल्ट 30 दिन) याidle_timeout(डिफ़ॉल्ट 1 दिन) पार कर जाए, - जब एकाधिक सत्रों की अनुमति न होने पर व्यक्ति फिर से साइन इन करे,
- जब
revoke_on_password_changeचालू होने पर व्यक्ति अपना पासवर्ड रीसेट करे, - जब आपकी टीम कंसोल में सत्र रद्द करे या व्यक्ति को ब्लॉक करे,
- जब उपयोग किया जा चुका refresh token दोबारा भेजा जाए।
जीवनकाल
उद्देश्य के अनुसार क्रेडेंशियल संग्रहीत करें
- सत्यापन API कुंजियाँ और कंसोल टोकन अपने सर्वर पर रखें।
- ब्राउज़र के access token जहाँ संभव हो मेमोरी में रखें। सर्वर-रेंडर्ड ऐप्स के लिए सुरक्षित HttpOnly cookies का उपयोग करें, और cookie से प्रमाणित अनुरोधों को CSRF से बचाएँ।
- मोबाइल के refresh token प्लेटफ़ॉर्म-संरक्षित स्टोरेज में रखें। साइन आउट के बाद स्थानीय स्थिति साफ़ करें।
- टोकन कभी URL या लॉग में न डालें।