चेतावनी: यह डेटा Google उपयोगकर्ता डेटा नीति के तहत दिया जाता है. कृपया समीक्षा करें और नीति का पालन करें. ऐसा न करने पर, प्रोजेक्ट या खाता निलंबित हो सकता है.

वेबसाइटों के लिए Google 3P ऑथराइज़ेशन JavaScript लाइब्रेरी - एपीआई का रेफ़रंस

इस रेफ़रंस में Google 3P ऑथराइज़ेशन JavaScript लाइब्रेरी एपीआई के बारे में बताया गया है. आप इसका इस्तेमाल करके, Google से ऑथराइज़ेशन कोड लोड कर सकते हैं या टोकन ऐक्सेस कर सकते हैं.

तरीका: google.accounts.oauth2.initCodeClient

initCodeClient का तरीका, पैरामीटर में कॉन्फ़िगरेशन के साथ कोड क्लाइंट को शुरू करता है और दिखाता है.

google.accounts.oauth2.initCodeClient(config: CodeClientConfig)

डेटा टाइप: CodeClientConfig

इस टेबल में, CodeClientConfig डेटा टाइप की प्रॉपर्टी के बारे में बताया गया है.

प्रॉपर्टी
client_id ज़रूरी है. आपके ऐप्लिकेशन का क्लाइंट आईडी. यह वैल्यू आपको एपीआई कंसोल में मिल सकती है.
scope ज़रूरी है. स्पेस के दायरे वाली सूची, जिसमें ऐसे संसाधनों की पहचान की जाती है जिन्हें आपका ऐप्लिकेशन उपयोगकर्ता की ओर से ऐक्सेस कर सकता है. ये वैल्यू उस सहमति स्क्रीन के बारे में बताती हैं जिसे Google, उपयोगकर्ता को दिखाता है.
redirect_uri रीडायरेक्ट UX के लिए ज़रूरी है. यह तय करता है कि एपीआई सर्वर, उपयोगकर्ता को अनुमति देने के फ़्लो को पूरा करने के बाद, कहां रीडायरेक्ट करता है. यह मान OAuth 2.0 क्लाइंट के लिए मंज़ूर किए गए किसी एक रीडायरेक्ट यूआरआई से हूबहू मेल खाना चाहिए, जिसे आपने API (एपीआई) कंसोल में कॉन्फ़िगर किया है और यह हमारे रीडायरेक्ट यूआरआई की पुष्टि करने के नियमों के मुताबिक होना चाहिए. प्रॉपर्टी को पॉप-अप UX से अनदेखा कर दिया जाएगा.
callback पॉप-अप UX के लिए ज़रूरी है. JavaScript फ़ंक्शन का नाम, जो लौटाए गए कोड का रिस्पॉन्स देता है. प्रॉपर्टी को रीडायरेक्ट UX से अनदेखा कर दिया जाएगा.
state ज़रूरी नहीं. रीडायरेक्ट UX के लिए सुझाया गया. यह ऐसी कोई भी स्ट्रिंग वैल्यू बताती है जिसका इस्तेमाल आपका ऐप्लिकेशन, आपके अनुमति के अनुरोध और ऑथराइज़ेशन सर्वर के रिस्पॉन्स को बनाए रखने के लिए करता है.
enable_serial_consent ज़रूरी नहीं, डिफ़ॉल्ट रूप से true. अगर false पर सेट किया गया है, तो 2019 से पहले बनाए गए क्लाइंट के लिए, ज़्यादा जानकारी वाले Google खाते की अनुमतियां बंद कर दी जाएंगी. नए क्लाइंट पर इसका कोई असर नहीं होता, क्योंकि उनके लिए ज़्यादा जानकारी वाली अनुमतियां हमेशा चालू रहती हैं.
hint ज़रूरी नहीं. अगर आपके ऐप्लिकेशन को पता है कि किस उपयोगकर्ता को अनुरोध को अनुमति देनी चाहिए, तो वह Google को संकेत देने के लिए इस प्रॉपर्टी का इस्तेमाल कर सकता है. टारगेट उपयोगकर्ता का ईमेल पता. ज़्यादा जानकारी के लिए, Open Connect दस्तावेज़ में login_hint फ़ील्ड देखें.
hosted_domain ज़रूरी नहीं. अगर आपके ऐप्लिकेशन को पता है कि उपयोगकर्ता किस Workspace डोमेन का है, तो Google का इस्तेमाल करने के लिए, इसका इस्तेमाल करें. ज़्यादा जानकारी के लिए, Open Connect दस्तावेज़ में hd फ़ील्ड देखें.
ux_mode ज़रूरी नहीं. अनुमति देने के फ़्लो में इस्तेमाल करने के लिए UX मोड. डिफ़ॉल्ट रूप से, यह सहमति पॉप-अप में खुलेगा. मान्य वैल्यू popup और redirect हैं.
select_account ज़रूरी नहीं है. डिफ़ॉल्ट रूप से, 'false' का इस्तेमाल किया जाता है. बूलियन वैल्यू, जिससे उपयोगकर्ता को खाता चुनने के लिए कहा जाता है.

