OAuth के साथ Google खाता लिंक करना

खाते, इंडस्ट्री स्टैंडर्ड OAuth 2.0 इंप्लिसिट और ऑथराइज़ेशन कोड फ़्लो का इस्तेमाल करके जोड़े जाते हैं. आपकी सेवा में, OAuth 2.0 का पालन करने वाले अनुमति और टोकन एक्सचेंज एंडपॉइंट काम करने चाहिए.

इंप्लिसिट फ़्लो में, Google, उपयोगकर्ता के ब्राउज़र में ऑथराइज़ेशन एंडपॉइंट खोलता है. साइन इन करने के बाद, आप Google को लंबे समय तक ऐक्सेस टोकन देते हैं. यह ऐक्सेस टोकन अब Google के भेजे गए हर अनुरोध में शामिल है.

ऑथराइज़ेशन कोड फ़्लो में, आपको दो एंडपॉइंट की ज़रूरत होती है:

  • अनुमति देने वाला एंडपॉइंट, जो आपके उन उपयोगकर्ताओं को साइन-इन यूज़र इंटरफ़ेस (यूआई) दिखाता है जो पहले से साइन इन नहीं हैं. ऑथराइज़ेशन एंडपॉइंट, अनुरोध किए गए ऐक्सेस के लिए, उपयोगकर्ताओं और #39 को रिकॉर्ड करने के लिए, कम समय के लिए बनाया गया ऑथराइज़ेशन कोड भी बनाता है.

  • टोकन एक्सचेंज एंडपॉइंट, जो दो तरह के एक्सचेंज के लिए ज़िम्मेदार है:

    1. लंबे समय तक चलने वाले रीफ़्रेश टोकन और कुछ समय के लिए इस्तेमाल किए जा सकने वाले ऐक्सेस टोकन के लिए ऑथराइज़ेशन कोड एक्सचेंज करता है. यह एक्सचेंज तब होता है, जब उपयोगकर्ता खाते को जोड़ने के फ़्लो से गुज़रता है.
    2. कुछ समय के लिए इस्तेमाल किए जा सकने वाले ऐक्सेस टोकन के लिए, लंबे समय तक चलने वाले रीफ़्रेश टोकन की अदला-बदली होती है. यह एक्सचेंज तब होता है, जब Google को नए ऐक्सेस टोकन की ज़रूरत होती है, क्योंकि इसे ऐक्सेस करने की समयसीमा खत्म हो चुकी है.

OAuth 2.0 फ़्लो चुनना

हालांकि, इंप्लिसिट फ़्लो को लागू करना ज़्यादा आसान है, लेकिन Google का सुझाव है कि इंप्लिसिट फ़्लो से जारी किए गए ऐक्सेस टोकन की समयसीमा कभी खत्म न हो. ऐसा इसलिए होता है, क्योंकि टोकन की समयसीमा खत्म होने के बाद, उपयोगकर्ता को अपने खाते को फिर से जोड़ना पड़ता है. अगर आपको सुरक्षा की वजहों से टोकन की समयसीमा खत्म करने की ज़रूरत है, तो हमारा सुझाव है कि आप इसके बजाय ऑथराइज़ेशन कोड फ़्लो का इस्तेमाल करें.

डिज़ाइन गाइडलाइन

इस सेक्शन में, उपयोगकर्ता के स्क्रीन को डिज़ाइन करने से जुड़ी ज़रूरी शर्तों और सुझावों के बारे में बताया गया है. यह स्क्रीन आपको OAuth लिंक करने के फ़्लो के लिए होस्ट करती है. Google के ऐप्लिकेशन के कॉल करने के बाद, आपका प्लैटफ़ॉर्म Google पेज में साइन इन करता है और उपयोगकर्ता को खाता जोड़ने की सहमति स्क्रीन दिखाता है. खातों को जोड़ने की सहमति देने के बाद, उपयोगकर्ता को Google&#39s के ऐप्लिकेशन पर वापस भेज दिया जाता है.

