Google अश्वेत समुदायों के लिए नस्लीय इक्विटी को आगे बढ़ाने के लिए प्रतिबद्ध है। देखो कैसे।
इस पेज का अनुवाद Cloud Translation API से किया गया है.
Switch to English

वेब सर्वर अनुप्रयोगों के लिए OAuth 2.0 का उपयोग करना

यह दस्तावेज़ बताता है कि कैसे वेब सर्वर एप्लिकेशन Google API क्लाइंट लाइब्रेरी या Google OAuth 2.0 एंडपॉइंट का उपयोग करते हुए Google API तक पहुंचने के लिए OAuth 2.0 प्राधिकरण को लागू करते हैं।

OAuth 2.0 उपयोगकर्ताओं को अपने उपयोगकर्ता नाम, पासवर्ड और अन्य जानकारी को निजी रखते हुए एक एप्लिकेशन के साथ विशिष्ट डेटा साझा करने की अनुमति देता है। उदाहरण के लिए, एक एप्लिकेशन अपने Google ड्राइव में फ़ाइलों को संग्रहीत करने के लिए उपयोगकर्ताओं से अनुमति प्राप्त करने के लिए OAuth 2.0 का उपयोग कर सकता है।

यह OAuth 2.0 प्रवाह विशेष रूप से उपयोगकर्ता प्राधिकरण के लिए है। यह उन अनुप्रयोगों के लिए डिज़ाइन किया गया है जो गोपनीय जानकारी संग्रहीत कर सकते हैं और राज्य बनाए रख सकते हैं। एक उचित रूप से अधिकृत वेब सर्वर एप्लिकेशन एक एपीआई का उपयोग कर सकता है, जबकि उपयोगकर्ता एप्लिकेशन के साथ बातचीत करता है या उपयोगकर्ता द्वारा एप्लिकेशन को छोड़ने के बाद।

वेब सर्वर एप्लिकेशन अक्सर एपीआई अनुरोधों को अधिकृत करने के लिए सेवा खातों का उपयोग करते हैं, खासकर जब उपयोगकर्ता विशेष डेटा के बजाय प्रोजेक्ट-आधारित डेटा तक पहुंचने के लिए क्लाउड एपीआई को कॉल करते हैं। वेब सर्वर एप्लिकेशन उपयोगकर्ता प्राधिकरण के साथ संयोजन के रूप में सेवा खातों का उपयोग कर सकते हैं।

ग्राहक पुस्तकालय

इस पृष्ठ पर भाषा-विशिष्ट उदाहरण OAuth 2.0 प्राधिकरण को लागू करने के लिए Google API क्लाइंट लाइब्रेरीज़ का उपयोग करते हैं। कोड नमूने चलाने के लिए, आपको पहले अपनी भाषा के लिए क्लाइंट लाइब्रेरी स्थापित करनी होगी।

जब आप अपने एप्लिकेशन के OAuth 2.0 प्रवाह को संभालने के लिए Google API क्लाइंट लाइब्रेरी का उपयोग करते हैं, तो क्लाइंट लाइब्रेरी कई क्रियाएं करता है, जो एप्लिकेशन को अन्यथा स्वयं को संभालने की आवश्यकता होती है। उदाहरण के लिए, यह निर्धारित करता है कि एप्लिकेशन संग्रहीत पहुँच टोकन का उपयोग कर सकता है या ताज़ा कर सकता है और साथ ही जब एप्लिकेशन को सहमति प्राप्त करनी होगी। क्लाइंट लाइब्रेरी सही रीडायरेक्ट URL भी बनाती है और रीडायरेक्ट हैंडलर को लागू करने में मदद करती है जो टोकन तक पहुँच के लिए प्राधिकरण कोड का आदान-प्रदान करते हैं।

क्लाइंट लाइब्रेरी निम्नलिखित भाषाओं के लिए उपलब्ध हैं:

आवश्यक शर्तें

अपने प्रोजेक्ट के लिए API सक्षम करें

Google API को कॉल करने वाले किसी भी एप्लिकेशन को API Console में उन API को सक्षम करने की आवश्यकता होती है।

अपने प्रोजेक्ट के लिए API सक्षम करने के लिए:

  1. Google API Console में Open the API Library
  2. If prompted, select a project, or create a new one.
  3. API Library उत्पाद परिवार और लोकप्रियता द्वारा समूहीकृत सभी उपलब्ध एपीआई को सूचीबद्ध करता है। यदि आप जिस एपीआई को सक्षम करना चाहते हैं, वह सूची में दिखाई नहीं देता है, तो उसे खोजने के लिए खोज का उपयोग करें, या उस उत्पाद परिवार में सभी देखें पर क्लिक करें जो उसका है।
  4. वह एपीआई चुनें जिसे आप सक्षम करना चाहते हैं, फिर सक्षम करें बटन पर क्लिक करें।
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

प्राधिकरण क्रेडेंशियल बनाएं

Google API तक पहुंचने के लिए OAuth 2.0 का उपयोग करने वाले किसी भी एप्लिकेशन में प्राधिकरण क्रेडेंशियल होना चाहिए जो Google के OAuth 2.0 सर्वर के लिए एप्लिकेशन की पहचान करता है। निम्नलिखित चरण बताते हैं कि अपनी परियोजना के लिए क्रेडेंशियल्स कैसे बनाएं। आपके एप्लिकेशन तब एपीआई का उपयोग करने के लिए क्रेडेंशियल्स का उपयोग कर सकते हैं जो आपने उस प्रोजेक्ट के लिए सक्षम किया है।

  1. Go to the Credentials page.
  2. क्रेडेंशियल बनाएं> OAuth क्लाइंट आईडी पर क्लिक करें
  3. वेब एप्लिकेशन एप्लिकेशन प्रकार का चयन करें।
  4. फॉर्म भरें और क्रिएट पर क्लिक करें । PHP, जावा, पायथन, रूबी और .NET जैसी भाषाओं और चौखटों का उपयोग करने वाले एप्लिकेशन को अधिकृत पुनर्निर्देशित यूआरआई निर्दिष्ट करना चाहिए। रीडायरेक्ट यूआरआई एंडपॉइंट हैं, जिनमें OAuth 2.0 सर्वर प्रतिक्रिया भेज सकता है। ये समापन बिंदु Google के सत्यापन नियमों का पालन ​​करना चाहिए।

    परीक्षण के लिए, आप URI को निर्दिष्ट कर सकते हैं जो स्थानीय मशीन को संदर्भित करता है, जैसे http://localhost:8080 । इसे ध्यान में रखते हुए, कृपया ध्यान दें कि इस दस्तावेज़ के सभी उदाहरण http://localhost:8080 का उपयोग रीडायरेक्ट URI के रूप में करते हैं।

    हम अनुशंसा करते हैं कि आप अपने ऐप के एंडॉर्स एंडपॉइंट को डिज़ाइन करें ताकि आपका एप्लिकेशन पृष्ठ पर अन्य संसाधनों के लिए प्राधिकरण कोड को उजागर न करे।

अपनी साख बनाने के बाद, API Console से client_secret.json फ़ाइल डाउनलोड करें। फ़ाइल को किसी ऐसे स्थान पर सुरक्षित रूप से संग्रहीत करें जिसे केवल आपका एप्लिकेशन एक्सेस कर सकता है।

एक्सेस स्कोप्स की पहचान करें

स्कोप्स आपके एप्लिकेशन को केवल उन संसाधनों तक पहुंच का अनुरोध करने में सक्षम बनाते हैं, जिनकी आवश्यकता उपयोगकर्ताओं को एक्सेस करने में सक्षम होती है, ताकि वे आपके एप्लिकेशन को दिए जाने वाले एक्सेस की मात्रा को नियंत्रित कर सकें। इस प्रकार, अनुरोध किए गए स्कोप की संख्या और उपयोगकर्ता की सहमति प्राप्त करने की संभावना के बीच एक व्युत्क्रम संबंध हो सकता है।

इससे पहले कि आप OAuth 2.0 प्राधिकरण को लागू करना शुरू करें, हम अनुशंसा करते हैं कि आप उन स्कोपों ​​की पहचान करें जिन्हें आपके ऐप को एक्सेस करने की अनुमति की आवश्यकता होगी।

हम यह भी सुझाव देते हैं कि आपका आवेदन एक वृद्धिशील प्राधिकरण प्रक्रिया के माध्यम से प्राधिकरण स्कोप तक पहुंच का अनुरोध करता है, जिसमें आपका एप्लिकेशन संदर्भ में उपयोगकर्ता डेटा तक पहुंच का अनुरोध करता है। यह सबसे अच्छा अभ्यास उपयोगकर्ताओं को अधिक आसानी से समझने में मदद करता है कि आपके आवेदन को उस अनुरोध का उपयोग करने की आवश्यकता क्यों है।

OAuth 2.0 API स्कोप दस्तावेज़ में उन स्कोपों ​​की पूरी सूची है, जिनका उपयोग आप Google API तक पहुँचने के लिए कर सकते हैं।

भाषा-विशिष्ट आवश्यकताएं

इस दस्तावेज़ में किसी भी कोड नमूने को चलाने के लिए, आपको Google खाते, इंटरनेट तक पहुंच और वेब ब्राउज़र की आवश्यकता होगी। यदि आप एपीआई क्लाइंट पुस्तकालयों में से एक का उपयोग कर रहे हैं, तो नीचे दी गई भाषा-विशिष्ट आवश्यकताओं को भी देखें।

पीएचपी

इस दस्तावेज़ में PHP कोड के नमूने चलाने के लिए, आपको आवश्यकता होगी:

  • PHP 5.4 या अधिक कमांड-लाइन इंटरफ़ेस (CLI) और JSON एक्सटेंशन स्थापित के साथ।
  • संगीतकार निर्भरता प्रबंधन उपकरण।
  • PHP के लिए Google API क्लाइंट लाइब्रेरी:

    php composer.phar require google/apiclient:^2.0

अजगर