डेटा टाइप: CodeClient

इस क्लास में सिर्फ़ एक सार्वजनिक तरीका अनुरोध कोड होता है, जो OAuth 2.0 कोड UX फ़्लो शुरू करता है.

interface CodeClient {
  requestCode(): void;
}

डेटा टाइप: CodeResponse

पॉप-अप UX में, आपकी callback मैथड में CodeResponse JavaScript ऑब्जेक्ट पास किया जाएगा. रीडायरेक्ट UX में, CodeResponse को यूआरएल पैरामीटर के तौर पर पास किया जाएगा.

इस टेबल में, CodeResponse डेटा टाइप की प्रॉपर्टी के बारे में बताया गया है.

प्रॉपर्टी
code टोकन के सफल रिस्पॉन्स का ऑथराइज़ेशन कोड.
scope स्पेस के दायरे वाली सूची, जिसे उपयोगकर्ता ने मंज़ूरी दी है.
state वह स्ट्रिंग वैल्यू जिसका इस्तेमाल आपका ऐप्लिकेशन अनुमति देने के अनुरोध और जवाब के बीच स्थिति बनाए रखने के लिए करता है.
error एक ASCII गड़बड़ी कोड.
error_description ज़्यादा जानकारी देने वाला ऐसा ASCII टेक्स्ट, जिसे लोग पढ़ सकें. इसका इस्तेमाल, क्लाइंट डेवलपर को होने वाली गड़बड़ी को समझने के लिए किया जाता है.
error_uri यूआरआई के बारे में ऐसी जानकारी से जुड़ा वेब पेज जो उपयोगकर्ता को आसानी से पढ़ा जा सके. इसका इस्तेमाल क्लाइंट डेवलपर को गड़बड़ी के बारे में ज़्यादा जानकारी देने के लिए किया जाता है.

तरीका: google.accounts.oauth2.initTokenClient

initTokenClient का तरीका, पैरामीटर में कॉन्फ़िगरेशन के साथ टोकन टोकन को शुरू करता है और दिखाता है.

google.accounts.oauth2.initTokenClient(config: TokenClientConfig)

डेटा टाइप: TokenClientConfig

इस टेबल में, TokenClientConfig डेटा टाइप की प्रॉपर्टी के बारे में बताया गया है.

प्रॉपर्टी
client_id ज़रूरी है. आपके ऐप्लिकेशन का क्लाइंट आईडी. यह वैल्यू आपको एपीआई कंसोल में मिल जाएगी.
callback ज़रूरी है. JavaScript फ़ंक्शन का नाम, जो लौटाए गए टोकन का रिस्पॉन्स मैनेज करता है.
scope ज़रूरी है. स्पेस के दायरे वाली सूची, जिसमें ऐसे संसाधनों की पहचान की जाती है जिन्हें आपका ऐप्लिकेशन उपयोगकर्ता की ओर से ऐक्सेस कर सकता है. ये वैल्यू उस सहमति स्क्रीन के बारे में बताती हैं जिसे Google, उपयोगकर्ता को दिखाता है.
prompt ज़रूरी नहीं है. डिफ़ॉल्ट रूप से, 'select_account' सेट होता है. सूची को अलग-अलग करने के लिए, अलग-अलग केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) सूची का इस्तेमाल करें. ये वैल्यू हो सकती हैं:
  • खाली स्ट्रिंग उपयोगकर्ता को सिर्फ़ पहली बार आपके ऐप्लिकेशन से ऐक्सेस का अनुरोध करने के लिए कहा जाएगा. दूसरी वैल्यू नहीं दी जा सकती.
  • 'none' कोई पुष्टि या सहमति स्क्रीन न दिखाएं. दूसरी वैल्यू नहीं होनी चाहिए.
  • 'consent' उपयोगकर्ता से सहमति का अनुरोध करें.
  • 'select_account' उपयोगकर्ता से खाता चुनने का अनुरोध करें.