यह डायग्राम, उपयोगकर्ता के लिए Google खाते को आपके पुष्टि करने वाले सिस्टम से जोड़ने का तरीका बताता है. पहले स्क्रीनशॉट में उपयोगकर्ता को
            अपने प्लैटफ़ॉर्म से जोड़ना दिखाया गया है. दूसरी इमेज में उपयोगकर्ता को Google में साइन इन दिखाया गया है. वहीं, तीसरी इमेज में उपयोगकर्ता के Google खाते को आपके ऐप्लिकेशन से जोड़ने के लिए
 सहमति और पुष्टि दिखाई गई है.
 आखिरी स्क्रीनशॉट में Google ऐप्लिकेशन में जोड़ा गया उपयोगकर्ता खाता
 दिखता है.
पहली इमेज. उपयोगकर्ता को साइन इन करने वाले खाते का इस्तेमाल करके, Google खाते का इस्तेमाल करने के लिए सहमति देने वाली स्क्रीन.

ज़रूरी शर्तें

  1. आपको बताना होगा कि उपयोगकर्ता का खाता Google से जोड़ा जाएगा, Google Home या Google Assistant जैसे Google के किसी खास प्रॉडक्ट से नहीं.

सुझाव

हम आपको ये काम करने का सुझाव देते हैं:

  1. Google की # नीति दिखाने के लिए. सहमति वाली स्क्रीन पर Google की निजता नीति का लिंक शामिल करें.

  2. शेयर किया जाने वाला डेटा. उपयोगकर्ता को यह बताने के लिए कि उन्हें अपने डेटा की ज़रूरत क्यों और क्यों है, आसान और संक्षिप्त भाषा का इस्तेमाल करें.

  3. कॉल-टू-ऐक्शन मिटाएं. अपनी सहमति स्क्रीन पर साफ़ कॉल-टू-ऐक्शन बताएं, जैसे कि "सहमत हैं और लिंक करें". इसकी वजह यह है कि उपयोगकर्ताओं को यह समझना ज़रूरी है कि उन्हें अपने खाते लिंक करने के लिए, Google के साथ कौनसा डेटा शेयर करना है.

  4. सदस्यता रद्द करने की सुविधा. अगर उपयोगकर्ता लिंक नहीं करना चाहते हैं, तो उन्हें वापस या रद्द करने का तरीका बताएं.

  5. साइन इन करने की प्रोसेस हटाएं. पक्का करें कि उपयोगकर्ताओं के पास अपने Google खाते में साइन इन करने का साफ़ तरीका है, जैसे कि उनके उपयोगकर्ता नाम और पासवर्ड के लिए फ़ील्ड या Google से साइन इन करें.

  6. खाता अलग करने की सुविधा. उपयोगकर्ताओं को अनलिंक करने का तरीका दें, जैसे कि अपने प्लैटफ़ॉर्म पर अपनी खाता सेटिंग का एक यूआरएल. इसके अलावा, आप Google खाते से जुड़ा एक लिंक भी शामिल कर सकते हैं. इससे उपयोगकर्ता अपने जोड़े गए खाते को मैनेज कर पाएंगे.

  7. उपयोगकर्ता खाता बदलने की सुविधा. उपयोगकर्ताओं को अपने खाते(खातों) को स्विच करने का तरीका बताएं. यह खास तौर पर तब फ़ायदेमंद होता है, जब उपयोगकर्ता एक से ज़्यादा खाते इस्तेमाल करते हैं.

    • अगर किसी उपयोगकर्ता को खाते स्विच करने के लिए, सहमति देने वाली स्क्रीन बंद करनी होती है, तो उसे वापस पाया जा सकने वाला गड़बड़ी का मैसेज Google को भेजें, ताकि उपयोगकर्ता OAuth लिंकिंग और इंप्लिसिट फ़्लो से अपनी पसंद के खाते में साइन इन कर सके.
  8. अपना लोगो शामिल करें. सहमति वाली स्क्रीन पर अपनी कंपनी का लोगो दिखाएं. अपना लोगो रखने के लिए अपनी शैली के दिशा-निर्देशों का इस्तेमाल करें. अगर आप Google का # लोगो भी दिखाना चाहते हैं, तो लोगो और ट्रेडमार्क देखें.