इस दस्तावेज़ में पायथन कोड के नमूने चलाने के लिए, आपको आवश्यकता होगी:

  • अजगर 2.6 या उससे अधिक
  • पाइप पैकेज प्रबंधन उपकरण।
  • पायथन के लिए Google API क्लाइंट लाइब्रेरी:
    pip install --upgrade google-api-python-client
  • google-auth , google-auth-oauthlib , और google-auth-httplib2 उपयोगकर्ता प्राधिकरण के लिए।
    pip install --upgrade google-auth google-auth-oauthlib google-auth-httplib2
  • फ्लास्क पायथन वेब एप्लीकेशन फ्रेमवर्क।
    pip install --upgrade flask
  • requests HTTP पुस्तकालय।
    pip install --upgrade requests

माणिक

इस दस्तावेज़ में रूबी कोड के नमूने चलाने के लिए, आपको आवश्यकता होगी:

  • रूबी 2.2.2 या उससे अधिक
  • रूबी के लिए Google API क्लाइंट लाइब्रेरी:

    gem install google-api-client
  • सिनात्रा रूबी वेब एप्लीकेशन फ्रेमवर्क।

    gem install sinatra

HTTP / REST

आपको OAuth 2.0 समापन बिंदुओं को सीधे कॉल करने में सक्षम होने के लिए किसी भी लाइब्रेरी को स्थापित करने की आवश्यकता नहीं है।

OAuth 2.0 एक्सेस टोकन प्राप्त करना

निम्न चरण बताते हैं कि उपयोगकर्ता की ओर से एपीआई अनुरोध करने के लिए उपयोगकर्ता की सहमति प्राप्त करने के लिए आपका एप्लिकेशन Google के OAuth 2.0 सर्वर के साथ कैसे इंटरैक्ट करता है। आपके एप्लिकेशन में Google API अनुरोध को निष्पादित करने से पहले सहमति होनी चाहिए जो उपयोगकर्ता प्राधिकरण की आवश्यकता होती है।

नीचे दी गई सूची इन चरणों का संक्षेप में वर्णन करती है:

  1. आपका एप्लिकेशन उन अनुमतियों की पहचान करता है जिनकी उसे आवश्यकता है।
  2. आपका आवेदन अनुरोध अनुमतियों की सूची के साथ उपयोगकर्ता को Google पर पुनर्निर्देशित करता है।
  3. उपयोगकर्ता तय करता है कि आपके आवेदन को अनुमति देना है या नहीं।
  4. आपके एप्लिकेशन को पता चल जाता है कि उपयोगकर्ता ने क्या निर्णय लिया है।
  5. यदि उपयोगकर्ता ने अनुरोधित अनुमतियाँ दी हैं, तो आपका आवेदन उपयोगकर्ता की ओर से एपीआई अनुरोध करने के लिए आवश्यक टोकन को पुनः प्राप्त करता है।

चरण 1: प्राधिकरण पैरामीटर सेट करें

प्राधिकरण अनुरोध बनाने के लिए आपका पहला कदम है। यह अनुरोध उन मापदंडों को निर्धारित करता है जो आपके आवेदन की पहचान करते हैं और उन अनुमतियों को परिभाषित करते हैं जिन्हें उपयोगकर्ता को आपके आवेदन को अनुदान देने के लिए कहा जाएगा।

  • यदि आप OAuth 2.0 प्रमाणीकरण और प्राधिकरण के लिए Google क्लाइंट लाइब्रेरी का उपयोग करते हैं, तो आप इन मापदंडों को परिभाषित करने वाली एक वस्तु बनाते और कॉन्फ़िगर करते हैं।
  • यदि आप सीधे Google OAuth 2.0 समापन बिंदु कहते हैं, तो आप एक URL उत्पन्न करेंगे और उस URL पर पैरामीटर सेट करेंगे।

नीचे दिए गए टैब वेब सर्वर अनुप्रयोगों के लिए समर्थित प्राधिकरण मापदंडों को परिभाषित करते हैं। भाषा-विशिष्ट उदाहरण यह भी दर्शाते हैं कि किसी क्लाइंट लाइब्रेरी या ऑथराइज़ेशन लाइब्रेरी का उपयोग कैसे किया जाता है ताकि उन मापदंडों को सेट किया जा सके।

पीएचपी

नीचे दिया गया कोड स्निपेट Google_Client() ऑब्जेक्ट बनाता है, जो प्राधिकरण अनुरोध में मापदंडों को परिभाषित करता है।

वह ऑब्जेक्ट आपके एप्लिकेशन की पहचान करने के लिए आपके client_secret.json फ़ाइल की जानकारी का उपयोग करता है। (उस फ़ाइल के बारे में अधिक जानकारी के लिए प्राधिकरण क्रेडेंशियल बनाना देखें।) ऑब्जेक्ट उन स्कोपों ​​की भी पहचान करता है, जो आपके एप्लिकेशन को एक्सेस करने की अनुमति और URL को आपके एप्लिकेशन के एंडॉइंट समापन बिंदु तक पहुंचने का अनुरोध कर रहे हैं, जो Google के OAuth 2.0 सर्वर से प्रतिक्रिया को हैंडल करेगा। अंत में, कोड सेट वैकल्पिक access_type और include_granted_scopes मानकों।

उदाहरण के लिए, यह कोड उपयोगकर्ता के Google ड्राइव पर केवल-पढ़ने के लिए ऑफ़लाइन पहुँच का अनुरोध करता है:

$client = new Google_Client();
$client->setAuthConfig('client_secret.json');
$client->addScope(Google_Service_Drive::DRIVE_METADATA_READONLY);
$client->setRedirectUri('http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php');
// offline access will give you both an access and refresh token so that
// your app can refresh the access token without user interaction.
$client->setAccessType('offline');
// Using "consent" ensures that your application always receives a refresh token.
// If you are not using offline access, you can omit this.
$client->setApprovalPrompt("consent");
$client->setIncludeGrantedScopes(true);   // incremental auth

अनुरोध निम्नलिखित जानकारी निर्दिष्ट करता है:

मापदंडों
client_id अपेक्षित

आपके आवेदन के लिए क्लाइंट आईडी। आप इस मान को API Console Credentials page में पा सकते हैं।

PHP में, setAuthConfig फ़ंक्शन को क्लाइंट_secret.json फ़ाइल से प्राधिकरण क्रेडेंशियल्स लोड करने के लिए कॉल करें।

$client = new Google_Client();
$client->setAuthConfig('client_secret.json');
redirect_uri अपेक्षित

यह निर्धारित करता है कि उपयोगकर्ता द्वारा प्राधिकरण प्रवाह पूरा करने के बाद एपीआई सर्वर उपयोगकर्ता को पुनर्निर्देशित करता है। मान OAuth 2.0 क्लाइंट के लिए अधिकृत पुनर्निर्देशित URI में से एक से मेल खाना चाहिए, जिसे आपने अपने क्लाइंट के API Console Credentials page में कॉन्फ़िगर किया था। यदि यह मान प्रदान किए गए client_id लिए एक अधिकृत पुनर्निर्देशित URI से मेल नहीं खाता है, तो आपको एक redirect_uri_mismatch client_id त्रुटि मिलेगी।

ध्यान दें कि http या https स्कीम, केस और ट्रेलिंग स्लैश (' / ') सभी मैच होने चाहिए।

PHP में इस मान को सेट करने के लिए, setRedirectUri फ़ंक्शन को कॉल करें। ध्यान दें कि आपको प्रदान किए गए client_id लिए एक मान्य पुनर्निर्देशित URI निर्दिष्ट करना होगा।

$client->setRedirectUri('https://oauth2.example.com/code');
scope अपेक्षित

स्कोप की एक अंतरिक्ष-सीमांकित सूची जो उन संसाधनों की पहचान करती है जो आपका एप्लिकेशन उपयोगकर्ता की ओर से एक्सेस कर सकता है। ये मान उस सहमति स्क्रीन को सूचित करते हैं जो Google उपयोगकर्ता को दिखाता है।

स्कोप्स आपके एप्लिकेशन को केवल उन संसाधनों तक पहुंच के लिए अनुरोध करने में सक्षम बनाता है, जो उपयोगकर्ताओं को आपके एप्लिकेशन को प्रदान की जाने वाली पहुंच की मात्रा को नियंत्रित करने के लिए सक्षम करते हैं। इस प्रकार, अनुरोध किए गए स्कोप की संख्या और उपयोगकर्ता की सहमति प्राप्त करने की संभावना के बीच एक व्युत्क्रम संबंध है।

PHP में इस मान को सेट करने के लिए, addScope फ़ंक्शन को कॉल करें:

$client->addScope(Google_Service_Drive::DRIVE_METADATA_READONLY);

हम अनुशंसा करते हैं कि जब भी संभव हो, आपका आवेदन अनुरोध के संदर्भ में प्राधिकरण के लिए उपयोग कर सकता है। वृद्धिशील प्राधिकरण के माध्यम से उपयोगकर्ता डेटा तक पहुंच का अनुरोध करते हुए, आप उपयोगकर्ताओं को यह समझने में अधिक सहायता करते हैं कि आपके आवेदन को उस अनुरोध तक पहुंच की आवश्यकता क्यों है।

access_type सिफारिश की

इंगित करता है कि जब उपयोगकर्ता ब्राउज़र पर मौजूद नहीं है, तो आपका एप्लिकेशन टोकन तक ताज़ा कर सकता है या नहीं। मान्य पैरामीटर मान online , जो डिफ़ॉल्ट मान और offline

यदि उपयोगकर्ता ब्राउज़र में मौजूद नहीं है, तो आपके एप्लिकेशन को टोकन एक्सेस करने की आवश्यकता है, तो offline मान सेट करें। यह इस दस्तावेज़ में बाद में वर्णित टोकन को ताज़ा करने की विधि है। यह मान Google प्राधिकरण सर्वर को पहली बार एक ताज़ा टोकन और एक एक्सेस टोकन वापस करने का निर्देश देता है, जो आपके आवेदन टोकन के लिए एक प्राधिकरण कोड का आदान-प्रदान करता है।

PHP में इस मान को सेट करने के लिए, setAccessType फ़ंक्शन को कॉल करें:

01a5ab260
state सिफारिश की

आपके प्राधिकरण अनुरोध और प्राधिकरण सर्वर की प्रतिक्रिया के बीच स्थिति बनाए रखने के लिए आपके आवेदन का उपयोग करने वाले किसी भी स्ट्रिंग मूल्य को निर्दिष्ट करता है। सर्वर सही मूल्य है कि आप एक के रूप में भेज देता है name=value URL क्वेरी घटक में जोड़ी ( ? ) के redirect_uri करने के लिए उपयोगकर्ता सहमति के बाद या आपके आवेदन की पहुँच अनुरोध इनकार करते हैं।