enable_serial_consent ज़रूरी नहीं, डिफ़ॉल्ट रूप से true. अगर false पर सेट किया गया है, तो 2019 से पहले बनाए गए क्लाइंट के लिए, ज़्यादा जानकारी वाले Google खाते की अनुमतियां बंद कर दी जाएंगी. नए क्लाइंट पर इसका कोई असर नहीं होता, क्योंकि उनके लिए ज़्यादा जानकारी वाली अनुमतियां हमेशा चालू रहती हैं.
hint ज़रूरी नहीं. अगर आपके ऐप्लिकेशन को पता है कि किस उपयोगकर्ता को अनुरोध को अनुमति देनी चाहिए, तो वह Google को संकेत देने के लिए इस प्रॉपर्टी का इस्तेमाल कर सकता है. टारगेट उपयोगकर्ता का ईमेल पता. ज़्यादा जानकारी के लिए, Open Connect दस्तावेज़ में login_hint फ़ील्ड देखें.
hosted_domain ज़रूरी नहीं. अगर आपके ऐप्लिकेशन को पता है कि उपयोगकर्ता किस Workspace डोमेन का है, तो Google का इस्तेमाल करने के लिए, इसका इस्तेमाल करें. ज़्यादा जानकारी के लिए, Open Connect दस्तावेज़ में hd फ़ील्ड देखें.
state ज़रूरी नहीं. इसे इस्तेमाल करने का सुझाव नहीं दिया जाता है. यह ऐसी कोई भी स्ट्रिंग वैल्यू बताती है जिसका इस्तेमाल आपका ऐप्लिकेशन, आपके अनुमति के अनुरोध और ऑथराइज़ेशन सर्वर के रिस्पॉन्स को बनाए रखने के लिए करता है.

डेटा टाइप: TokenClient

इस क्लास में सिर्फ़ एक सार्वजनिक तरीका requestAccessToken होता है. यह OAuth 2.0 टोकन UX फ़्लो को शुरू करता है.

interface TokenClient {
  requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}
तर्क
overrideConfig ओवरराइड किया जा सकने वाला TokenClientConfig ज़रूरी नहीं. इस तरीके में ओवरराइड किए जाने वाले कॉन्फ़िगरेशन.

डेटा टाइप: ओवरराइड किया जा सकने वाला TokenClientConfig

इस टेबल में, OverridableTokenClientConfig डेटा टाइप की प्रॉपर्टी के बारे में बताया गया है.

प्रॉपर्टी
prompt ज़रूरी नहीं. स्पेस को अलग-अलग करके, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) की सूची बनाएं. इस सूची में उपयोगकर्ता से जुड़ी जानकारी दी गई है.
enable_serial_consent ज़रूरी नहीं. अगर false पर सेट किया गया है, तो 2019 से पहले बनाए गए क्लाइंट के लिए, ज़्यादा जानकारी वाले Google खाते की अनुमतियां बंद कर दी जाएंगी. नए क्लाइंट पर इसका कोई असर नहीं होता, क्योंकि उनके लिए ज़्यादा जानकारी वाली अनुमतियां हमेशा चालू रहती हैं.
hint ज़रूरी नहीं. अगर आपके ऐप्लिकेशन को पता है कि किस उपयोगकर्ता को अनुरोध को अनुमति देनी चाहिए, तो वह Google को संकेत देने के लिए इस प्रॉपर्टी का इस्तेमाल कर सकता है. टारगेट उपयोगकर्ता का ईमेल पता. ज़्यादा जानकारी के लिए, Open Connect दस्तावेज़ में login_hint फ़ील्ड देखें.
state ज़रूरी नहीं. इसे इस्तेमाल करने का सुझाव नहीं दिया जाता है. यह ऐसी कोई भी स्ट्रिंग वैल्यू बताती है जिसका इस्तेमाल आपका ऐप्लिकेशन, आपके अनुमति के अनुरोध और ऑथराइज़ेशन सर्वर के रिस्पॉन्स को बनाए रखने के लिए करता है.