प्रोजेक्ट बनाना

खाता लिंक करने के मकसद से अपना प्रोजेक्ट बनाने के लिए:

  1. Go to the Google API Console.
  2. प्रोजेक्ट बनाएं पर क्लिक करें
  3. एक नाम दर्ज करें या उत्पन्न सुझाव को स्वीकार करें।
  4. किसी भी शेष फ़ील्ड की पुष्टि करें या संपादित करें।
  5. क्रिएट पर क्लिक करें

अपना प्रोजेक्ट आईडी देखने के लिए:

  1. Go to the Google API Console.
  2. लैंडिंग पृष्ठ पर तालिका में अपना प्रोजेक्ट ढूंढें। प्रोजेक्ट आईडी ID कॉलम में दिखाई देती है।

Google खाता लिंक करने की प्रोसेस में, सहमति वाली स्क्रीन शामिल होती है. इस स्क्रीन पर, उपयोगकर्ताओं को उनके डेटा के ऐक्सेस का अनुरोध करने वाला ऐप्लिकेशन, किस तरह का डेटा चाहिए, और इस पर लागू होने वाली शर्तों के बारे में जानकारी मिलती है. Google API क्लाइंट आईडी जनरेट करने से पहले, आपको उस स्क्रीन को कॉन्फ़िगर करना होगा जहां OAuth के लिए सहमति दी जाती है.

  1. Google API कंसोल का OAuth सहमति स्क्रीन पेज खोलें.
  2. अगर कहा जाए, तो वह प्रोजेक्ट चुनें जिसे आपने अभी-अभी बनाया है.
  3. "OAuth की सहमति वाली स्क्रीन" पेज पर, फ़ॉर्म भरें और "सेव करें" बटन पर क्लिक करें.

    ऐप्लिकेशन का नाम: सहमति मांगने वाले ऐप्लिकेशन का नाम. नाम, आपके ऐप्लिकेशन के बारे में एकदम सही तरीके से बताता हो. साथ ही, ऐप्लिकेशन का वही नाम होना चाहिए जो उपयोगकर्ताओं को कहीं और दिखता है. ऐप्लिकेशन का नाम, खाता जोड़ने की सहमति वाली स्क्रीन पर दिखेगा.

    ऐप्लिकेशन का लोगो: सहमति वाली स्क्रीन पर दिखने वाली ऐसी इमेज जो उपयोगकर्ताओं को आपके ऐप्लिकेशन को पहचानने में मदद करेगी. यह लोगो, खाता लिंक करने की सहमति वाली स्क्रीन और खाता सेटिंग पर दिखता है

    सहायता ईमेल: इसकी मदद से उपयोगकर्ता, अपनी सहमति के बारे में सवाल पूछने के लिए आपसे संपर्क कर सकते हैं.

    Google API के स्कोप: स्कोप की मदद से, आपका ऐप्लिकेशन आपके उपयोगकर्ता का निजी Google डेटा ऐक्सेस कर सकता है. Google खाता जोड़ने के लिए इस्तेमाल के उदाहरण में, डिफ़ॉल्ट दायरा (ईमेल, प्रोफ़ाइल, openid) ही काफ़ी है. आपको संवेदनशील दायरा जोड़ने की ज़रूरत नहीं है. आम तौर पर, स्कोप के बढ़ते अनुरोध का सबसे सही तरीका यह है कि उस समय ऐक्सेस की ज़रूरत हो, न कि शुरुआत में. ज़्यादा जानें.

    अनुमति वाले डोमेन: आपकी और आपके उपयोगकर्ताओं की सुरक्षा के लिए, Google सिर्फ़ उन ऐप्लिकेशन को अनुमति देता है जो अनुमति वाले डोमेन के इस्तेमाल की पुष्टि करने के लिए, OAuth का इस्तेमाल करते हैं. आपके ऐप्लिकेशन के लिंक अधिकृत डोमेन पर होस्ट होने चाहिए. ज़्यादा जानें.

    ऐप्लिकेशन का होम पेज लिंक: आपके ऐप्लिकेशन का होम पेज. किसी अधिकृत डोमेन पर होस्ट किया जाना चाहिए.

    ऐप्लिकेशन की निजता नीति का लिंक: यह Google खाता लिंक करने के लिए सहमति वाली स्क्रीन पर दिखाया जाता है. किसी अधिकृत डोमेन पर होस्ट किया जाना चाहिए.

    ऐप्लिकेशन की सेवा की शर्तों का लिंक (ज़रूरी नहीं): इसे किसी ऐसे डोमेन पर होस्ट किया जाना चाहिए जिसे अनुमति मिली हो.

    पहला डायग्राम. काल्पनिक ऐप्लिकेशन और ट्यूरी के लिए, Google खाता लिंक करने की सहमति वाली स्क्रीन

  4. अगर आपके आवेदन को पुष्टि की ज़रूरत है, तो "पुष्टि की स्थिति" पर क्लिक करें. इसके बाद, पुष्टि के लिए अपना आवेदन सबमिट करने के लिए, "पुष्टि के लिए सबमिट करें" बटन पर क्लिक करें. ज़्यादा जानकारी के लिए, OAuth की पुष्टि करने से जुड़ी ज़रूरी शर्तें देखें.