आप इस पैरामीटर का उपयोग कई उद्देश्यों के लिए कर सकते हैं, जैसे कि उपयोगकर्ता को आपके एप्लिकेशन में सही संसाधन के लिए निर्देशित करना, नॉन भेजना और क्रॉस-साइट अनुरोध जालसाजी को कम करना। चूँकि आपके redirect_uri का अनुमान लगाया जा सकता है, state मूल्य का उपयोग करने से आपका आश्वासन बढ़ सकता है कि आने वाला कनेक्शन प्रमाणीकरण अनुरोध का परिणाम है। यदि आप एक यादृच्छिक स्ट्रिंग उत्पन्न करते हैं या कुकी के हैश या किसी अन्य मान को एनकोड करते हैं, जो ग्राहक की स्थिति को कैप्चर करता है, तो आप अतिरिक्त रूप से यह सुनिश्चित करने के लिए प्रतिक्रिया को मान्य कर सकते हैं कि अनुरोध और प्रतिक्रिया उसी ब्राउज़र में उत्पन्न हुई है, जो क्रॉस-साइट जैसे हमलों से सुरक्षा प्रदान करता है। जालसाजी का अनुरोध करें। state टोकन के निर्माण और पुष्टि करने के तरीके के लिए OpenID कनेक्ट प्रलेखन देखें।

PHP में इस मान को सेट करने के लिए, setState फ़ंक्शन को कॉल करें:

$client->setState($sample_passthrough_value);
include_granted_scopes ऐच्छिक

संदर्भ में अतिरिक्त स्कोप तक पहुंच का अनुरोध करने के लिए वृद्धिशील प्राधिकरण का उपयोग करने के लिए अनुप्रयोगों को सक्षम करता है। यदि आप इस पैरामीटर्स के मान को true सेट करते हैं और प्राधिकरण अनुरोध प्रदान किया जाता है, तो नए एक्सेस टोकन में किसी भी स्कोप को भी शामिल किया जाएगा, जिसे उपयोगकर्ता ने पहले एप्लिकेशन एक्सेस की अनुमति दी थी। उदाहरण के लिए वृद्धिशील प्राधिकरण अनुभाग देखें।

PHP में यह मान सेट करने के लिए, setIncludeGrantedScopes फ़ंक्शन को कॉल करें:

$client->setIncludeGrantedScopes(true);
login_hint ऐच्छिक

यदि आपका एप्लिकेशन जानता है कि कौन सा उपयोगकर्ता प्रमाणित करने का प्रयास कर रहा है, तो वह इस पैरामीटर का उपयोग Google प्रमाणीकरण सर्वर को संकेत देने के लिए कर सकता है। सर्वर साइन-इन फॉर्म में ईमेल फ़ील्ड को प्रीफ़िल करके या उपयुक्त मल्टी-लॉगिन सत्र का चयन करके लॉगिन फ़्लो को सरल बनाने के लिए संकेत का उपयोग करता है।

एक ईमेल पते या sub पहचानकर्ता के लिए पैरामीटर मान सेट करें, जो उपयोगकर्ता की Google आईडी के बराबर है।

PHP में इस मान को सेट करने के लिए, setLoginHint फ़ंक्शन को कॉल करें:

$client->setLoginHint('None');
prompt ऐच्छिक

उपयोगकर्ता को प्रस्तुत करने के लिए संकेतों की एक अंतरिक्ष-सीमांकित, केस-संवेदी सूची। यदि आप इस पैरामीटर को निर्दिष्ट नहीं करते हैं, तो उपयोगकर्ता को पहली बार आपके प्रोजेक्ट अनुरोधों तक पहुंचने का संकेत दिया जाएगा। अधिक जानकारी के लिए शीघ्र सहमति देखें।

PHP में इस मान को सेट करने के लिए, setApprovalPrompt फ़ंक्शन को कॉल करें:

$client->setApprovalPrompt('consent');

संभावित मूल्य हैं:

none कोई प्रमाणीकरण या सहमति स्क्रीन प्रदर्शित न करें। अन्य मानों के साथ निर्दिष्ट नहीं होना चाहिए।
consent सहमति के लिए उपयोगकर्ता को प्रेरित करें
select_account खाता चुनने के लिए उपयोगकर्ता को प्रेरित करें

अजगर

निम्न कोड स्निपेट प्राधिकरण अनुरोध का निर्माण करने के लिए google-auth-oauthlib.flow मॉड्यूल का उपयोग करता है।

कोड एक Flow ऑब्जेक्ट का निर्माण करता है, जो क्लाइंट_secret.json फ़ाइल की जानकारी का उपयोग करके आपके एप्लिकेशन की पहचान करता है जिसे आपने प्राधिकरण क्रेडेंशियल बनाने के बाद डाउनलोड किया था । वह वस्तु उन स्कोपों ​​की भी पहचान करती है, जो आपके एप्लिकेशन को एक्सेस करने की अनुमति देने का अनुरोध कर रहे हैं और URL आपके एप्लिकेशन के एंडपॉइंट एंडपॉइंट पर पहुंच रहे हैं, जो Google के OAuth 2.0 सर्वर से प्रतिक्रिया को हैंडल करेगा। अंत में, कोड सेट वैकल्पिक access_type और include_granted_scopes मानकों।

उदाहरण के लिए, यह कोड उपयोगकर्ता के Google ड्राइव पर केवल-पढ़ने के लिए ऑफ़लाइन पहुँच का अनुरोध करता है:

import google.oauth2.credentials
import google_auth_oauthlib.flow

# Use the client_secret.json file to identify the application requesting
# authorization. The client ID (from that file) and access scopes are required.
flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
    'client_secret.json',
    scopes=['https://www.googleapis.com/auth/drive.metadata.readonly'])

# Indicate where the API server will redirect the user after the user completes
# the authorization flow. The redirect URI is required. The value must exactly
# match one of the authorized redirect URIs for the OAuth 2.0 client, which you
# configured in the API Console. If this value doesn't match an authorized URI,
# you will get a 'redirect_uri_mismatch' error.
flow.redirect_uri = 'https://www.example.com/oauth2callback'

# Generate URL for request to Google's OAuth 2.0 server.
# Use kwargs to set optional request parameters.
authorization_url, state = flow.authorization_url(
    # Enable offline access so that you can refresh an access token without
    # re-prompting the user for permission. Recommended for web server apps.
    access_type='offline',
    # Enable incremental authorization. Recommended as a best practice.
    include_granted_scopes='true')

अनुरोध निम्नलिखित जानकारी निर्दिष्ट करता है:

मापदंडों
client_id अपेक्षित

आपके आवेदन के लिए क्लाइंट आईडी। आप इस मान को API Console Credentials page में पा सकते हैं।

पायथन में, क्लाइंट आईडी को क्लाइंट_secret.json फ़ाइल से पुनर्प्राप्त करने के लिए from_client_secrets_file विधि को कॉल करें। (आप from_client_config विधि का उपयोग भी कर सकते हैं, जो क्लाइंट कॉन्फ़िगरेशन को पास करता है क्योंकि यह मूल रूप से क्लाइंट रहस्य फ़ाइल में दिखाई देता है, लेकिन फ़ाइल को स्वयं एक्सेस नहीं करता है।)

flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
    'client_secret.json',
    scopes=['https://www.googleapis.com/auth/drive.metadata.readonly'])
redirect_uri अपेक्षित

यह निर्धारित करता है कि उपयोगकर्ता द्वारा प्राधिकरण प्रवाह पूरा करने के बाद एपीआई सर्वर उपयोगकर्ता को पुनर्निर्देशित करता है। मान OAuth 2.0 क्लाइंट के लिए अधिकृत पुनर्निर्देशित URI में से एक से मेल खाना चाहिए, जिसे आपने अपने क्लाइंट के API Console Credentials page में कॉन्फ़िगर किया था। यदि यह मान प्रदान किए गए client_id लिए एक अधिकृत पुनर्निर्देशित URI से मेल नहीं खाता है, तो आपको एक redirect_uri_mismatch client_id त्रुटि मिलेगी।

ध्यान दें कि http या https स्कीम, केस और ट्रेलिंग स्लैश (' / ') सभी मैच होने चाहिए।

पायथन में इस मान को सेट करने के लिए, flow ऑब्जेक्ट की redirect_uri प्रॉपर्टी सेट करें:

flow.redirect_uri = 'https://oauth2.example.com/code'
scope अपेक्षित

स्कोप की एक सूची जो उन संसाधनों की पहचान करती है जिन्हें आपका एप्लिकेशन उपयोगकर्ता की ओर से एक्सेस कर सकता है। ये मान उस सहमति स्क्रीन को सूचित करते हैं जो Google उपयोगकर्ता को दिखाता है।

स्कोप्स आपके एप्लिकेशन को केवल उन संसाधनों तक पहुंच का अनुरोध करने के लिए सक्षम करते हैं, जिनकी आवश्यकता उपयोगकर्ताओं को एक्सेस करने में सक्षम होती है, ताकि वे आपके एप्लिकेशन को दी जाने वाली पहुंच को नियंत्रित कर सकें। इस प्रकार, अनुरोध किए गए स्कोप की संख्या और उपयोगकर्ता की सहमति प्राप्त करने की संभावना के बीच एक विपरीत संबंध है।

पायथन में, उसी विधि का उपयोग करें जिसका उपयोग आप client_id की सूची निर्दिष्ट करने के लिए client_id को सेट करने के लिए करते हैं।

flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
    'client_secret.json',
    scopes=['https://www.googleapis.com/auth/drive.metadata.readonly'])
है

हम अनुशंसा करते हैं कि आपका आवेदन जब भी संभव हो, संदर्भ में प्राधिकरण स्कोप का उपयोग करें। वृद्धिशील प्राधिकरण के माध्यम से उपयोगकर्ता डेटा तक पहुंच का अनुरोध करते हुए, आप उपयोगकर्ताओं को यह समझने में अधिक सहायता करते हैं कि आपके आवेदन को उस अनुरोध तक पहुंच की आवश्यकता क्यों है।

access_type सिफारिश की