डेटा टाइप: TokenResponse

पॉप-अप UX में, आपके कॉलबैक मैथड में TokenResponse JavaScript ऑब्जेक्ट पास किया जाएगा.

इस टेबल में, TokenResponse डेटा टाइप की प्रॉपर्टी के बारे में बताया गया है.

प्रॉपर्टी
access_token टोकन के सफल जवाब का ऐक्सेस टोकन.
expires_in ऐक्सेस टोकन के सेकंड में जीवनकाल.
hd ऐसा होस्ट किया गया डोमेन जिसमें साइन-इन किया हुआ उपयोगकर्ता मौजूद है.
prompt वह टोकन वैल्यू जिसका इस्तेमाल टोकनClientConfig या OverridableTokenClientConfig से तय की गई वैल्यू की संभावित सूची में से इस्तेमाल किया गया था.
token_type टोकन किस तरह का है.
scope स्पेस के दायरे वाली सूची, जिसे उपयोगकर्ता ने मंज़ूरी दी है.
state वह स्ट्रिंग वैल्यू जिसका इस्तेमाल आपका ऐप्लिकेशन अनुमति देने के अनुरोध और जवाब के बीच स्थिति बनाए रखने के लिए करता है.
error एक ASCII गड़बड़ी कोड.
error_description ज़्यादा जानकारी देने वाला ऐसा ASCII टेक्स्ट, जिसे लोग पढ़ सकें. इसका इस्तेमाल, क्लाइंट डेवलपर को होने वाली गड़बड़ी को समझने के लिए किया जाता है.
error_uri यूआरआई के बारे में ऐसी जानकारी से जुड़ा वेब पेज जो उपयोगकर्ता को आसानी से पढ़ा जा सके. इसका इस्तेमाल क्लाइंट डेवलपर को गड़बड़ी के बारे में ज़्यादा जानकारी देने के लिए किया जाता है.

तरीका: google.accounts.oauth2.hasgrantedAllScopes

जांच करता है कि उपयोगकर्ता ने सभी खास दायरे या दायरे दिए हैं या नहीं.

google.accounts.oauth2.hasGrantedAllScopes(
                                            tokenResponse: TokenResponse,
                                            firstScope: string, ...restScopes: string[]
                                          ): boolean;
तर्क
tokenResponse स्ट्रिंग ज़रूरी है. एक मान्य ऐक्सेस टोकन.
firstScope स्ट्रिंग ज़रूरी है. जांचने का दायरा.
restScopes स्ट्रिंग[] ज़रूरी नहीं. जांचने के लिए अन्य स्कोप.
लौटाए गए आइटम
बूलियन अगर सभी दायरे दिए गए हैं, तो सही है.

तरीका: google.accounts.oauth2.hasgranted AnyScope

यह जांचता है कि उपयोगकर्ता ने कोई खास दायरा या दायरा दिया है या नहीं.

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;
तर्क
tokenResponse स्ट्रिंग ज़रूरी है. एक मान्य ऐक्सेस टोकन.
firstScope स्ट्रिंग ज़रूरी है. जांचने का दायरा.
restScopes स्ट्रिंग[] ज़रूरी नहीं. जांचने के लिए अन्य स्कोप.
लौटाए गए आइटम
बूलियन अगर कोई दायरा बताया गया है, तो सही है.

तरीका: google.accounts.oauth2.revok

revoke वाला तरीका, उपयोगकर्ता के ऐप्लिकेशन में दिए गए सभी दायरों को निरस्त कर देता है. अनुमति को निरस्त करने के लिए, मान्य ऐक्सेस टोकन होना ज़रूरी है.

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;
तर्क
accessToken स्ट्रिंग ज़रूरी है. एक मान्य ऐक्सेस टोकन.
done फ़ंक्शन ज़रूरी नहीं. वापस लेने की कार्रवाई पूरी होने के बाद, कॉलबैक फ़ंक्शन.