OAuth पर आधारित 'Google साइन इन' की मदद से खाता लिंक करना "Streamलाइन" लिंक करना

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

लिंक करने की इस प्रोसेस की शुरुआत, Google से साइन इन करने से होती है. इससे यह पता चलता है कि उपयोगकर्ता की Google प्रोफ़ाइल की जानकारी आपके सिस्टम में मौजूद है या नहीं. अगर उपयोगकर्ता की जानकारी आपके सिस्टम में नहीं मिलती है, तो सामान्य OAuth फ़्लो शुरू हो जाता है. उपयोगकर्ता के पास, Google प्रोफ़ाइल की जानकारी का इस्तेमाल करके नया खाता बनाने का विकल्प भी होता है.

पहली इमेज: जब आपके ऐक्शन को उपयोगकर्ता की Google प्रोफ़ाइल का ऐक्सेस मिल जाता है, तब इसका इस्तेमाल करके, अपने पुष्टि करने वाले सिस्टम में उपयोगकर्ता से मिलती-जुलती प्रोफ़ाइल ढूंढी जा सकती है.

खाता लिंक करने की आसान सुविधा का इस्तेमाल करके, खाता लिंक करने के लिए यह सामान्य तरीका अपनाएं:

  1. सबसे पहले, उपयोगकर्ता से उसकी Google प्रोफ़ाइल को ऐक्सेस करने की सहमति लें.
  2. उपयोगकर्ता की पहचान करने के लिए, उसकी प्रोफ़ाइल में मौजूद जानकारी का इस्तेमाल करें.
  3. अगर आपको अपने पुष्टि करने वाले सिस्टम में, Google उपयोगकर्ता का कोई मैच नहीं मिलता है, तो फ़्लो इस बात पर निर्भर करता है कि आपने Actions console में अपने Actions प्रोजेक्ट को कॉन्फ़िगर किया है या नहीं. कॉन्फ़िगर करने पर, उपयोगकर्ता को आवाज़ से या सिर्फ़ आपकी वेबसाइट पर खाता बनाने की अनुमति दी जाती है.
    • अगर आपने आवाज़ से खाता बनाने की सुविधा चालू की है, तो Google से मिले आईडी टोकन की पुष्टि करें. इसके बाद, आईडी टोकन में मौजूद प्रोफ़ाइल की जानकारी के आधार पर उपयोगकर्ता बनाया जा सकता है.
    • अगर आपने आवाज़ से खाता बनाने की सुविधा चालू नहीं की है, तो उपयोगकर्ता को ऐसे ब्राउज़र पर भेज दिया जाता है जहां वह अनुमति देने वाला पेज लोड कर सकता है. साथ ही, उपयोगकर्ता के लिए खाता बनाने की प्रोसेस पूरी कर सकता है.
अगर आपने आवाज़ से खाता बनाने की अनुमति दी है और आपको पुष्टि करने वाले सिस्टम में Google प्रोफ़ाइल से मेल खाने वाली कोई प्रोफ़ाइल नहीं मिलती है, तो आपको Google से मिले आईडी टोकन की पुष्टि करनी होगी. इसके बाद, आईडी टोकन में मौजूद प्रोफ़ाइल की जानकारी के आधार पर, उपयोगकर्ता बनाया जा सकता है.
            अगर आपने आवाज़ से उपयोगकर्ता खाता बनाने की अनुमति नहीं दी है, तो उपयोगकर्ता को ब्राउज़र पर ट्रांसफ़र कर दिया जाता है. यहां वह अनुमति देने वाला पेज लोड कर सकता है और फ़्लो पूरा कर सकता है.
दूसरी इमेज. जब आपके सिस्टम में किसी व्यक्ति की जानकारी नहीं मिलती है, तब OAuth और Google साइन इन के फ़्लो को दिखाने वाली इमेज.

आवाज़ का इस्तेमाल करके खाता बनाने की सुविधा

अगर आपने आवाज़ से उपयोगकर्ता खाता बनाने की अनुमति दी है, तो Assistant उपयोगकर्ता से यह पूछती है कि क्या उसे ये काम करने हैं:

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

अगर आपको खाता बनाने के फ़्लो में आने वाली मुश्किलों को कम करना है, तो हमारा सुझाव है कि आवाज़ से खाता बनाने की सुविधा चालू करें. अगर उपयोगकर्ता को किसी मौजूदा गैर-Google खाते से साइन इन करना है, तो उसे सिर्फ़ तब वॉइस फ़्लो से बाहर निकलना होगा.

आवाज़ का इस्तेमाल करके खाता बनाने की सुविधा बंद करना

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

अगर ये शर्तें पूरी होती हैं, तो हम आपको ऑफ़र बनाने की अनुमति न देने का सुझाव देते हैं:

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

  • आपके पास खाता बनाने के फ़्लो का पूरा कंट्रोल होना चाहिए. उदाहरण के लिए, अगर आपको खाता बनाने के दौरान उपयोगकर्ता को सेवा की शर्तें दिखानी हैं, तो खाता बनाने की अनुमति न दें.