इंगित करता है कि जब उपयोगकर्ता ब्राउज़र पर मौजूद नहीं है, तो आपका एप्लिकेशन टोकन तक ताज़ा कर सकता है या नहीं। मान्य पैरामीटर मान online , जो डिफ़ॉल्ट मान और offline

यदि उपयोगकर्ता ब्राउज़र में मौजूद नहीं है, तो आपके एप्लिकेशन को टोकन एक्सेस करने की आवश्यकता है, तो offline मान सेट करें। यह इस दस्तावेज़ में बाद में वर्णित टोकन को ताज़ा करने की विधि है। यह मान Google प्राधिकरण सर्वर को पहली बार एक ताज़ा टोकन और एक एक्सेस टोकन वापस करने का निर्देश देता है, जो आपके आवेदन टोकन के लिए एक प्राधिकरण कोड का आदान-प्रदान करता है।

पायथन में, flow.authorization_url विधि को कॉल करते समय एक कीवर्ड तर्क के रूप में access_type निर्दिष्ट करके access_type पैरामीटर सेट करें:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    include_granted_scopes='true')
state सिफारिश की

आपके प्राधिकरण अनुरोध और प्राधिकरण सर्वर की प्रतिक्रिया के बीच स्थिति बनाए रखने के लिए आपके आवेदन का उपयोग करने वाले किसी भी स्ट्रिंग मूल्य को निर्दिष्ट करता है। सर्वर सही मूल्य है कि आप एक के रूप में भेज देता है name=value URL क्वेरी घटक में जोड़ी ( ? ) के redirect_uri करने के लिए उपयोगकर्ता सहमति के बाद या आपके आवेदन की पहुँच अनुरोध इनकार करते हैं।

आप इस पैरामीटर का उपयोग कई उद्देश्यों के लिए कर सकते हैं, जैसे कि उपयोगकर्ता को आपके आवेदन में सही संसाधन के लिए निर्देशित करना, नॉन भेजना और क्रॉस-साइट अनुरोध जालसाजी को कम करना। चूँकि आपके redirect_uri का अनुमान लगाया जा सकता है, state मूल्य का उपयोग करने से आपका आश्वासन बढ़ सकता है कि आने वाला कनेक्शन प्रमाणीकरण अनुरोध का परिणाम है। यदि आप एक यादृच्छिक स्ट्रिंग उत्पन्न करते हैं या कुकी के हैश या किसी अन्य मान को एनकोड करते हैं, जो क्लाइंट की स्थिति को कैप्चर करता है, तो आप अतिरिक्त रूप से यह सुनिश्चित करने के लिए प्रतिक्रिया को मान्य कर सकते हैं कि अनुरोध और प्रतिक्रिया एक ही ब्राउज़र में उत्पन्न हुई, क्रॉस-साइट जैसे हमलों से सुरक्षा प्रदान करना। जालसाजी का अनुरोध करें। state टोकन के निर्माण और पुष्टि करने के तरीके के लिए OpenID कनेक्ट प्रलेखन देखें।

पाइथन में, flow.authorization_url विधि को कॉल करते समय एक कीवर्ड तर्क के रूप में state को निर्दिष्ट करके state पैरामीटर सेट करें:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    state=sample_passthrough_value,
    include_granted_scopes='true')
include_granted_scopes ऐच्छिक

संदर्भ में अतिरिक्त स्कोप तक पहुंच का अनुरोध करने के लिए वृद्धिशील प्राधिकरण का उपयोग करने के लिए अनुप्रयोगों को सक्षम करता है। यदि आप इस पैरामीटर्स के मान को true सेट करते हैं और प्राधिकरण अनुरोध प्रदान किया जाता है, तो नए एक्सेस टोकन में किसी भी स्कोप को भी शामिल किया जाएगा, जिसे उपयोगकर्ता ने पहले एप्लिकेशन एक्सेस की अनुमति दी थी। उदाहरण के लिए वृद्धिशील प्राधिकरण अनुभाग देखें।

अजगर में, सेट include_granted_scopes पैरामीटर निर्दिष्ट द्वारा include_granted_scopes एक कीवर्ड तर्क के रूप में जब बुला flow.authorization_url विधि:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    include_granted_scopes='true')
login_hint ऐच्छिक

यदि आपका एप्लिकेशन जानता है कि कौन सा उपयोगकर्ता प्रमाणित करने का प्रयास कर रहा है, तो वह इस पैरामीटर का उपयोग Google प्रमाणीकरण सर्वर को संकेत देने के लिए कर सकता है। सर्वर साइन-इन फॉर्म में ईमेल फ़ील्ड को प्रीफ़िल करके या उपयुक्त मल्टी-लॉगिन सत्र का चयन करके लॉगिन फ़्लो को सरल बनाने के लिए संकेत का उपयोग करता है।

एक ईमेल पते या sub पहचानकर्ता के लिए पैरामीटर मान सेट करें, जो उपयोगकर्ता की Google आईडी के बराबर है।

पायथन में, flow.authorization_url विधि को कॉल करते समय एक login_hint तर्क के रूप में login_hint को निर्दिष्ट करके login_hint पैरामीटर सेट करें:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    login_hint='None',
    include_granted_scopes='true')
prompt ऐच्छिक

उपयोगकर्ता को प्रस्तुत करने के लिए संकेतों की एक अंतरिक्ष-सीमांकित, केस-संवेदी सूची। यदि आप इस पैरामीटर को निर्दिष्ट नहीं करते हैं, तो उपयोगकर्ता को केवल पहली बार आपकी परियोजना के अनुरोध तक पहुंचने का संकेत दिया जाएगा। अधिक जानकारी के लिए शीघ्र सहमति देखें।

पायथन में, flow.authorization_url को flow.authorization_url करते हुए कीवर्ड तर्क के रूप में prompt निर्दिष्ट करके prompt पैरामीटर सेट करें flow.authorization_url विधि:

authorization_url, state = flow.authorization_url(
      access_type='offline',
      prompt='consent',
      include_granted_scopes='true')

संभावित मूल्य हैं:

none कोई प्रमाणीकरण या सहमति स्क्रीन प्रदर्शित न करें। अन्य मानों के साथ निर्दिष्ट नहीं होना चाहिए।
consent सहमति के लिए उपयोगकर्ता को प्रेरित करें
select_account खाता चुनने के लिए उपयोगकर्ता को प्रेरित करें

माणिक

अपने अनुप्रयोग में क्लाइंट ऑब्जेक्ट को कॉन्फ़िगर करने के लिए बनाई गई client_secrets.json फ़ाइल का उपयोग करें। जब आप किसी क्लाइंट ऑब्जेक्ट को कॉन्फ़िगर करते हैं, तो आप अपने एप्लिकेशन के एक्सेसरी एंडपॉइंट के URL के साथ-साथ आपके एप्लिकेशन को एक्सेस करने की आवश्यकता वाले स्कोप्स को निर्दिष्ट करते हैं, जो OAuth 2.0 सर्वर से प्रतिक्रिया को हैंडल करेगा।

उदाहरण के लिए, यह कोड उपयोगकर्ता के Google ड्राइव पर केवल-पढ़ने के लिए ऑफ़लाइन पहुँच का अनुरोध करता है:

require 'google/apis/drive_v2'
require 'google/api_client/client_secrets'

client_secrets = Google::APIClient::ClientSecrets.load
auth_client = client_secrets.to_authorization
auth_client.update!(
  :scope => 'https://www.googleapis.com/auth/drive.metadata.readonly',
  :redirect_uri => 'http://www.example.com/oauth2callback',
  :additional_parameters => {
    "access_type" => "offline",         # offline access
    "include_granted_scopes" => "true"  # incremental auth
  }
)

आपका एप्लिकेशन OAuth 2.0 संचालन करने के लिए क्लाइंट ऑब्जेक्ट का उपयोग करता है, जैसे प्राधिकरण अनुरोध URL उत्पन्न करना और HTTP अनुरोधों तक पहुंच टोकन लागू करना।

HTTP / REST

Google का OAuth 2.0 समापन बिंदु https://accounts.google.com/o/oauth2/v2/auth । यह समापन बिंदु केवल HTTPS पर उपलब्ध है। सादे HTTP कनेक्शन से इनकार कर दिया जाता है।

Google प्राधिकरण सर्वर वेब सर्वर अनुप्रयोगों के लिए निम्नलिखित क्वेरी स्ट्रिंग मापदंडों का समर्थन करता है:

मापदंडों
client_id अपेक्षित

आपके आवेदन के लिए क्लाइंट आईडी। आप इस मान को API Console Credentials page में पा सकते हैं।

redirect_uri अपेक्षित

यह निर्धारित करता है कि उपयोगकर्ता द्वारा प्राधिकरण प्रवाह पूरा करने के बाद एपीआई सर्वर उपयोगकर्ता को पुनर्निर्देशित करता है। मान OAuth 2.0 क्लाइंट के लिए अधिकृत पुनर्निर्देशित URI में से एक से मेल खाना चाहिए, जिसे आपने अपने क्लाइंट के API Console Credentials page में कॉन्फ़िगर किया है। यदि यह मान प्रदान किए गए client_id लिए एक अधिकृत पुनर्निर्देशित URI से मेल नहीं खाता है, तो आपको एक redirect_uri_mismatch त्रुटि मिलेगी।

ध्यान दें कि http या https स्कीम, केस और ट्रेलिंग स्लैश (' / ') सभी मैच होने चाहिए।

response_type अपेक्षित

निर्धारित करता है कि Google OAuth 2.0 समापन बिंदु एक प्राधिकरण कोड देता है या नहीं।

वेब सर्वर अनुप्रयोगों code लिए code करने code लिए पैरामीटर मान सेट करें।

scope अपेक्षित

स्कोप की एक अंतरिक्ष-सीमांकित सूची जो उन संसाधनों की पहचान करती है जिन्हें आपका एप्लिकेशन उपयोगकर्ता की ओर से एक्सेस कर सकता है। ये मान उस सहमति स्क्रीन को सूचित करते हैं जो Google उपयोगकर्ता को दिखाता है।

स्कोप्स आपके एप्लिकेशन को केवल उन संसाधनों तक पहुंच के लिए अनुरोध करने में सक्षम बनाता है, जो उपयोगकर्ताओं को आपके एप्लिकेशन को प्रदान की जाने वाली पहुंच की मात्रा को नियंत्रित करने के लिए सक्षम करते हैं। इस प्रकार, अनुरोध किए गए स्कोप की संख्या और उपयोगकर्ता की सहमति प्राप्त करने की संभावना के बीच एक व्युत्क्रम संबंध है।