अपना OAuth सर्वर लागू करें

To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authentication and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.

When a Google application needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.

A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:

  1. Google opens your authorization endpoint in the user's browser. The user signs in, if not signed in already, and grants Google permission to access their data with your API, if they haven't already granted permission.
  2. Your service creates an access token and returns it to Google. To do so, redirect the user's browser back to Google with the access token attached to the request.
  3. Google calls your service's APIs and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.

Handle authorization requests

When a Google application needs to perform account linking via an OAuth 2.0 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:

Authorization endpoint parameters
client_id The client ID you assigned to Google.
redirect_uri The URL to which you send the response to this request.
state A bookkeeping value that is passed back to Google unchanged in the redirect URI.
response_type The type of value to return in the response. For the OAuth 2.0 implicit flow, the response type is always token.
user_locale The Google Account language setting in RFC5646 format used to localize your content in the user's preferred language.

For example, if your authorization endpoint is available at https://myservice.example.com/auth, a request might look like the following:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token&user_locale=LOCALE

For your authorization endpoint to handle sign-in requests, do the following steps:

  1. Verify the client_id and redirect_uri values to prevent granting access to unintended or misconfigured client apps:

    • Confirm that the client_id matches the client ID you assigned to Google.
    • Confirm that the URL specified by the redirect_uri parameter has the following form:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
      
  2. Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.

  3. Generate an access token for Google to use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.

  4. Send an HTTP response that redirects the user's browser to the URL specified by the redirect_uri parameter. Include all of the following parameters in the URL fragment:

    • access_token: The access token you just generated
    • token_type: The string bearer
    • state: The unmodified state value from the original request

    The following is an example of the resulting URL:

    https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google's OAuth 2.0 redirect handler receives the access token and confirms that the state value hasn't changed. After Google has obtained an access token for your service, Google attaches the token to subsequent calls to your service APIs.

उपयोगकर्ता जानकारी अनुरोधों को संभालें

UserInfo endpoint OAuth 2.0 संरक्षित संसाधन है कि लिंक किया गया प्रयोक्ता के बारे में वापसी का दावा है। निम्नलिखित उपयोग के मामलों को छोड़कर, userinfo एंडपॉइंट को लागू करना और होस्ट करना वैकल्पिक है:

आपके टोकन एंडपॉइंट से एक्सेस टोकन को सफलतापूर्वक पुनर्प्राप्त करने के बाद, Google लिंक किए गए उपयोगकर्ता के बारे में बुनियादी प्रोफ़ाइल जानकारी पुनर्प्राप्त करने के लिए आपके उपयोगकर्ता जानकारी एंडपॉइंट पर एक अनुरोध भेजता है।