OAuth पर आधारित, Google साइन-इन की "आसान" लिंकिंग लागू करना

खाते, इंडस्ट्री स्टैंडर्ड के OAuth 2.0 फ़्लो के साथ लिंक किए जाते हैं. Actions on Google, इंप्लिसिट और ऑथराइज़ेशन कोड फ़्लो के साथ काम करता है.

In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.

In the authorization code flow, you need two endpoints:

  • The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
  • The token exchange endpoint, which is responsible for two types of exchanges:
    1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
    2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

प्रोजेक्ट को कॉन्फ़िगर करना

स्ट्रीमलाइन किए गए लिंक करने की सुविधा का इस्तेमाल करने के लिए, अपने प्रोजेक्ट को कॉन्फ़िगर करने के लिए यह तरीका अपनाएं:

  1. Actions console खोलें और वह प्रोजेक्ट चुनें जिसका आपको इस्तेमाल करना है.
  2. डेवलप करें टैब पर क्लिक करें और खाता लिंक करना चुनें.
  3. खाता लिंक करना के बगल में मौजूद स्विच को चालू करें.
  4. खाता बनाने की सुविधा सेक्शन में, हां चुनें.

  5. लिंक करने का टाइप में जाकर, OAuth और Google से साइन इन करें और इंप्लिसिट को चुनें.

  6. क्लाइंट की जानकारी में जाकर, यह तरीका अपनाएं:

    • Google से आने वाले अनुरोधों की पहचान करने के लिए, 'कार्रवाइयों के लिए Google की ओर से जारी किया गया क्लाइंट आईडी' एट्रिब्यूट की वैल्यू असाइन करें.
    • अपने ऑथराइज़ेशन और टोकन एक्सचेंज एंडपॉइंट के लिए यूआरएल डालें.
  7. सेव करें पर क्लिक करें.

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

To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating 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 your Action 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 by redirecting 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 your Action 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.

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

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

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
      YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.
  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 that Google will 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 will receive the access token and confirm that the state value hasn't changed. After Google has obtained an access token for your service, Google will attach the token to subsequent calls to your Action as part of the AppRequest.

Handle automatic linking

After the user gives your Action consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.

If the corresponding Google account is already present in your authentication system, your token exchange endpoint returns a token for the user. If the Google account doesn't match an existing user, your token exchange endpoint returns a user_not_found error.

The request has the following form:

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

grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES

Your token exchange endpoint must be able to handle the following parameters:

Token endpoint parameters
grant_type The type of token being exchanged. For these requests, this parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer.
intent For these requests, the value of this parameter is `get`.
assertion A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address.
consent_code Optional: When present, a one-time code that indicates that the user has granted consent for your Action to access the specified scopes.
scope Optional: Any scopes you configured Google to request from users.

When your token exchange endpoint receives the linking request, it should do the following:

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "locale": "en_US"
}

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com and that the audience (aud field) is the client ID assigned to your Action.

Check if the Google account is already present in your authentication system

Check whether either of the following conditions are true:

  • The Google Account ID, found in the assertion's sub field, is in your user database.
  • The email address in the assertion matches a user in your user database.

If either condition is true, the user has already signed up and you can issue an access token.

If neither the Google Account ID nor the email address specified in the assertion matches a user in your database, the user hasn't signed up yet. In this case, your token exchange endpoint should reply with a HTTP 401 error, that specifies error=user_not_found, as in the following example:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"user_not_found",
}
When Google receives the 401 error response with a user_not_found error, Google calls your token exchange endpoint with the value of the intent parameter set to create and sending an ID token that contains the user's profile information with the request.

Handle account creation via Google Sign-In

When a user needs to create an account on your service, Google makes a request to your token exchange endpoint that specifies intent=create, as in the following example:

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

response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]

The assertion parameter contains A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address, which you can use to create a new account on your service.

To respond to account creation requests, your token exchange endpoint must do the following:

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "jan@gmail.com", // If present, the user's email address
  "locale": "en_US"
}

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com and that the audience (aud field) is the client ID assigned to your Action.

Validate user information and create new account

Check whether either of the following conditions are true:

  • The Google Account ID, found in the assertion's sub field, is in your user database.
  • The email address in the assertion matches a user in your user database.

If either condition is true, prompt the user to link their existing account with their Google Account by responding to the request with an HTTP 401 error, specifying error=linking_error and the user's email address as the login_hint, as in the following example:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

If neither condition is true, create a new user account using the information provided in the JWT. New accounts do not typically have a password set. It is recommended that you add Google Sign In to other platforms to enable users to log in via Google across the surfaces of your application. Alternatively, you can email the user a link that starts your password recovery flow to allow the user to set a password for signing in on other platforms.

When the creation is completed, issue an access token and return the values in a JSON object in the body of your HTTPS response, like in the following example:

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",
  
  "expires_in": SECONDS_TO_EXPIRATION
}

पुष्टि करने के फ़्लो के लिए, वॉइस यूज़र इंटरफ़ेस डिज़ाइन करना