हम अनुशंसा करते हैं कि जब भी संभव हो, आपका आवेदन अनुरोध के संदर्भ में प्राधिकरण के लिए उपयोग कर सकता है। वृद्धिशील प्राधिकरण के माध्यम से उपयोगकर्ता डेटा तक पहुंच का अनुरोध करते हुए, आप उपयोगकर्ताओं को यह समझने में अधिक सहायता करते हैं कि आपके एप्लिकेशन को उस एक्सेस की आवश्यकता क्यों है जो वह अनुरोध कर रहा है।

access_type सिफारिश की

इंगित करता है कि जब उपयोगकर्ता ब्राउज़र पर मौजूद नहीं है, तो क्या आपका एप्लिकेशन टोकन तक ताज़ा कर सकता है। मान्य पैरामीटर मान online , जो डिफ़ॉल्ट मान और offline

यदि उपयोगकर्ता ब्राउज़र में मौजूद नहीं है, तो आपके एप्लिकेशन को टोकन एक्सेस करने की आवश्यकता है, तो offline मान सेट करें। यह इस दस्तावेज़ में बाद में वर्णित टोकन को ताज़ा करने की विधि है। यह मान Google प्राधिकरण सर्वर को पहली बार एक ताज़ा टोकन और एक एक्सेस टोकन वापस करने का निर्देश देता है, जो आपके आवेदन टोकन के लिए एक प्राधिकरण कोड का आदान-प्रदान करता है।

state सिफारिश की

आपके प्राधिकरण अनुरोध और प्राधिकरण सर्वर की प्रतिक्रिया के बीच स्थिति बनाए रखने के लिए आपके आवेदन का उपयोग करने वाले किसी भी स्ट्रिंग मूल्य को निर्दिष्ट करता है। सर्वर सही मूल्य है कि आप एक के रूप में भेज देता है name=value URL क्वेरी घटक में जोड़ी ( ? ) के redirect_uri करने के लिए उपयोगकर्ता सहमति के बाद या आपके आवेदन की पहुँच अनुरोध इनकार करते हैं।

आप इस पैरामीटर का उपयोग कई उद्देश्यों के लिए कर सकते हैं, जैसे कि उपयोगकर्ता को आपके एप्लिकेशन में सही संसाधन के लिए निर्देशित करना, नॉन भेजना और क्रॉस-साइट अनुरोध जालसाजी को कम करना। चूँकि आपके redirect_uri का अनुमान लगाया जा सकता है, state मूल्य का उपयोग करने से आपका आश्वासन बढ़ सकता है कि आने वाला कनेक्शन प्रमाणीकरण अनुरोध का परिणाम है। यदि आप एक यादृच्छिक स्ट्रिंग उत्पन्न करते हैं या कुकी के हैश या किसी अन्य मान को एनकोड करते हैं, जो क्लाइंट की स्थिति को कैप्चर करता है, तो आप अतिरिक्त रूप से यह सुनिश्चित करने के लिए प्रतिक्रिया को मान्य कर सकते हैं कि अनुरोध और प्रतिक्रिया एक ही ब्राउज़र में उत्पन्न हुई, क्रॉस-साइट जैसे हमलों से सुरक्षा प्रदान करना। जालसाजी का अनुरोध करें। state टोकन के निर्माण और पुष्टि करने के तरीके के लिए OpenID कनेक्ट प्रलेखन देखें।

include_granted_scopes ऐच्छिक

संदर्भ में अतिरिक्त स्कोप तक पहुंच का अनुरोध करने के लिए वृद्धिशील प्राधिकरण का उपयोग करने के लिए अनुप्रयोगों को सक्षम करता है। यदि आप इस पैरामीटर्स के मान को true सेट करते हैं और प्राधिकरण अनुरोध प्रदान किया जाता है, तो नए एक्सेस टोकन में कोई भी स्कोप शामिल होगा, जिस पर उपयोगकर्ता ने पहले एप्लिकेशन एक्सेस दी थी। उदाहरण के लिए वृद्धिशील प्राधिकरण अनुभाग देखें।

login_hint ऐच्छिक

यदि आपका एप्लिकेशन जानता है कि कौन सा उपयोगकर्ता प्रमाणित करने का प्रयास कर रहा है, तो वह इस पैरामीटर का उपयोग Google प्रमाणीकरण सर्वर को संकेत देने के लिए कर सकता है। सर्वर साइन-इन फॉर्म में ईमेल फ़ील्ड को प्रीफ़िल करके या उपयुक्त मल्टी-लॉगिन सत्र का चयन करके लॉगिन फ़्लो को सरल बनाने के लिए संकेत का उपयोग करता है।

एक ईमेल पते या sub पहचानकर्ता के लिए पैरामीटर मान सेट करें, जो उपयोगकर्ता की Google आईडी के बराबर है।

prompt ऐच्छिक

उपयोगकर्ता को प्रस्तुत करने के लिए संकेतों की एक अंतरिक्ष-सीमांकित, केस-संवेदी सूची। यदि आप इस पैरामीटर को निर्दिष्ट नहीं करते हैं, तो उपयोगकर्ता को पहली बार आपके प्रोजेक्ट अनुरोधों तक पहुंचने का संकेत दिया जाएगा। अधिक जानकारी के लिए शीघ्र सहमति देखें।

संभावित मूल्य हैं:

none कोई प्रमाणीकरण या सहमति स्क्रीन प्रदर्शित न करें। अन्य मानों के साथ निर्दिष्ट नहीं होना चाहिए।
consent सहमति के लिए उपयोगकर्ता को प्रेरित करें
select_account खाता चुनने के लिए उपयोगकर्ता को प्रेरित करें

चरण 2: Google के OAuth 2.0 सर्वर पर पुनर्निर्देशित

प्रमाणीकरण और प्राधिकरण प्रक्रिया शुरू करने के लिए उपयोगकर्ता को Google के OAuth 2.0 सर्वर पर पुनर्निर्देशित करें। आमतौर पर, यह तब होता है जब आपके एप्लिकेशन को पहले उपयोगकर्ता के डेटा तक पहुंचने की आवश्यकता होती है। वृद्धिशील प्राधिकरण के मामले में, यह कदम तब भी होता है जब आपके आवेदन को पहले अतिरिक्त संसाधनों का उपयोग करने की आवश्यकता होती है जो इसे अभी तक उपयोग करने की अनुमति नहीं है।

पीएचपी

  1. Google के OAuth 2.0 सर्वर:
    $auth_url = $client->createAuthUrl();
    से पहुंच का अनुरोध करने के लिए एक URL बनाएं
  2. उपयोगकर्ता को $auth_url पुनर्निर्देशित करें:
    header('Location: ' . filter_var($auth_url, FILTER_SANITIZE_URL));

अजगर

यह उदाहरण दिखाता है कि फ्लास्क वेब एप्लिकेशन ढांचे का उपयोग करके उपयोगकर्ता को प्राधिकरण URL पर पुनर्निर्देशित कैसे करें:

return flask.redirect(authorization_url)

माणिक

  1. Google के OAuth 2.0 सर्वर:
    auth_uri = auth_client.authorization_uri.to_s
    से पहुंच का अनुरोध करने के लिए एक URL बनाएं
  2. उपयोगकर्ता को auth_uri पुनर्निर्देशित करें।

HTTP / REST

नमूना Google के प्राधिकरण सर्वर पर रीडायरेक्ट होता है

एक उदाहरण URL नीचे दिखाया गया है, जिसमें पठनीयता के लिए लाइन ब्रेक और रिक्त स्थान हैं।

https://accounts.google.com/o/oauth2/v2/auth?
 scope=https%3A//www.googleapis.com/auth/drive.metadata.readonly&
 access_type=offline&
 include_granted_scopes=true&
 response_type=code&
 state=state_parameter_passthrough_value&
 redirect_uri=https%3A//oauth2.example.com/code&
 client_id=client_id

आपके द्वारा अनुरोध URL बनाने के बाद, इसे उपयोगकर्ता को पुनर्निर्देशित करें।

Google का OAuth 2.0 सर्वर उपयोगकर्ता को प्रमाणित करता है और आपके आवेदन के लिए अनुरोध किए गए स्कोप तक पहुंचने के लिए उपयोगकर्ता से सहमति प्राप्त करता है। आपके द्वारा निर्दिष्ट रीडायरेक्ट URL का उपयोग करके प्रतिक्रिया को आपके आवेदन पर वापस भेज दिया जाता है।

चरण 3: Google सहमति के लिए उपयोगकर्ता को संकेत देता है

इस चरण में, उपयोगकर्ता तय करता है कि आपके आवेदन को अनुरोधित पहुंच प्रदान करनी है या नहीं। इस स्तर पर, Google एक सहमति विंडो प्रदर्शित करता है जो आपके एप्लिकेशन का नाम और Google API सेवाओं को दिखाता है कि वह उपयोगकर्ता के प्राधिकरण क्रेडेंशियल के साथ उपयोग करने की अनुमति का अनुरोध कर रहा है और दी जाने वाली पहुंच के स्कोप का सारांश है। उपयोगकर्ता तब आपके आवेदन द्वारा अनुरोधित एक या अधिक स्कोप तक पहुंच प्रदान करने या अनुरोध को अस्वीकार करने के लिए सहमति दे सकता है।

आपके एप्लिकेशन को इस स्तर पर कुछ भी करने की आवश्यकता नहीं है क्योंकि यह Google के OAuth 2.0 सर्वर से प्रतिक्रिया का इंतजार कर रहा है जो बताता है कि क्या कोई एक्सेस दी गई थी। उस प्रतिक्रिया को निम्नलिखित चरण में समझाया गया है।

चरण 4: OAuth 2.0 सर्वर प्रतिक्रिया को हैंडल करें

OAuth 2.0 सर्वर अनुरोध में निर्दिष्ट URL का उपयोग करके आपके एप्लिकेशन के एक्सेस अनुरोध का जवाब देता है।