userinfo समापन बिंदु अनुरोध शीर्षलेख
Authorization header बियरर प्रकार का एक्सेस टोकन।

उदाहरण के लिए, यदि आपके UserInfo समाप्ति बिंदु पर उपलब्ध है https://myservice.example.com/userinfo , एक अनुरोध निम्नलिखित प्रकार दिखाई देंगे:

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

अनुरोधों को संभालने के लिए आपके userinfo समापन बिंदु के लिए, निम्न चरणों का पालन करें:

  1. प्राधिकरण हेडर से एक्सेस टोकन निकालें और एक्सेस टोकन से जुड़े उपयोगकर्ता के लिए जानकारी लौटाएं।
  2. यदि पहुँच टोकन अमान्य है, उपयोग करने के साथ एक HTTP 401 अनधिकृत त्रुटि वापस WWW-Authenticate रिस्पांस हैडर। नीचे एक UserInfo त्रुटि प्रतिसाद का एक उदाहरण है:
    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: error="invalid_token",
    error_description="The Access Token expired"
    
    तो एक 401 अनधिकृत, या किसी अन्य असफल त्रुटि प्रतिसाद लिंकिंग प्रक्रिया के दौरान दिया जाता है, त्रुटि गैर वसूली योग्य हो जाएगा, पुनर्प्राप्त टोकन को छोड़ दिया जाएगा और उपयोगकर्ता होगा फिर से जोड़ने की प्रक्रिया शुरू करने के लिए।
  3. पहुँच टोकन मान्य, वापसी और HTTP 200 HTTPS प्रतिक्रिया के शरीर में निम्नलिखित JSON ऑब्जेक्ट के साथ प्रतिक्रिया है:

    {
    "sub": "USER_UUID",
    "email": "EMAIL_ADDRESS",
    "given_name": "FIRST_NAME",
    "family_name": "LAST_NAME",
    "name": "FULL_NAME",
    "picture": "PROFILE_PICTURE",
    }
    
    अपने UserInfo endpoint रिटर्न पर HTTP 200 सफलता प्रतिक्रिया करते हैं, तो टोकन लिया गया और दावों उपयोगकर्ता के Google के खिलाफ पंजीकृत हैं लेखा।

    userinfo समापन बिंदु प्रतिक्रिया
    sub एक विशिष्ट आईडी जो आपके सिस्टम में उपयोगकर्ता की पहचान करती है।
    email उपयोगकर्ता का ईमेल पता।
    given_name वैकल्पिक: उपयोगकर्ता के नाम को।
    family_name वैकल्पिक: उपयोगकर्ता के उपनाम को।
    name वैकल्पिक: उपयोगकर्ता का पूरा नाम।
    picture वैकल्पिक: उपयोगकर्ता के प्रोफ़ाइल चित्र।

लागू करने की पुष्टि की जा रही है

You can validate your implementation by using the OAuth 2.0 Playground tool.

In the tool, do the following steps:

  1. Click Configuration to open the OAuth 2.0 Configuration window.
  2. In the OAuth flow field, select Client-side.
  3. In the OAuth Endpoints field, select Custom.
  4. Specify your OAuth 2.0 endpoint and the client ID you assigned to Google in the corresponding fields.
  5. In the Step 1 section, don't select any Google scopes. Instead, leave this field blank or type a scope valid for your server (or an arbitrary string if you don't use OAuth scopes). When you're done, click Authorize APIs.
  6. In the Step 2 and Step 3 sections, go through the OAuth 2.0 flow and verify that each step works as intended.

You can validate your implementation by using the Google Account Linking Demo tool.

In the tool, do the following steps:

  1. Click the Sign-in with Google button.
  2. Choose the account you'd like to link.
  3. Enter the service ID.
  4. Optionally enter one or more scopes that you will request access for.
  5. Click Start Demo.
  6. When prompted, confirm that you may consent and deny the linking request.
  7. Confirm that you are redirected to your platform.