देखें कि उपयोगकर्ता की पुष्टि हो गई है या नहीं. इसके बाद, खाता लिंक करने का फ़्लो शुरू करें

  1. Actions Console में अपना Actions Builder प्रोजेक्ट खोलें.
  2. अपने ऐक्शन में खाता लिंक करने की सुविधा शुरू करने के लिए, एक नया सीन बनाएं:
    1. सीन पर क्लिक करें.
    2. नया सीन जोड़ने के लिए, जोड़ें (+) आइकॉन पर क्लिक करें.
  3. नए बनाए गए सीन में, शर्तें के लिए, जोड़ें आइकॉन पर क्लिक करें.
  4. ऐसी शर्त जोड़ें जिससे यह पता चल सके कि बातचीत से जुड़ा उपयोगकर्ता, पुष्टि किया गया उपयोगकर्ता है या नहीं. अगर जांच पूरी नहीं होती है, तो बातचीत के दौरान आपकी कार्रवाई, खाता लिंक करने की सुविधा का इस्तेमाल नहीं कर सकती. साथ ही, उसे ऐसी सुविधा का ऐक्सेस देना चाहिए जिसके लिए खाता लिंक करने की ज़रूरत नहीं होती.
    1. शर्त सेक्शन में मौजूद Enter new expression फ़ील्ड में, यह लॉजिक डालें: user.verificationStatus != "VERIFIED"
    2. ट्रांज़िशन में जाकर, ऐसा सीन चुनें जिसके लिए खाते को लिंक करने की ज़रूरत न हो या ऐसा सीन चुनें जो सिर्फ़ मेहमान के तौर पर इस्तेमाल की जाने वाली सुविधा का एंट्री पॉइंट हो.

  1. शर्तें के लिए, जोड़ें आइकॉन पर क्लिक करें.
  2. अगर उपयोगकर्ता के पास कोई लिंक किया गया खाता नहीं है, तो खाता लिंक करने का फ़्लो ट्रिगर करने के लिए एक शर्त जोड़ें.
    1. शर्त में जाकर, Enter new expression फ़ील्ड में यह लॉजिक डालें:: user.verificationStatus == "VERIFIED"
    2. ट्रांज़िशन में जाकर, खाता लिंक करना सिस्टम सीन चुनें.
    3. सेव करें पर क्लिक करें.

सेव करने के बाद, आपके प्रोजेक्ट में खाता लिंक करने वाला एक नया सिस्टम सीन <SceneName>_AccountLinking जुड़ जाता है.

खाता जोड़ने के सीन को पसंद के मुताबिक बनाना

  1. सीन में जाकर, खाता लिंक करने की सुविधा वाले सिस्टम सीन को चुनें.
  2. प्रॉम्प्ट भेजें पर क्लिक करें. इसके बाद, उपयोगकर्ता को यह बताने के लिए एक छोटा वाक्य जोड़ें कि कार्रवाई को उसकी पहचान का ऐक्सेस क्यों चाहिए. उदाहरण के लिए, "आपकी प्राथमिकताओं को सेव करने के लिए".
  3. सेव करें पर क्लिक करें.

  1. शर्तें में जाकर, अगर उपयोगकर्ता ने खाता लिंक करने की प्रोसेस पूरी कर ली है पर क्लिक करें.
  2. अगर उपयोगकर्ता अपना खाता लिंक करने के लिए सहमत होता है, तो फ़्लो को आगे बढ़ाने का तरीका कॉन्फ़िगर करें. उदाहरण के लिए, कारोबार के लिए ज़रूरी कस्टम लॉजिक को प्रोसेस करने के लिए, वेबुक को कॉल करें. साथ ही, वापस ओरिजनल सीन पर जाएं.
  3. सेव करें पर क्लिक करें.

  1. शर्तें में जाकर, अगर उपयोगकर्ता खाता लिंक करने की प्रोसेस को रद्द करता है या खारिज करता है पर क्लिक करें.
  2. यह कॉन्फ़िगर करें कि अगर उपयोगकर्ता अपना खाता लिंक करने के लिए सहमत नहीं होता है, तो फ़्लो कैसे आगे बढ़ना चाहिए. उदाहरण के लिए, पुष्टि करने वाला मैसेज भेजें और उपयोगकर्ताओं को उन सीन पर रीडायरेक्ट करें जिनमें खाते को लिंक करने की ज़रूरत नहीं होती.
  3. सेव करें पर क्लिक करें.

  1. शर्तें में जाकर, सिस्टम या नेटवर्क में गड़बड़ी होने पर पर क्लिक करें.
  2. कॉन्फ़िगर करें कि सिस्टम या नेटवर्क की गड़बड़ियों की वजह से, खाता लिंक करने की प्रोसेस पूरी न होने पर, फ़्लो को कैसे आगे बढ़ना चाहिए. उदाहरण के लिए, पुष्टि करने वाला मैसेज भेजें और उपयोगकर्ताओं को उन सीन पर रीडायरेक्ट करें जिनमें खाते को लिंक करने की ज़रूरत नहीं होती.
  3. सेव करें पर क्लिक करें.

डेटा ऐक्सेस करने के अनुरोधों को मैनेज करना

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