यदि उपयोगकर्ता पहुंच अनुरोध को मंजूरी देता है, तो प्रतिक्रिया में एक प्राधिकरण कोड होता है। यदि उपयोगकर्ता अनुरोध को मंजूरी नहीं देता है, तो प्रतिक्रिया में त्रुटि संदेश होता है। वेब सर्वर पर लौटाया गया प्राधिकरण कोड या त्रुटि संदेश क्वेरी स्ट्रिंग पर दिखाई देता है, जैसा कि नीचे दिखाया गया है:

एक त्रुटि प्रतिक्रिया:

https://oauth2.example.com/auth?error=access_denied

एक प्राधिकरण कोड प्रतिक्रिया:

https://oauth2.example.com/auth?code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7

नमूना OAuth 2.0 सर्वर प्रतिक्रिया

आप निम्न नमूना URL पर क्लिक करके इस प्रवाह का परीक्षण कर सकते हैं, जो आपके Google ड्राइव में फ़ाइलों के लिए मेटाडेटा देखने के लिए केवल-पढ़ने के लिए पहुँच का अनुरोध करता है:

https://accounts.google.com/o/oauth2/v2/auth?
 scope=https%3A//www.googleapis.com/auth/drive.metadata.readonly&
 access_type=offline&
 include_granted_scopes=true&
 response_type=code&
 state=state_parameter_passthrough_value&
 redirect_uri=https%3A//oauth2.example.com/code&
 client_id=client_id
है

OAuth 2.0 प्रवाह को पूरा करने के बाद, आपको http://localhost/oauth2callback पुनर्निर्देशित किया जाना चाहिए, जब तक कि आपके स्थानीय मशीन उस पते पर एक फ़ाइल का काम न करे, 404 NOT FOUND त्रुटि होगी। अगला चरण यूआरआई में वापस की गई जानकारी के बारे में अधिक विवरण प्रदान करता है जब उपयोगकर्ता आपके आवेदन पर वापस भेज दिया जाता है।

चरण 5: टोकन और पहुँच टोकन के लिए विनिमय प्राधिकरण कोड

वेब सर्वर को प्राधिकरण कोड प्राप्त होने के बाद, यह एक्सेस टोकन के लिए प्राधिकरण कोड का आदान-प्रदान कर सकता है।

पीएचपी

एक्सेस टोकन के लिए एक प्राधिकरण कोड का आदान-प्रदान करने के लिए, authenticate विधि का उपयोग करें:

$client->authenticate($_GET['code']);

आप getAccessToken टोकन के साथ एक्सेस टोकन प्राप्त कर सकते हैं:

$access_token = $client->getAccessToken();

अजगर

अपने कॉलबैक पृष्ठ पर, प्राधिकरण सर्वर प्रतिक्रिया को सत्यापित करने के लिए google-auth पुस्‍तकालय का उपयोग करें। फिर, पहुँच टोकन के लिए उस प्रतिक्रिया में प्राधिकरण कोड का आदान-प्रदान करने के लिए flow.fetch_token विधि का उपयोग करें:

state = flask.session['state']
flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
    'client_secret.json',
    scopes=['https://www.googleapis.com/auth/drive.metadata.readonly'],
    state=state)
flow.redirect_uri = flask.url_for('oauth2callback', _external=True)

authorization_response = flask.request.url
flow.fetch_token(authorization_response=authorization_response)

# Store the credentials in the session.
# ACTION ITEM for developers:
#     Store user's access and refresh tokens in your data store if
#     incorporating this code into your real app.
credentials = flow.credentials
flask.session['credentials'] = {
    'token': credentials.token,
    'refresh_token': credentials.refresh_token,
    'token_uri': credentials.token_uri,
    'client_id': credentials.client_id,
    'client_secret': credentials.client_secret,
    'scopes': credentials.scopes}

माणिक

एक्सेस टोकन के लिए एक प्राधिकरण कोड का आदान-प्रदान करने के लिए, fetch_access_token! उपयोग करें fetch_access_token! तरीका:

auth_client.code = auth_code
auth_client.fetch_access_token!

HTTP / REST

एक्सेस टोकन के लिए एक प्राधिकरण कोड का आदान-प्रदान करने के लिए, https://oauth2.googleapis.com/token समापन बिंदु पर कॉल करें और निम्नलिखित पैरामीटर सेट करें:

खेत
client_id क्लाइंट आईडी API Console Credentials page से प्राप्त किया गया।
client_secret क्लाइंट रहस्य API Console Credentials page से प्राप्त किया गया।
code प्रारंभिक अनुरोध से प्राधिकरण कोड वापस आ गया।
grant_type जैसा कि OAuth 2.0 विनिर्देश में परिभाषित किया गया है , इस क्षेत्र का मान authorization_code सेट होना चाहिए।
redirect_uri दिए गए client_id लिए API Console Credentials page में आपके प्रोजेक्ट के लिए सूचीबद्ध पुनर्निर्देशित URI में से एक।

निम्नलिखित स्निपेट एक नमूना अनुरोध दिखाता है:

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&
client_id=your_client_id&
client_secret=your_client_secret&
redirect_uri=https%3A//oauth2.example.com/code&
grant_type=authorization_code

Google JSON ऑब्जेक्ट को वापस करके इस अनुरोध का जवाब देता है जिसमें एक अल्पकालिक एक्सेस टोकन और एक ताज़ा टोकन होता है। ध्यान दें कि ताज़ा टोकन तभी लौटाया जाता है जब आपका एप्लिकेशन Google के प्राधिकरण सर्वर के लिए प्रारंभिक अनुरोध में access_type पैरामीटर को offline करने के लिए सेट करता है

प्रतिक्रिया में निम्नलिखित फ़ील्ड शामिल हैं:

खेत
access_token Google API अनुरोध को अधिकृत करने के लिए आपके द्वारा भेजा गया टोकन।
expires_in सेकंड में एक्सेस टोकन का शेष जीवनकाल।
refresh_token एक टोकन जिसे आप एक नया एक्सेस टोकन प्राप्त करने के लिए उपयोग कर सकते हैं। ताज़ा टोकन तब तक मान्य हैं जब तक उपयोगकर्ता पहुँच को रद्द नहीं करता। यदि आप Google के प्राधिकरण सर्वर के लिए प्रारंभिक अनुरोध में offline तक access_type पैरामीटर सेट करते हैं, तो यह फ़ील्ड केवल इस प्रतिक्रिया में मौजूद है।
scope access_token द्वारा दी गई पहुँच के access_token को अंतरिक्ष-सीमांकित, केस-संवेदी स्ट्रिंग्स की सूची के रूप में व्यक्त किया गया है।
token_type टोकन का प्रकार वापस आ गया। इस समय, इस फ़ील्ड का मान हमेशा Bearer लिए निर्धारित होता है।

The following snippet shows a sample response:

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "token_type": "Bearer",
  "scope": "https://www.googleapis.com/auth/drive.metadata.readonly",
  "refresh_token": "1//xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
}

Calling Google APIs

PHP

Use the access token to call Google APIs by completing the following steps:

  1. If you need to apply an access token to a new Google_Client object—for example, if you stored the access token in a user session—use the setAccessToken method:
    $client->setAccessToken($access_token);
  2. Build a service object for the API that you want to call. You build a service object by providing an authorized Google_Client object to the constructor for the API you want to call. For example, to call the Drive API:
    $drive = new Google_Service_Drive($client);
  3. Make requests to the API service using the interface provided by the service object . For example, to list the files in the authenticated user's Google Drive:
    $files = $drive->files->listFiles(array())->getItems();

Python

After obtaining an access token, your application can use that token to authorize API requests on behalf of a given user account or service account. Use the user-specific authorization credentials to build a service object for the API that you want to call, and then use that object to make authorized API requests.

  1. Build a service object for the API that you want to call. You build a service object by calling the googleapiclient.discovery library's build method with the name and version of the API and the user credentials: For example, to call version 2 of the Drive API:
    from googleapiclient.discovery import build
    
    drive = build('drive', 'v2', credentials=credentials)
  2. Make requests to the API service using the interface provided by the service object . For example, to list the files in the authenticated user's Google Drive:
    files = drive.files().list().execute()

Ruby

Use the auth_client object to call Google APIs by completing the following steps:

  1. Build a service object for the API that you want to call. For example, to call version 2 of the Drive API:
    drive = Google::Apis::DriveV2::DriveService.new
  2. Set the credentials on the service:
    drive.authorization = auth_client
  3. Make requests to the API service using the interface provided by the service object . For example, to list the files in the authenticated user's Google Drive:
    files = drive.list_files

Alternately, authorization can be provided on a per-method basis by supplying the options parameter to a method:

files = drive.list_files(options: { authorization: auth_client })

HTTP/REST

After your application obtains an access token, you can use the token to make calls to a Google API on behalf of a given user account if the scope(s) of access required by the API have been granted. To do this, include the access token in a request to the API by including either an access_token query parameter or an Authorization HTTP header Bearer value. When possible, the HTTP header is preferable, because query strings tend to be visible in server logs. In most cases you can use a client library to set up your calls to Google APIs (for example, when calling the Drive Files API ).

You can try out all the Google APIs and view their scopes at the OAuth 2.0 Playground .

HTTP GET examples

A call to the drive.files endpoint (the Drive Files API) using the Authorization: Bearer HTTP header might look like the following. Note that you need to specify your own access token:

GET /drive/v2/files HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

Here is a call to the same API for the authenticated user using the access_token query string parameter:

GET https://www.googleapis.com/drive/v2/files?access_token=access_token

curl examples

You can test these commands with the curl command-line application. Here's an example that uses the HTTP header option (preferred):

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files

Or, alternatively, the query string parameter option:

curl https://www.googleapis.com/drive/v2/files?access_token=access_token

Complete example

The following example prints a JSON-formatted list of files in a user's Google Drive after the user authenticates and gives consent for the application to access the user's Drive metadata.

PHP

To run this example:

  1. In the API Console, add the URL of the local machine to the list of redirect URLs. For example, add http://localhost:8080 .
  2. Create a new directory and change to it. For example:
    mkdir ~/php-oauth2-example
    cd ~/php-oauth2-example
  3. Install the Google API Client Library for PHP using Composer :
    composer require google/apiclient:^2.0
  4. Create the files index.php and oauth2callback.php with the content below.
  5. Run the example with a web server configured to serve PHP. If you use PHP 5.4 or newer, you can use PHP's built-in test web server:
    php -S localhost:8080 ~/php-oauth2-example

index.php

<?php
require_once __DIR__.'/vendor/autoload.php';

session_start();

$client = new Google_Client();
$client->setAuthConfig('client_secrets.json');
$client->addScope(Google_Service_Drive::DRIVE_METADATA_READONLY);

if (isset($_SESSION['access_token']) && $_SESSION['access_token']) {
  $client->setAccessToken($_SESSION['access_token']);
  $drive = new Google_Service_Drive($client);
  $files = $drive->files->listFiles(array())->getItems();
  echo json_encode($files);
} else {
  $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php';
  header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}

oauth2callback.php

<?php
require_once __DIR__.'/vendor/autoload.php';

session_start();

$client = new Google_Client();
$client->setAuthConfigFile('client_secrets.json');
$client->setRedirectUri('http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php');
$client->addScope(Google_Service_Drive::DRIVE_METADATA_READONLY);

if (! isset($_GET['code'])) {
  $auth_url = $client->createAuthUrl();
  header('Location: ' . filter_var($auth_url, FILTER_SANITIZE_URL));
} else {
  $client->authenticate($_GET['code']);
  $_SESSION['access_token'] = $client->getAccessToken();
  $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/';
  header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}

Python

This example uses the Flask framework. It runs a web application at http://localhost:8080 that lets you test the OAuth 2.0 flow. If you go to that URL, you should see four links:

  • Test an API request: This link points to a page that tries to execute a sample API request. If necessary, it starts the authorization flow. If successful, the page displays the API response.
  • Test the auth flow directly: This link points to a page that tries to send the user through the authorization flow . The app requests permission to submit authorized API requests on the user's behalf.
  • Revoke current credentials: This link points to a page that revokes permissions that the user has already granted to the application.
  • Clear Flask session credentials: This link clears authorization credentials that are stored in the Flask session. This lets you see what would happen if a user who had already granted permission to your app tried to execute an API request in a new session. It also lets you see the API response your app would get if a user had revoked permissions granted to your app, and your app still tried to authorize a request with a revoked access token.
# -*- coding: utf-8 -*-

import os
import flask
import requests

import google.oauth2.credentials
import google_auth_oauthlib.flow
import googleapiclient.discovery

# This variable specifies the name of a file that contains the OAuth 2.0
# information for this application, including its client_id and client_secret.
CLIENT_SECRETS_FILE = "client_secret.json"

# This OAuth 2.0 access scope allows for full read/write access to the
# authenticated user's account and requires requests to use an SSL connection.
SCOPES = ['https://www.googleapis.com/auth/drive.metadata.readonly']
API_SERVICE_NAME = 'drive'
API_VERSION = 'v2'

app = flask.Flask(__name__)
# Note: A secret key is included in the sample so that it works.
# If you use this code in your application, replace this with a truly secret
# key. See https://flask.palletsprojects.com/quickstart/#sessions.
app.secret_key = 'REPLACE ME - this value is here as a placeholder.'


@app.route('/')
def index():
  return print_index_table()


@app.route('/test')
def test_api_request():
  if 'credentials' not in flask.session:
    return flask.redirect('authorize')

  # Load credentials from the session.
  credentials = google.oauth2.credentials.Credentials(
      **flask.session['credentials'])

  drive = googleapiclient.discovery.build(
      API_SERVICE_NAME, API_VERSION, credentials=credentials)

  files = drive.files().list().execute()

  # Save credentials back to session in case access token was refreshed.
  # ACTION ITEM: In a production app, you likely want to save these
  #              credentials in a persistent database instead.
  flask.session['credentials'] = credentials_to_dict(credentials)

  return flask.jsonify(**files)


@app.route('/authorize')
def authorize():
  # Create flow instance to manage the OAuth 2.0 Authorization Grant Flow steps.
  flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
      CLIENT_SECRETS_FILE, scopes=SCOPES)

  # The URI created here must exactly match one of the authorized redirect URIs
  # for the OAuth 2.0 client, which you configured in the API Console. If this
  # value doesn't match an authorized URI, you will get a 'redirect_uri_mismatch'
  # error.
  flow.redirect_uri = flask.url_for('oauth2callback', _external=True)

  authorization_url, state = flow.authorization_url(
      # Enable offline access so that you can refresh an access token without
      # re-prompting the user for permission. Recommended for web server apps.
      access_type='offline',
      # Enable incremental authorization. Recommended as a best practice.
      include_granted_scopes='true')

  # Store the state so the callback can verify the auth server response.
  flask.session['state'] = state

  return flask.redirect(authorization_url)


@app.route('/oauth2callback')
def oauth2callback():
  # Specify the state when creating the flow in the callback so that it can
  # verified in the authorization server response.
  state = flask.session['state']

  flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
      CLIENT_SECRETS_FILE, scopes=SCOPES, state=state)
  flow.redirect_uri = flask.url_for('oauth2callback', _external=True)

  # Use the authorization server's response to fetch the OAuth 2.0 tokens.
  authorization_response = flask.request.url
  flow.fetch_token(authorization_response=authorization_response)

  # Store credentials in the session.
  # ACTION ITEM: In a production app, you likely want to save these
  #              credentials in a persistent database instead.
  credentials = flow.credentials
  flask.session['credentials'] = credentials_to_dict(credentials)

  return flask.redirect(flask.url_for('test_api_request'))


@app.route('/revoke')
def revoke():
  if 'credentials' not in flask.session:
    return ('You need to <a href="/authorize">authorize</a> before ' +
            'testing the code to revoke credentials.')

  credentials = google.oauth2.credentials.Credentials(
    **flask.session['credentials'])

  revoke = requests.post('https://oauth2.googleapis.com/revoke',
      params={'token': credentials.token},
      headers = {'content-type': 'application/x-www-form-urlencoded'})

  status_code = getattr(revoke, 'status_code')
  if status_code == 200:
    return('Credentials successfully revoked.' + print_index_table())
  else:
    return('An error occurred.' + print_index_table())


@app.route('/clear')
def clear_credentials():
  if 'credentials' in flask.session:
    del flask.session['credentials']
  return ('Credentials have been cleared.<br><br>' +
          print_index_table())


def credentials_to_dict(credentials):
  return {'token': credentials.token,
          'refresh_token': credentials.refresh_token,
          'token_uri': credentials.token_uri,
          'client_id': credentials.client_id,
          'client_secret': credentials.client_secret,
          'scopes': credentials.scopes}

def print_index_table():
  return ('<table>' +
          '<tr><td><a href="/test">Test an API request</a></td>' +
          '<td>Submit an API request and see a formatted JSON response. ' +
          '    Go through the authorization flow if there are no stored ' +
          '    credentials for the user.</td></tr>' +
          '<tr><td><a href="/authorize">Test the auth flow directly</a></td>' +
          '<td>Go directly to the authorization flow. If there are stored ' +
          '    credentials, you still might not be prompted to reauthorize ' +
          '    the application.</td></tr>' +
          '<tr><td><a href="/revoke">Revoke current credentials</a></td>' +
          '<td>Revoke the access token associated with the current user ' +
          '    session. After revoking credentials, if you go to the test ' +
          '    page, you should see an <code>invalid_grant</code> error.' +
          '</td></tr>' +
          '<tr><td><a href="/clear">Clear Flask session credentials</a></td>' +
          '<td>Clear the access token currently stored in the user session. ' +
          '    After clearing the token, if you <a href="/test">test the ' +
          '    API request</a> again, you should go back to the auth flow.' +
          '</td></tr></table>')


if __name__ == '__main__':
  # When running locally, disable OAuthlib's HTTPs verification.
  # ACTION ITEM for developers:
  #     When running in production *do not* leave this option enabled.
  os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'

  # Specify a hostname and port that are set as a valid redirect URI
  # for your API project in the Google API Console.
  app.run('localhost', 8080, debug=True)

Ruby

This example uses the Sinatra framework.

require 'google/apis/drive_v2'
require 'google/api_client/client_secrets'
require 'json'
require 'sinatra'

enable :sessions
set :session_secret, 'setme'

get '/' do
  unless session.has_key?(:credentials)
    redirect to('/oauth2callback')
  end
  client_opts = JSON.parse(session[:credentials])
  auth_client = Signet::OAuth2::Client.new(client_opts)
  drive = Google::Apis::DriveV2::DriveService.new
  files = drive.list_files(options: { authorization: auth_client })
  "<pre>#{JSON.pretty_generate(files.to_h)}</pre>"
end

get '/oauth2callback' do
  client_secrets = Google::APIClient::ClientSecrets.load
  auth_client = client_secrets.to_authorization
  auth_client.update!(
    :scope => 'https://www.googleapis.com/auth/drive.metadata.readonly',
    :redirect_uri => url('/oauth2callback'))
  if request['code'] == nil
    auth_uri = auth_client.authorization_uri.to_s
    redirect to(auth_uri)
  else
    auth_client.code = request['code']
    auth_client.fetch_access_token!
    auth_client.client_secret = nil
    session[:credentials] = auth_client.to_json
    redirect to('/')
  end
end

HTTP/REST

This Python example uses the Flask framework and the Requests library to demonstrate the OAuth 2.0 web flow. We recommend using the Google API Client Library for Python for this flow. (The example in the Python tab does use the client library.)

import json

import flask
import requests


app = flask.Flask(__name__)

CLIENT_ID = '123456789.apps.googleusercontent.com'
CLIENT_SECRET = 'abc123'  # Read from a file or environmental variable in a real app
SCOPE = 'https://www.googleapis.com/auth/drive.metadata.readonly'
REDIRECT_URI = 'http://example.com/oauth2callback'


@app.route('/')
def index():
  if 'credentials' not in flask.session:
    return flask.redirect(flask.url_for('oauth2callback'))
  credentials = json.loads(flask.session['credentials'])
  if credentials['expires_in'] <= 0:
    return flask.redirect(flask.url_for('oauth2callback'))
  else:
    headers = {'Authorization': 'Bearer {}'.format(credentials['access_token'])}
    req_uri = 'https://www.googleapis.com/drive/v2/files'
    r = requests.get(req_uri, headers=headers)
    return r.text


@app.route('/oauth2callback')
def oauth2callback():
  if 'code' not in flask.request.args:
    auth_uri = ('https://accounts.google.com/o/oauth2/v2/auth?response_type=code'
                '&client_id={}&redirect_uri={}&scope={}').format(CLIENT_ID, REDIRECT_URI, SCOPE)
    return flask.redirect(auth_uri)
  else:
    auth_code = flask.request.args.get('code')
    data = {'code': auth_code,
            'client_id': CLIENT_ID,
            'client_secret': CLIENT_SECRET,
            'redirect_uri': REDIRECT_URI,
            'grant_type': 'authorization_code'}
    r = requests.post('https://oauth2.googleapis.com/token', data=data)
    flask.session['credentials'] = r.text
    return flask.redirect(flask.url_for('index'))


if __name__ == '__main__':
  import uuid
  app.secret_key = str(uuid.uuid4())
  app.debug = False
  app.run()

Redirect URI validation rules

Google applies the following validation rules to redirect URIs in order to help developers keep their applications secure. Your redirect URIs must adhere to these rules. See RFC 3986 section 3 for the definition of domain, host, path, query, scheme and userinfo, mentioned below.

Validation rules
Scheme

URIs must use the HTTPS scheme, not plain HTTP.

Host

Hosts cannot be raw IP addresses. Localhost IP addresses are exempted from this rule.

Domain
  • Host TLDs ( Top Level Domains ) must belong to the public suffix list .
  • Host domains cannot be “googleusercontent.com” .
  • URIs cannot contain URL shortener domains (eg goo.gl ) unless the app owns the domain. Furthermore, if an app that owns a shortener domain chooses to redirect to that domain, that redirect URI must either contain “/google-callback/” in its path or end with “/google-callback” .
  • Userinfo

    Redirect URIs cannot contain the userinfo subcomponent.

    Path

    Redirect URIs cannot contain a path traversal (also called directory backtracking), which is represented by an “/..” or “\..” or their URL encoding.

    Query

    Redirect URIs cannot contain open redirects .

    Characters URIs cannot contain certain characters including:
    • Wildcard characters ( '*' )
    • Non-printable ASCII characters
    • Invalid percent encodings (any percent encoding that does not follow URL-encoding form of a percent sign followed by two hexadecimal digits)
    • Null characters (an encoded NULL character, eg, %00 , %C0%80 )

    Incremental authorization

    In the OAuth 2.0 protocol, your app requests authorization to access resources, which are identified by scopes. It is considered a best user-experience practice to request authorization for resources at the time you need them. To enable that practice, Google's authorization server supports incremental authorization. This feature lets you request scopes as they are needed and, if the user grants permission for the new scope, returns an authorization code that may be exchanged for a token containing all scopes the user has granted the project.

    For example, an app that lets people sample music tracks and create mixes might need very few resources at sign-in time, perhaps nothing more than the name of the person signing in. However, saving a completed mix would require access to their Google Drive. Most people would find it natural if they only were asked for access to their Google Drive at the time the app actually needed it.

    In this case, at sign-in time the app might request the openid and profile scopes to perform basic sign-in, and then later request the https://www.googleapis.com/auth/drive.file scope at the time of the first request to save a mix.

    To implement incremental authorization, you complete the normal flow for requesting an access token but make sure that the authorization request includes previously granted scopes. This approach allows your app to avoid having to manage multiple access tokens.

    The following rules apply to an access token obtained from an incremental authorization:

    • The token can be used to access resources corresponding to any of the scopes rolled into the new, combined authorization.
    • When you use the refresh token for the combined authorization to obtain an access token, the access token represents the combined authorization and can be used for any of the scope values included in the response.
    • The combined authorization includes all scopes that the user granted to the API project even if the grants were requested from different clients. For example, if a user granted access to one scope using an application's desktop client and then granted another scope to the same application via a mobile client, the combined authorization would include both scopes.
    • If you revoke a token that represents a combined authorization, access to all of that authorization's scopes on behalf of the associated user are revoked simultaneously.

    The language-specific code samples in Step 1: Set authorization parameters and the sample HTTP/REST redirect URL in Step 2: Redirect to Google's OAuth 2.0 server all use incremental authorization. The code samples below also show the code that you need to add to use incremental authorization.

    PHP

    $client->setIncludeGrantedScopes(true);

    Python

    In Python, set the include_granted_scopes keyword argument to true to ensure that an authorization request includes previously granted scopes. It is very possible that include_granted_scopes will not be the only keyword argument that you set, as shown in the example below.

    authorization_url, state = flow.authorization_url(
        # Enable offline access so that you can refresh an access token without
        # re-prompting the user for permission. Recommended for web server apps.
        access_type='offline',
        # Enable incremental authorization. Recommended as a best practice.
        include_granted_scopes='true')

    Ruby

    auth_client.update!(
      :additional_parameters => {"include_granted_scopes" => "true"}
    )

    HTTP/REST

    GET https://accounts.google.com/o/oauth2/v2/auth?
      client_id=your_client_id&
      response_type=code&
      state=state_parameter_passthrough_value&
      scope=https%3A//www.googleapis.com/auth/drive.file&
      redirect_uri=https%3A//oauth2.example.com/code&
      prompt=consent&
      include_granted_scopes=true

    Refreshing an access token (offline access)

    Access tokens periodically expire and become invalid credentials for a related API request. You can refresh an access token without prompting the user for permission (including when the user is not present) if you requested offline access to the scopes associated with the token.

    • If you use a Google API Client Library, the client object refreshes the access token as needed as long as you configure that object for offline access.
    • If you are not using a client library, you need to set the access_type HTTP query parameter to offline when redirecting the user to Google's OAuth 2.0 server . In that case, Google's authorization server returns a refresh token when you exchange an authorization code for an access token. Then, if the access token expires (or at any other time), you can use a refresh token to obtain a new access token.

    Requesting offline access is a requirement for any application that needs to access a Google API when the user is not present. For example, an app that performs backup services or executes actions at predetermined times needs to be able to refresh its access token when the user is not present. The default style of access is called online .

    Server-side web applications, installed applications, and devices all obtain refresh tokens during the authorization process. Refresh tokens are not typically used in client-side (JavaScript) web applications.

    PHP

    If your application needs offline access to a Google API, set the API client's access type to offline :

    $client->setAccessType("offline");

    After a user grants offline access to the requested scopes, you can continue to use the API client to access Google APIs on the user's behalf when the user is offline. The client object will refresh the access token as needed.

    Python

    In Python, set the access_type keyword argument to offline to ensure that you will be able to refresh the access token without having to re-prompt the user for permission. It is very possible that access_type will not be the only keyword argument that you set, as shown in the example below.

    authorization_url, state = flow.authorization_url(
        # Enable offline access so that you can refresh an access token without
        # re-prompting the user for permission. Recommended for web server apps.
        access_type='offline',
        # Enable incremental authorization. Recommended as a best practice.
        include_granted_scopes='true')

    After a user grants offline access to the requested scopes, you can continue to use the API client to access Google APIs on the user's behalf when the user is offline. The client object will refresh the access token as needed.

    Ruby

    If your application needs offline access to a Google API, set the API client's access type to offline :

    auth_client.update!(
      :additional_parameters => {"access_type" => "offline"}
    )

    After a user grants offline access to the requested scopes, you can continue to use the API client to access Google APIs on the user's behalf when the user is offline. The client object will refresh the access token as needed.

    HTTP/REST

    To refresh an access token, your application sends an HTTPS POST request to Google's authorization server ( https://oauth2.googleapis.com/token ) that includes the following parameters:

    Fields
    client_id The client ID obtained from the API Console.
    client_secret The client secret obtained from the API Console.
    grant_type As defined in the OAuth 2.0 specification , this field's value must be set to refresh_token .
    refresh_token The refresh token returned from the authorization code exchange.

    The following snippet shows a sample request:

    POST /token HTTP/1.1
    Host: oauth2.googleapis.com
    Content-Type: application/x-www-form-urlencoded
    
    client_id=your_client_id&
    client_secret=your_client_secret&
    refresh_token=refresh_token&
    grant_type=refresh_token

    As long as the user has not revoked the access granted to the application, the token server returns a JSON object that contains a new access token. The following snippet shows a sample response:

    {
      "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
      "expires_in": 3920,
      "scope": "https://www.googleapis.com/auth/drive.metadata.readonly",
      "token_type": "Bearer"
    }

    Note that there are limits on the number of refresh tokens that will be issued; one limit per client/user combination, and another per user across all clients. You should save refresh tokens in long-term storage and continue to use them as long as they remain valid. If your application requests too many refresh tokens, it may run into these limits, in which case older refresh tokens will stop working.

    Revoking a token

    In some cases a user may wish to revoke access given to an application. A user can revoke access by visiting Account Settings . See the Remove site or app access section of the Third-party sites & apps with access to your account support document for more information.

    It is also possible for an application to programmatically revoke the access given to it. Programmatic revocation is important in instances where a user unsubscribes, removes an application, or the API resources required by an app have significantly changed. In other words, part of the removal process can include an API request to ensure the permissions previously granted to the application are removed.

    PHP

    To programmatically revoke a token, call revokeToken() :

    $client->revokeToken();

    Python

    To programmatically revoke a token, make a request to https://oauth2.googleapis.com/revoke that includes the token as a parameter and sets the Content-Type header:

    requests.post('https://oauth2.googleapis.com/revoke',
        params={'token': credentials.token},
        headers = {'content-type': 'application/x-www-form-urlencoded'})

    Ruby

    To programmatically revoke a token, make an HTTP request to the oauth2.revoke endpoint:

    uri = URI('https://oauth2.googleapis.com/revoke')
    response = Net::HTTP.post_form(uri, 'token' => auth_client.access_token)
    

    The token can be an access token or a refresh token. If the token is an access token and it has a corresponding refresh token, the refresh token will also be revoked.

    If the revocation is successfully processed, then the status code of the response is 200 . For error conditions, a status code 400 is returned along with an error code.

    HTTP/REST

    To programmatically revoke a token, your application makes a request to https://oauth2.googleapis.com/revoke and includes the token as a parameter:

    curl -d -X -POST --header "Content-type:application/x-www-form-urlencoded" \
            https://oauth2.googleapis.com/revoke?token={token}

    The token can be an access token or a refresh token. If the token is an access token and it has a corresponding refresh token, the refresh token will also be revoked.

    If the revocation is successfully processed, then the HTTP status code of the response is 200 . For error conditions, an HTTP status code 400 is returned along with an error code.