গুগল কালো সম্প্রদায়ের জন্য জাতিগত সমতা উন্নয়নে প্রতিশ্রুতিবদ্ধ। দেখ কিভাবে.

ওয়েব সার্ভার অ্যাপ্লিকেশনগুলির জন্য OAuth 2.0 ব্যবহার করা

এই দস্তাবেজটি ব্যাখ্যা করে যে কীভাবে ওয়েব সার্ভার অ্যাপ্লিকেশনগুলি গুগল API গুলি অ্যাক্সেস করতে OAuth 2.0 অনুমোদন বাস্তবায়নের জন্য গুগল এপিআই ক্লায়েন্ট লাইব্রেরি বা গুগল ওআউথ ২.০ এন্ডপয়েন্টগুলি ব্যবহার করে।

OAuth 2.0 ব্যবহারকারীদের ব্যবহারকারীর নাম, পাসওয়ার্ড এবং অন্যান্য তথ্য ব্যক্তিগত রাখার সময় একটি অ্যাপ্লিকেশনের সাথে নির্দিষ্ট ডেটা ভাগ করার মঞ্জুরি দেয়। উদাহরণস্বরূপ, একটি অ্যাপ্লিকেশন তাদের গুগল ড্রাইভে ফাইল সংরক্ষণের জন্য ব্যবহারকারীদের অনুমতি পেতে OAuth 2.0 ব্যবহার করতে পারে।

এই OAuth 2.0 প্রবাহটি বিশেষত ব্যবহারকারীর অনুমোদনের জন্য। এটি এমন অ্যাপ্লিকেশনগুলির জন্য ডিজাইন করা হয়েছে যা গোপনীয় তথ্য সংরক্ষণ এবং রাষ্ট্র বজায় রাখতে পারে। সঠিকভাবে অনুমোদিত ওয়েব সার্ভার অ্যাপ্লিকেশন কোনও এপিআই অ্যাক্সেস করতে পারে যখন ব্যবহারকারী অ্যাপ্লিকেশনটির সাথে যোগাযোগ করে বা ব্যবহারকারী অ্যাপ্লিকেশনটি রেখে যাওয়ার পরে।

ওয়েব সার্ভার অ্যাপ্লিকেশনগুলি প্রায়শই এপিআই অনুরোধগুলি অনুমোদনের জন্য পরিষেবা অ্যাকাউন্টগুলি ব্যবহার করে, বিশেষত ক্লাউড এপিআইগুলিকে ব্যবহারকারী-নির্দিষ্ট ডেটার পরিবর্তে প্রকল্প ভিত্তিক ডেটা অ্যাক্সেস করার জন্য কল করার সময়। ওয়েব সার্ভার অ্যাপ্লিকেশনগুলি ব্যবহারকারীর অনুমোদনের সাথে একযোগে পরিষেবা অ্যাকাউন্টগুলি ব্যবহার করতে পারে।

ক্লায়েন্ট লাইব্রেরি

এই পৃষ্ঠার ভাষা-নির্দিষ্ট উদাহরণগুলি OAuth 2.0 অনুমোদন বাস্তবায়নের জন্য গুগল এপিআই ক্লায়েন্ট লাইব্রেরি ব্যবহার করে। কোড নমুনা চালানোর জন্য আপনাকে প্রথমে আপনার ভাষার জন্য ক্লায়েন্ট লাইব্রেরি ইনস্টল করতে হবে।

আপনি যখন আপনার অ্যাপ্লিকেশনটির OAuth 2.0 প্রবাহ হ্যান্ডেল করতে একটি গুগল এপিআই ক্লায়েন্ট লাইব্রেরি ব্যবহার করেন, ক্লায়েন্ট লাইব্রেরি অনেকগুলি ক্রিয়া করে যা অ্যাপ্লিকেশনটিকে অন্যথায় নিজেরাই হ্যান্ডেল করার প্রয়োজন হবে। উদাহরণস্বরূপ, এটি কখন নির্ধারণ করে যে অ্যাপ্লিকেশন কখন স্টোরেজ অ্যাক্সেস টোকেনগুলি ব্যবহার করতে বা রিফ্রেশ করতে পারে এবং সেই সাথে অ্যাপ্লিকেশনটি কখন সম্মতি পুনরায় প্রার্থনা করতে হবে। ক্লায়েন্ট লাইব্রেরি সঠিক পুনঃনির্দেশ URL গুলি উত্পন্ন করে এবং পুনর্নির্দেশ হ্যান্ডলারগুলি প্রয়োগ করতে সহায়তা করে যা অ্যাক্সেস টোকেনের জন্য অনুমোদনের কোডগুলি বিনিময় করে।

ক্লায়েন্ট লাইব্রেরি নিম্নলিখিত ভাষার জন্য উপলব্ধ:

পূর্বশর্ত

আপনার প্রকল্পের জন্য API গুলি সক্ষম করুন

গুগল এপিআইগুলিকে কল করে এমন কোনও অ্যাপ্লিকেশন API Console এ সেইগুলি সক্ষম করতে হবে।

আপনার প্রকল্পের জন্য একটি API সক্ষম করতে:

  1. Google API Console এ Open the API Library
  2. If prompted, select a project, or create a new one.
  3. API Library প্রোডাক্ট পরিবার এবং জনপ্রিয়তার দ্বারা গোষ্ঠীযুক্ত সমস্ত উপলব্ধ API গুলি তালিকাভুক্ত করে। আপনি যে APIটি সক্ষম করতে চান তা যদি তালিকায় দৃশ্যমান না হয় তবে এটি সন্ধানের জন্য অনুসন্ধানটি ব্যবহার করুন, বা এর সাথে সম্পর্কিত পণ্য পরিবারে সমস্ত দেখুন ক্লিক করুন।
  4. আপনি সক্ষম করতে চান এমন API নির্বাচন করুন, তারপরে সক্ষম বোতামটি ক্লিক করুন।
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

অনুমোদনের শংসাপত্র তৈরি করুন

গুগল এপিআইগুলিতে অ্যাক্সেস করতে OAuth 2.0 ব্যবহার করা যে কোনও অ্যাপ্লিকেশানের অবশ্যই অনুমোদনের শংসাপত্র থাকতে হবে যা গুগলের OAuth 2.0 সার্ভারে অ্যাপ্লিকেশনটি সনাক্ত করে। নিম্নলিখিত প্রকল্পে কীভাবে আপনার প্রকল্পের শংসাপত্র তৈরি করবেন তা ব্যাখ্যা করে। আপনার অ্যাপ্লিকেশনগুলি তারপরে সেই প্রকল্পের জন্য সক্ষম হওয়া এপিআইগুলিতে অ্যাক্সেসের শংসাপত্রগুলি ব্যবহার করতে পারেন।

  1. Go to the Credentials page.
  2. শংসাপত্র তৈরি করতে ক্লিক করুন> OAuth ক্লায়েন্ট আইডি
  3. ওয়েব অ্যাপ্লিকেশন অ্যাপ্লিকেশন প্রকার নির্বাচন করুন।
  4. ফর্মটি পূরণ করুন এবং তৈরি ক্লিক করুন । অ্যাপ্লিকেশনগুলি যা পিএইচপি, জাভা, পাইথন, রুবি এবং। নেট হিসাবে ভাষা এবং ফ্রেমওয়ার্ক ব্যবহার করে তাদের অনুমোদিত পুনর্নির্দেশের ইউআরআই নির্দিষ্ট করতে হবে। পুনঃনির্দেশিত ইউআরআই হ'ল শেষ পয়েন্টগুলি যেখানে OAuth 2.0 সার্ভার প্রতিক্রিয়াগুলি প্রেরণ করতে পারে। এই শেষবিন্দুগুলিকে অবশ্যই Google এর বৈধতা নিয়ম মেনে চলতে হবে।

    পরীক্ষার জন্য, আপনি ইউআরআই নির্দিষ্ট করতে পারেন যা স্থানীয় মেশিনে উল্লেখ করে যেমন http://localhost:8080 । এটি মনে রেখে, দয়া করে নোট করুন যে এই দস্তাবেজের সমস্ত উদাহরণ http://localhost:8080 পুনঃনির্দেশিত ইউআরআই হিসাবে ব্যবহার করে।

    আমরা আপনাকে সুপারিশ করি যে আপনি আপনার অ্যাপ্লিকেশনটির লেখার শেষ প্রান্তগুলি ডিজাইন করুন যাতে আপনার অ্যাপ্লিকেশনটি পৃষ্ঠার অন্যান্য সংস্থানগুলিতে অনুমোদনের কোডগুলি প্রকাশ না করে।

আপনার শংসাপত্রগুলি তৈরি করার পরে API Console থেকে client_secret.json ফাইলটি ডাউনলোড করুন। নিরাপদে ফাইলটি এমন স্থানে সংরক্ষণ করুন যা কেবলমাত্র আপনার অ্যাপ্লিকেশনটি অ্যাক্সেস করতে পারে।

অ্যাক্সেস স্কোপগুলি সনাক্ত করুন

স্কোপগুলি আপনার অ্যাপ্লিকেশনটিকে যে পরিমাণ অ্যাক্সেস মঞ্জুরি দেয় তা নিয়ন্ত্রণ করতে ব্যবহারকারীদের সক্ষম করার জন্য প্রয়োজনীয় সংস্থানগুলিতে কেবল অ্যাক্সেসের অনুরোধ করতে সক্ষম করে application সুতরাং, অনুরোধ করা স্কোপের সংখ্যা এবং ব্যবহারকারীর সম্মতি পাওয়ার সম্ভাবনার মধ্যে একটি বিপরীত সম্পর্ক থাকতে পারে।

আপনি OAuth 2.0 অনুমোদনের প্রয়োগ শুরু করার আগে, আমরা আপনাকে সুপারিশ করি যে আপনার স্কোপগুলিকে অ্যাক্সেস করার অনুমতি প্রয়োজন হবে তা চিহ্নিত করুন।

আমরা আপনার সুপারিশ করছি যে আপনার অ্যাপ্লিকেশনটি বর্ধিত অনুমোদনের প্রক্রিয়াটির মাধ্যমে অনুমোদনের স্কোপে অ্যাক্সেসের জন্য অনুরোধ করবে, যাতে আপনার অ্যাপ্লিকেশন প্রসঙ্গে ব্যবহারকারী ডেটাতে অ্যাক্সেসের অনুরোধ করে। এই সর্বোত্তম অনুশীলনটি ব্যবহারকারীদের আরও সহজেই বুঝতে সাহায্য করে যে আপনার অ্যাপ্লিকেশনটির কাছে অনুরোধ করা হচ্ছে এমন অ্যাক্সেসের প্রয়োজন কেন।

OAuth 2.0 এপিআই স্কোপস দস্তাবেজে স্কোপের পুরো তালিকা রয়েছে যা আপনি গুগল এপিআইগুলিতে অ্যাক্সেস করতে ব্যবহার করতে পারেন।

ভাষা-নির্দিষ্ট প্রয়োজনীয়তা

এই দস্তাবেজে যে কোনও কোড নমুনা চালানোর জন্য আপনার একটি Google অ্যাকাউন্ট, ইন্টারনেট অ্যাক্সেস এবং একটি ওয়েব ব্রাউজারের প্রয়োজন। আপনি যদি একটি এপিআই ক্লায়েন্ট লাইব্রেরি ব্যবহার করে থাকেন তবে নীচে ভাষা-নির্দিষ্ট প্রয়োজনীয়তাও দেখুন।

পিএইচপি

এই নথিতে পিএইচপি কোডের নমুনাগুলি চালাতে আপনার প্রয়োজন:

  • কমান্ড-লাইন ইন্টারফেস (সিএলআই) এবং জেএসএন এক্সটেনশান ইনস্টল করে পিএইচপি 5.4 বা ততোধিক।
  • সুরকার নির্ভরতা পরিচালন সরঞ্জাম।
  • পিএইচপি এর জন্য গুগল এপিআইএস ক্লায়েন্ট লাইব্রেরি:

    php composer.phar require google/apiclient:^2.0

পাইথন

এই নথিতে পাইথন কোড নমুনাগুলি চালাতে আপনার প্রয়োজন:

  • পাইথন ২.6 বা তার বেশি
  • পাইপ প্যাকেজ পরিচালনার সরঞ্জাম।
  • পাইথনের জন্য গুগল এপিআইএস ক্লায়েন্ট লাইব্রেরি:
    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

রুবি

এই নথিতে রুবি কোডের নমুনাগুলি চালাতে আপনার প্রয়োজন:

  • রুবি ২.২.২ বা তার চেয়ে বড়
  • রুবির জন্য গুগল এপিআইএস ক্লায়েন্ট লাইব্রেরি:

    gem install google-api-client
  • সিনেট্রা রুবি ওয়েব অ্যাপ্লিকেশন কাঠামো।

    gem install sinatra

HTTP / REST

OAuth 2.0 শেষ পয়েন্টগুলিতে সরাসরি কল করতে আপনাকে কোনও লাইব্রেরি ইনস্টল করার দরকার নেই।

OAuth 2.0 অ্যাক্সেস টোকেন প্রাপ্ত

নিম্নলিখিত পদক্ষেপগুলি দেখায় যে কীভাবে আপনার অ্যাপ্লিকেশনটি গুগলের OAuth 2.0 সার্ভারের সাথে ব্যবহারকারীর পক্ষে একটি API অনুরোধ সম্পাদনের জন্য কোনও ব্যবহারকারীর সম্মতি পেতে ইন্টারঅ্যাক্ট করে। গুগল এপিআই অনুরোধ কার্যকর করার আগে আপনার আবেদনের অবশ্যই সম্মতি থাকতে হবে যার জন্য ব্যবহারকারীর অনুমোদনের প্রয়োজন।

নীচের তালিকাটি দ্রুত এই পদক্ষেপগুলির সংক্ষিপ্তসার করে:

  1. আপনার অ্যাপ্লিকেশন এটির প্রয়োজনীয় অনুমতিগুলি সনাক্ত করে।
  2. আপনার অ্যাপ্লিকেশনটি অনুরোধকৃত অনুমতিগুলির তালিকার পাশাপাশি ব্যবহারকারীকে Google এ পুনঃনির্দেশ করে।
  3. আপনার অ্যাপ্লিকেশনে অনুমতিগুলি দেওয়া হবে কিনা তা ব্যবহারকারী সিদ্ধান্ত নেয়।
  4. আপনার অ্যাপ্লিকেশনটি ব্যবহারকারী কী সিদ্ধান্ত নিয়েছে তা সন্ধান করে।
  5. যদি ব্যবহারকারী অনুরোধকৃত অনুমতি মঞ্জুর করে, আপনার অ্যাপ্লিকেশনটি ব্যবহারকারীর পক্ষে এপিআই অনুরোধ করার জন্য প্রয়োজনীয় টোকেনগুলি পুনরুদ্ধার করে।

পদক্ষেপ 1: অনুমোদনের পরামিতিগুলি সেট করুন

আপনার প্রথম পদক্ষেপটি অনুমোদনের অনুরোধ তৈরি করা। এই অনুরোধটি এমন প্যারামিটার সেট করে যা আপনার অ্যাপ্লিকেশন সনাক্ত করে এবং ব্যবহারকারীদের আপনার অ্যাপ্লিকেশনটিকে মঞ্জুরি দিতে বলা হবে এমন অনুমতিগুলি নির্ধারণ করে।

  • যদি আপনি OAuth 2.0 প্রমাণীকরণ এবং অনুমোদনের জন্য কোনও গুগল ক্লায়েন্ট লাইব্রেরি ব্যবহার করেন তবে আপনি এই পরামিতিগুলি সংজ্ঞায়িত করে এমন একটি সামগ্রী তৈরি এবং কনফিগার করেন।
  • আপনি যদি গুগল ওআউথ ২.০ এন্ডপয়েন্টটি সরাসরি কল করেন তবে আপনি একটি URL তৈরি করবেন এবং সেই URL এ প্যারামিটার সেট করবেন।

নীচের ট্যাবগুলি ওয়েব সার্ভার অ্যাপ্লিকেশনগুলির জন্য সমর্থিত অনুমোদনের পরামিতিগুলি সংজ্ঞায়িত করে। ভাষা-নির্দিষ্ট উদাহরণগুলিও দেখায় যে কীভাবে কোনও ক্লায়েন্ট লাইব্রেরি বা অনুমোদনের লাইব্রেরি ব্যবহার করতে হবে এমন কোনও বিষয় যা কনফিগার করে সেই পরামিতিগুলি সেট করে।

পিএইচপি

নীচের কোড স্নিপেট একটি Google_Client() অবজেক্ট তৈরি করে, যা অনুমোদনের অনুরোধে পরামিতিগুলি সংজ্ঞায়িত করে।

এই বিষয়টি আপনার অ্যাপ্লিকেশন সনাক্ত করতে আপনার ক্লায়েন্ট_সেক্রেট.জসন ফাইলের তথ্য ব্যবহার করে। (সেই ফাইলটি সম্পর্কে আরও তথ্যের জন্য অনুমোদনের শংসাপত্র তৈরি করুন দেখুন)) বস্তুটি আপনার অ্যাপ্লিকেশনটিতে অ্যাক্সেসের অনুমতি এবং আপনার অ্যাপ্লিকেশনটির লেখার শেষ পয়েন্টের ইউআরএল, যা গুগলের ওআউথ ২.০ সার্ভারের প্রতিক্রিয়া পরিচালনা করবে তাও চিহ্নিত করে। অবশেষে, কোড সেট করে ঐচ্ছিক access_type এবং include_granted_scopes প্যারামিটার।

উদাহরণস্বরূপ, এই কোডটি কেবল পঠনযোগ্য, কোনও ব্যবহারকারীর গুগল ড্রাইভে অফলাইন অ্যাক্সেসের অনুরোধ করে:

$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 এই মানটি পেতে পারেন।

পিএইচপি-তে, ক্লায়েন্ট_সেক্রেট.জসন ফাইল থেকে অনুমোদনের শংসাপত্রগুলি লোড করতে setAuthConfig ফাংশনটি কল করুন।

$client = new Google_Client();
$client->setAuthConfig('client_secret.json');
redirect_uri প্রয়োজনীয়

ব্যবহারকারী অনুমোদনের প্রবাহটি সম্পূর্ণ করার পরে যেখানে API সার্ভার ব্যবহারকারীকে পুনঃনির্দেশ করে সেখানে নির্ধারণ করে। মানটি অবশ্যই অবশ্যই OAuth 2.0 ক্লায়েন্টের জন্য অনুমোদিত পুনর্নির্দেশের ইউআরআইয়ের একটির সাথে মিলবে, যা আপনি আপনার ক্লায়েন্টের API Console Credentials page এ কনফিগার করেছেন। এই মানটি যদি সরবরাহিত client_id জন্য অনুমোদিত রিডাইরেক্ট client_id মেলে না তবে আপনি একটি redirect_uri_mismatch ত্রুটি পাবেন।

মনে রাখবেন যে http বা https স্কিম, কেস এবং ট্রেলিং স্ল্যাশ (' / ') অবশ্যই মিলবে।

এই মানটি পিএইচপিতে সেট করতে, setRedirectUri ফাংশনটি কল করুন। নোট করুন যে প্রদত্ত client_id জন্য আপনাকে অবশ্যই একটি বৈধ পুনঃনির্দেশ URI নির্দিষ্ট করতে হবে।

$client->setRedirectUri('https://oauth2.example.com/code');
scope প্রয়োজনীয়

আপনার অ্যাপ্লিকেশনটি ব্যবহারকারীর পক্ষে অ্যাক্সেস করতে পারে এমন সংস্থানগুলি সনাক্ত করতে স্কোপের একটি স্থান-সীমিত তালিকা ited এই মানগুলি সম্মতি স্ক্রিনকে অবহিত করে যা গুগল ব্যবহারকারীর কাছে প্রদর্শন করে।

স্কোপগুলি আপনার অ্যাপ্লিকেশনটিকে যে পরিমাণ অ্যাক্সেস মঞ্জুরি দেয় তা নিয়ন্ত্রণ করতে ব্যবহারকারীদের সক্ষম করার জন্য প্রয়োজনীয় সংস্থানগুলিতে কেবল অ্যাক্সেসের অনুরোধ করতে সক্ষম করে application সুতরাং, অনুরোধ করা স্কোপের সংখ্যা এবং ব্যবহারকারীর সম্মতি পাওয়ার সম্ভাবনার মধ্যে একটি বিপরীত সম্পর্ক রয়েছে।

এই মানটি পিএইচপিতে সেট করতে, addScope কল করুন:

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

আমরা যখনই সম্ভব আপনার প্রসঙ্গে প্রবন্ধে অনুমোদনের স্কোপে অ্যাক্সেসের জন্য অনুরোধ করার অনুরোধ করি। বর্ধিত অনুমোদনের মাধ্যমে প্রসঙ্গে ব্যবহারকারী ডেটাতে অ্যাক্সেসের অনুরোধ করার মাধ্যমে আপনি ব্যবহারকারীদের আরও সহজেই বুঝতে সাহায্য করতে পারেন যে আপনার অ্যাপ্লিকেশনটির কাছে অনুরোধ করা হচ্ছে এমন অ্যাক্সেসের প্রয়োজন কেন।

access_type প্রস্তাবিত

যখন ব্যবহারকারী ব্রাউজারে উপস্থিত না থাকে আপনার অ্যাপ্লিকেশনটি অ্যাক্সেস টোকেনগুলি রিফ্রেশ করতে পারে কিনা তা নির্দেশ করে। বৈধ প্যারামিটার মানগুলি online , যা ডিফল্ট মান এবং offline

ব্যবহারকারী যখন ব্রাউজারে উপস্থিত না থাকে আপনার অ্যাপ্লিকেশনটিকে অ্যাক্সেস টোকেনগুলি রিফ্রেশ করতে হবে তবে offline মান সেট করুন। এই নথিতে পরে বর্ণিত অ্যাক্সেস টোকেনগুলি রিফ্রেশ করার পদ্ধতি। আপনার মানটি প্রথমবার টোকেনের জন্য কোনও অনুমোদনের কোডের বিনিময় করলে এই মানটি গুগল অনুমোদনের সার্ভারকে রিফ্রেশ টোকেন এবং একটি অ্যাক্সেস টোকেনকে নির্দেশ দেয়।

পিএইচপিতে এই মানটি সেট করতে, setAccessType কল করুন:

$client->setAccessType('offline');
state প্রস্তাবিত

আপনার অনুমোদনের অনুরোধ এবং অনুমোদনের সার্ভারের প্রতিক্রিয়ার মধ্যে স্থিতিশীলতা বজায় রাখতে আপনার অ্যাপ্লিকেশনটি ব্যবহার করে এমন কোনও স্ট্রিং মান নির্দিষ্ট করে। আপনার অ্যাপ্লিকেশনটির অ্যাক্সেসের অনুরোধটি অনুমোদিত বা অস্বীকার করার পরে সার্ভারটি আপনাকে redirect_uri এর ইউআরএল কোয়েরি উপাদান ( ? ) এর name=value জুটি হিসাবে প্রেরণ করে ঠিক সেই মানটি দেয়।

আপনি এই প্যারামিটারটি বেশ কয়েকটি উদ্দেশ্যে ব্যবহার করতে পারেন যেমন আপনার অ্যাপ্লিকেশনটিতে ব্যবহারকারীকে সঠিক উত্সের দিকে পরিচালিত করা, নোনেস প্রেরণ করা এবং ক্রস-সাইট অনুরোধ জালিয়াতি প্রশমিত করা। যেহেতু আপনার redirect_uri অনুমান করা যায়, একটি state মান ব্যবহার করা আপনার নিশ্চয়তা বাড়িয়ে দিতে পারে যে আগত সংযোগটি কোনও প্রমাণীকরণের অনুরোধের ফলাফল। যদি আপনি একটি এলোমেলো স্ট্রিং উত্পন্ন করে থাকেন বা কোনও কুকির হ্যাশ বা অন্য কোনও মান যা ক্লায়েন্টের রাজ্যকে ক্যাপচার করে তা এনকোড করেন, আপনি অনুরোধ এবং প্রতিক্রিয়া একই ব্রাউজারে উত্পন্ন হয়েছে তা নিশ্চিত করার জন্য, ক্রস-সাইটের মতো আক্রমণগুলির বিরুদ্ধে সুরক্ষা সরবরাহ করতে পারে জালিয়াতি অনুরোধ। কীভাবে state টোকেন তৈরি এবং নিশ্চিত করতে যায় তার উদাহরণের জন্য ওপেনআইডি কানেক্ট ডকুমেন্টেশন দেখুন।

এই মানটি পিএইচপিতে সেট করতে, setState কল করুন:

$client->setState($sample_passthrough_value);
include_granted_scopes .চ্ছিক

প্রসঙ্গে অতিরিক্ত স্কোপে অ্যাক্সেসের অনুরোধ করতে বর্ধিত অনুমোদন ব্যবহারের জন্য অ্যাপ্লিকেশনগুলিকে সক্ষম করে। আপনি যদি এই প্যারামিটারটির মানটিকে true সেট করে থাকেন এবং অনুমোদনের অনুরোধটি মঞ্জুরিপ্রাপ্ত হয়, তবে নতুন অ্যাক্সেস টোকন এমন কোনও স্কোপগুলিকেও কভার করবে যেখানে ব্যবহারকারী পূর্বে অ্যাপ্লিকেশন অ্যাক্সেস দিয়েছে। উদাহরণগুলির জন্য বর্ধিত অনুমোদনের বিভাগটি দেখুন।

এই মানটি পিএইচপিতে সেট করতে, setIncludeGrantedScopes কল করুন:

$client->setIncludeGrantedScopes(true);
login_hint .চ্ছিক

যদি আপনার অ্যাপ্লিকেশনটি জানে যে কোন ব্যবহারকারী প্রমাণীকরণের চেষ্টা করছেন, এটি Google প্যারামিটার সার্ভারকে কোনও ইঙ্গিত দেওয়ার জন্য এই পরামিতিটি ব্যবহার করতে পারে। সাইন-ইন ফর্মটিতে ইমেল ক্ষেত্রের প্রাকফিলিং করে অথবা উপযুক্ত মাল্টি-লগইন সেশনটি নির্বাচন করে লগইন প্রবাহকে সহজ করার জন্য সার্ভারটি ইঙ্গিতটি ব্যবহার করে।

কোনও ইমেল ঠিকানা বা sub সনাক্তকারীকে পরামিতি মান সেট করুন যা ব্যবহারকারীর গুগল আইডির সমতুল্য।

এই মানটি পিএইচপিতে সেট করতে, setLoginHint কল করুন:

$client->setLoginHint('None');
prompt .চ্ছিক

একটি স্থান-সীমিত, কেস-সংবেদনশীল তালিকা ব্যবহারকারীকে উপস্থাপিত করার অনুরোধ জানায়। আপনি যদি এই প্যারামিটারটি নির্দিষ্ট না করেন তবে আপনার প্রকল্পটি যখন প্রথম আপনার অ্যাক্সেসের জন্য অনুরোধ করবে তখনই আপনাকে ব্যবহারকারীকে অনুরোধ জানানো হবে। আরও তথ্যের জন্য প্রম্পটিং পুনরায় সম্মতি দেখুন।

এই মানটি পিএইচপিতে সেট করতে, সেট setApprovalPrompt কল করুন:

$client->setApprovalPrompt('consent');

সম্ভাব্য মানগুলি হ'ল:

none কোনও প্রমাণীকরণ বা সম্মতি স্ক্রিন প্রদর্শন করবেন না। অন্যান্য মান সহ নির্দিষ্ট করা উচিত নয়।
consent ব্যবহারকারীকে সম্মতি জানাতে অনুরোধ করুন।
select_account ব্যবহারকারীকে একটি অ্যাকাউন্ট নির্বাচন করতে অনুরোধ করুন।

পাইথন

নিম্নলিখিত কোড স্নিপেট অনুমোদনের অনুরোধটি তৈরি করতে google-auth-oauthlib.flow মডিউল ব্যবহার করে।

কোডটি একটি Flow অবজেক্ট তৈরি করে, যা প্রমাণীকরণের শংসাপত্রগুলি তৈরি করার পরে আপনার ডাউনলোড করা ক্লায়েন্ট_সেক্রেট.জসন ফাইলের তথ্য ব্যবহার করে আপনার অ্যাপ্লিকেশনটি সনাক্ত করে। সেই বস্তুটি এমন স্কুপগুলিও সনাক্ত করে যা আপনার অ্যাপ্লিকেশনটিতে অ্যাক্সেসের জন্য অনুমতি এবং আপনার অ্যাপ্লিকেশনটির লেখক শেষ প্রান্তে URL টি অনুরোধ করছে, যা গুগলের OAuth 2.0 সার্ভারের প্রতিক্রিয়া পরিচালনা করবে response অবশেষে, কোড সেট করে ঐচ্ছিক access_type এবং include_granted_scopes প্যারামিটার।

উদাহরণস্বরূপ, এই কোডটি কেবল পঠনযোগ্য, কোনও ব্যবহারকারীর গুগল ড্রাইভে অফলাইন অ্যাক্সেসের অনুরোধ করে:

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 এই মানটি পেতে পারেন।

পাইথন, কল from_client_secrets_file একটি client_secret.json ফাইল থেকে ক্লায়েন্ট ID পুনরুদ্ধার করতে পদ্ধতি। (আপনি 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 প্রয়োজনীয়

ব্যবহারকারী অনুমোদনের প্রবাহটি সম্পূর্ণ করার পরে যেখানে API সার্ভার ব্যবহারকারীকে পুনঃনির্দেশ করে সেখানে নির্ধারণ করে। মানটি অবশ্যই অবশ্যই OAuth 2.0 ক্লায়েন্টের জন্য অনুমোদিত পুনর্নির্দেশের ইউআরআইয়ের একটির সাথে মিলবে, যা আপনি আপনার ক্লায়েন্টের API Console Credentials page এ কনফিগার করেছেন। এই মানটি যদি সরবরাহিত client_id জন্য অনুমোদিত রিডাইরেক্ট client_id মেলে না তবে আপনি একটি redirect_uri_mismatch ত্রুটি পাবেন।

মনে রাখবেন যে http বা https স্কিম, কেস এবং ট্রেলিং স্ল্যাশ (' / ') অবশ্যই মিলবে।

পাইথনে এই মানটি সেট করতে, flow অবজেক্টের redirect_uri সম্পত্তি সেট করুন:

flow.redirect_uri = 'https://oauth2.example.com/code'
scope প্রয়োজনীয়

আপনার অ্যাপ্লিকেশন ব্যবহারকারীর পক্ষে অ্যাক্সেস করতে পারে এমন সংস্থানগুলিকে চিহ্নিত করার জন্য স্কোপের একটি তালিকা। এই মানগুলি সম্মতি স্ক্রিনকে অবহিত করে যা গুগল ব্যবহারকারীর কাছে প্রদর্শন করে।

স্কোপগুলি আপনার অ্যাপ্লিকেশনটিকে যে পরিমাণ অ্যাক্সেস মঞ্জুরি দেয় তা নিয়ন্ত্রণ করতে ব্যবহারকারীদের সক্ষম করার জন্য প্রয়োজনীয় সংস্থানগুলিতে কেবল অ্যাক্সেসের অনুরোধ করতে সক্ষম করে application সুতরাং, অনুরোধ করা স্কোপের সংখ্যা এবং ব্যবহারকারীর সম্মতি পাওয়ার সম্ভাবনার মধ্যে একটি বিপরীত সম্পর্ক রয়েছে।

পাইথনে, 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 মান সেট করুন। এই নথিতে পরে বর্ণিত অ্যাক্সেস টোকেনগুলি রিফ্রেশ করার পদ্ধতি। আপনার মানটি প্রথমবার টোকেনের জন্য কোনও অনুমোদনের কোডের বিনিময় করলে এই মানটি গুগল অনুমোদনের সার্ভারকে রিফ্রেশ টোকেন এবং একটি অ্যাক্সেস টোকেনকে নির্দেশ দেয়।

পাইথনে, access_type কল করার সময় flow.authorization_url কীওয়ার্ড আর্গুমেন্ট হিসাবে নির্দিষ্ট করে access_type access_type প্যারামিটার সেট করুন access_type flow.authorization_url পদ্ধতি:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    include_granted_scopes='true')
state প্রস্তাবিত

আপনার অনুমোদনের অনুরোধ এবং অনুমোদনের সার্ভারের প্রতিক্রিয়ার মধ্যে স্থিতিশীলতা বজায় রাখতে আপনার অ্যাপ্লিকেশনটি ব্যবহার করে এমন কোনও স্ট্রিং মান নির্দিষ্ট করে। আপনার অ্যাপ্লিকেশনটির অ্যাক্সেসের অনুরোধটি অনুমোদিত বা অস্বীকার করার পরে সার্ভারটি আপনাকে redirect_uri এর ইউআরএল কোয়েরি উপাদান ( ? ) এর name=value জুটি হিসাবে প্রেরণ করে ঠিক সেই মানটি দেয়।

আপনি এই প্যারামিটারটি বেশ কয়েকটি উদ্দেশ্যে ব্যবহার করতে পারেন যেমন আপনার অ্যাপ্লিকেশনটিতে ব্যবহারকারীকে সঠিক উত্সের দিকে পরিচালিত করা, নোকেস প্রেরণ করা এবং ক্রস-সাইট অনুরোধ জালিয়াতি প্রশমিত করা। যেহেতু আপনার redirect_uri অনুমান করা যায়, একটি state মান ব্যবহার করা আপনার নিশ্চয়তা বাড়িয়ে দিতে পারে যে আগত সংযোগটি কোনও প্রমাণীকরণের অনুরোধের ফলাফল। যদি আপনি একটি এলোমেলো স্ট্রিং উত্পন্ন করে থাকেন বা কোনও কুকির হ্যাশ বা অন্য কোনও মান যা ক্লায়েন্টের রাজ্যকে ক্যাপচার করে তা এনকোড করেন, আপনি অনুরোধ এবং প্রতিক্রিয়া একই ব্রাউজারে উত্পন্ন হয়েছে তা নিশ্চিত করার জন্য, ক্রস-সাইটের মতো আক্রমণগুলির বিরুদ্ধে সুরক্ষা সরবরাহ করতে পারে জালিয়াতি অনুরোধ। কীভাবে state টোকেন তৈরি এবং নিশ্চিত করতে যায় তার উদাহরণের জন্য ওপেনআইডি কানেক্ট ডকুমেন্টেশন দেখুন।

পাইথনে, flow.authorization_url কল করার সময় একটি কীওয়ার্ড আর্গুমেন্ট হিসাবে state উল্লেখ করে state পরামিতি সেট করুন flow.authorization_url পদ্ধতি:

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 সনাক্তকারীকে পরামিতি মান সেট করুন যা ব্যবহারকারীর গুগল আইডির সমতুল্য।

পাইথনে, login_hint কল করার সময় flow.authorization_url কীওয়ার্ড আর্গুমেন্ট হিসাবে নির্দিষ্ট করে login_hint প্যারামিটার সেট করুন login_hint flow.authorization_url পদ্ধতি:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    login_hint='None',
    include_granted_scopes='true')
prompt .চ্ছিক

একটি স্থান-সীমিত, কেস-সংবেদনশীল তালিকা ব্যবহারকারীকে উপস্থাপিত করার অনুরোধ জানায়। আপনি যদি এই প্যারামিটারটি নির্দিষ্ট না করেন তবে আপনার প্রকল্পটি যখন প্রথম আপনার অ্যাক্সেসের জন্য অনুরোধ করবে তখনই আপনাকে ব্যবহারকারীকে অনুরোধ করা হবে। আরও তথ্যের জন্য প্রম্পটিং পুনরায় সম্মতি দেখুন।

পাইথন ইন, সেট prompt নির্দিষ্ট করে প্যারামিটার prompt একটি শব্দ আর্গুমেন্ট হিসাবে যখন কলিং flow.authorization_url পদ্ধতি:

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

সম্ভাব্য মানগুলি হ'ল:

none কোনও প্রমাণীকরণ বা সম্মতি স্ক্রিন প্রদর্শন করবেন না। অন্যান্য মান সহ নির্দিষ্ট করা উচিত নয়।
consent ব্যবহারকারীকে সম্মতি জানাতে অনুরোধ করুন।
select_account ব্যবহারকারীকে একটি অ্যাকাউন্ট নির্বাচন করতে অনুরোধ করুন।

রুবি

আপনার অ্যাপ্লিকেশনটিতে ক্লায়েন্ট অবজেক্টটি কনফিগার করতে আপনি তৈরি করেছেন ক্লায়েন্ট_সেক্রেটস.জসন ফাইলটি ব্যবহার করুন। আপনি যখন কোনও ক্লায়েন্ট অবজেক্টটি কনফিগার করেন, আপনি আপনার অ্যাপ্লিকেশনটির লেখার শেষ পয়েন্টের URL সহ আপনার অ্যাপ্লিকেশনটির অ্যাক্সেসের প্রয়োজনীয় স্কোপগুলি নির্দিষ্ট করেন যা OAuth 2.0 সার্ভারের প্রতিক্রিয়াটি পরিচালনা করবে।

উদাহরণস্বরূপ, এই কোডটি কেবল পঠনযোগ্য, কোনও ব্যবহারকারীর গুগল ড্রাইভে অফলাইন অ্যাক্সেসের অনুরোধ করে:

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

গুগলের ওআউথ ২.০ শেষ পয়েন্টটি https://accounts.google.com/o/oauth2/v2/auth । এই শেষ পয়েন্টটি কেবল এইচটিটিপিএস-এর মাধ্যমে অ্যাক্সেসযোগ্য। সাধারণ HTTP সংযোগগুলি প্রত্যাখ্যান করা হয়েছে।

গুগল অনুমোদন সার্ভার ওয়েব সার্ভার অ্যাপ্লিকেশনগুলির জন্য নিম্নলিখিত ক্যোয়ারিং স্ট্রিং প্যারামিটারগুলিকে সমর্থন করে:

পরামিতি
client_id প্রয়োজনীয়

আপনার আবেদনের জন্য ক্লায়েন্ট আইডি। আপনি API Console Credentials page এই মানটি পেতে পারেন।

redirect_uri প্রয়োজনীয়

ব্যবহারকারী অনুমোদনের প্রবাহটি সম্পূর্ণ করার পরে যেখানে API সার্ভার ব্যবহারকারীকে পুনঃনির্দেশ করে সেখানে নির্ধারণ করে। মানটি অবশ্যই অবশ্যই OAuth 2.0 ক্লায়েন্টের জন্য অনুমোদিত পুনর্নির্দেশের ইউআরআইয়ের একটির সাথে মিলবে, যা আপনি আপনার ক্লায়েন্টের API Console Credentials page এ কনফিগার করেছেন। এই মানটি যদি সরবরাহিত client_id জন্য অনুমোদিত রিডাইরেক্ট client_id মেলে না তবে আপনি একটি redirect_uri_mismatch ত্রুটি পাবেন।

মনে রাখবেন যে http বা https স্কিম, কেস এবং ট্রেলিং স্ল্যাশ (' / ') অবশ্যই মিলবে।

response_type প্রয়োজনীয়

গুগল OAuth 2.0 শেষ পয়েন্ট কোনও অনুমোদনের কোড প্রদান করে কিনা তা নির্ধারণ করে।

ওয়েব সার্ভার অ্যাপ্লিকেশনগুলির জন্য code পরামিতি মান সেট করুন।

scope প্রয়োজনীয়

আপনার অ্যাপ্লিকেশনটি ব্যবহারকারীর পক্ষে অ্যাক্সেস করতে পারে এমন সংস্থানগুলি সনাক্ত করতে স্কোপের একটি স্থান-সীমিত তালিকা ited এই মানগুলি সম্মতি স্ক্রিনকে অবহিত করে যা গুগল ব্যবহারকারীর কাছে প্রদর্শন করে।

স্কোপগুলি আপনার অ্যাপ্লিকেশনটিকে যে পরিমাণ অ্যাক্সেস মঞ্জুরি দেয় তা নিয়ন্ত্রণ করতে ব্যবহারকারীদের সক্ষম করার জন্য প্রয়োজনীয় সংস্থানগুলিতে কেবল অ্যাক্সেসের অনুরোধ করতে সক্ষম করে application সুতরাং, অনুরোধ করা স্কোপের সংখ্যা এবং ব্যবহারকারীর সম্মতি পাওয়ার সম্ভাবনার মধ্যে একটি বিপরীত সম্পর্ক রয়েছে।

আমরা যখনই সম্ভব আপনার প্রসঙ্গে প্রবন্ধে অনুমোদনের স্কোপে অ্যাক্সেসের জন্য অনুরোধ করার অনুরোধ করি। বর্ধিত অনুমোদনের মাধ্যমে প্রসঙ্গে ব্যবহারকারী ডেটাতে অ্যাক্সেসের অনুরোধ করার মাধ্যমে আপনি ব্যবহারকারীদের আরও সহজেই বুঝতে সাহায্য করতে পারেন যে আপনার অ্যাপ্লিকেশনটির কাছে অনুরোধ করা হচ্ছে এমন অ্যাক্সেসের প্রয়োজন কেন।

access_type প্রস্তাবিত

যখন ব্যবহারকারী ব্রাউজারে উপস্থিত না থাকে আপনার অ্যাপ্লিকেশনটি অ্যাক্সেস টোকেনগুলি রিফ্রেশ করতে পারে কিনা তা নির্দেশ করে। বৈধ প্যারামিটার মানগুলি online , যা ডিফল্ট মান এবং offline

ব্যবহারকারী যখন ব্রাউজারে উপস্থিত না থাকে আপনার অ্যাপ্লিকেশনটিকে অ্যাক্সেস টোকেনগুলি রিফ্রেশ করতে হবে তবে offline মান সেট করুন। এই নথিতে পরে বর্ণিত অ্যাক্সেস টোকেনগুলি রিফ্রেশ করার পদ্ধতি। আপনার মানটি প্রথমবার টোকেনের জন্য কোনও অনুমোদনের কোডের বিনিময় করলে এই মানটি গুগল অনুমোদনের সার্ভারকে রিফ্রেশ টোকেন এবং একটি অ্যাক্সেস টোকেনকে নির্দেশ দেয়।

state প্রস্তাবিত

আপনার অনুমোদনের অনুরোধ এবং অনুমোদনের সার্ভারের প্রতিক্রিয়ার মধ্যে স্থিতিশীলতা বজায় রাখতে আপনার অ্যাপ্লিকেশনটি ব্যবহার করে এমন কোনও স্ট্রিং মান নির্দিষ্ট করে। আপনার অ্যাপ্লিকেশনটির অ্যাক্সেসের অনুরোধটি অনুমোদিত বা অস্বীকার করার পরে সার্ভারটি আপনাকে redirect_uri এর ইউআরএল কোয়েরি উপাদান ( ? ) এর name=value জুটি হিসাবে প্রেরণ করে ঠিক সেই মানটি দেয়।

আপনি এই প্যারামিটারটি বেশ কয়েকটি উদ্দেশ্যে ব্যবহার করতে পারেন যেমন আপনার অ্যাপ্লিকেশনটিতে ব্যবহারকারীকে সঠিক উত্সের দিকে পরিচালিত করা, নোকেস প্রেরণ করা এবং ক্রস-সাইট অনুরোধ জালিয়াতি প্রশমিত করা। যেহেতু আপনার redirect_uri অনুমান করা যায়, একটি state মান ব্যবহার করা আপনার নিশ্চয়তা বাড়িয়ে দিতে পারে যে আগত সংযোগটি কোনও প্রমাণীকরণের অনুরোধের ফলাফল। যদি আপনি কোনও এলোমেলো স্ট্রিং উত্পন্ন করে থাকেন বা কোনও কুকির হ্যাশ বা অন্য কোনও মান যা ক্লায়েন্টের রাজ্যকে ক্যাপচার করে তা এনকোড করেন, আপনি অনুরোধ এবং প্রতিক্রিয়া একই ব্রাউজারে উদ্ভূত হয়েছে তা নিশ্চিত করার জন্য, ক্রস-সাইটের মতো আক্রমণগুলির বিরুদ্ধে সুরক্ষা সরবরাহ করতে পারে জালিয়াতি অনুরোধ। কীভাবে state টোকেন তৈরি এবং নিশ্চিত করতে যায় তার উদাহরণের জন্য ওপেনআইডি কানেক্ট ডকুমেন্টেশন দেখুন।

include_granted_scopes .চ্ছিক

প্রসঙ্গে অতিরিক্ত স্কোপে অ্যাক্সেসের অনুরোধ করতে বর্ধিত অনুমোদন ব্যবহারের জন্য অ্যাপ্লিকেশনগুলিকে সক্ষম করে। আপনি যদি এই প্যারামিটারটির মানটিকে true সেট করে থাকেন এবং অনুমোদনের অনুরোধটি মঞ্জুরিপ্রাপ্ত হয়, তবে নতুন অ্যাক্সেস টোকন এমন কোনও স্কোপগুলিকেও কভার করবে যেখানে ব্যবহারকারী পূর্বে অ্যাপ্লিকেশন অ্যাক্সেস দিয়েছে। উদাহরণগুলির জন্য বর্ধিত অনুমোদনের বিভাগটি দেখুন।

login_hint .চ্ছিক

যদি আপনার অ্যাপ্লিকেশনটি জানেন যে কোন ব্যবহারকারী প্রমাণীকরণের চেষ্টা করছেন, এটি Google প্যারামিটার সার্ভারকে কোনও ইঙ্গিত দেওয়ার জন্য এই পরামিতিটি ব্যবহার করতে পারে। সাইন-ইন ফর্মটিতে ইমেল ক্ষেত্রের প্রাকফিলিং করে অথবা উপযুক্ত মাল্টি-লগইন সেশনটি নির্বাচন করে লগইন প্রবাহকে সহজ করার জন্য সার্ভারটি ইঙ্গিতটি ব্যবহার করে।

কোনও ইমেল ঠিকানা বা sub সনাক্তকারীকে পরামিতি মান সেট করুন যা ব্যবহারকারীর গুগল আইডির সমতুল্য।

prompt .চ্ছিক

একটি স্থান-সীমিত, কেস-সংবেদনশীল তালিকা ব্যবহারকারীকে উপস্থাপিত করার অনুরোধ জানায়। আপনি যদি এই প্যারামিটারটি নির্দিষ্ট না করেন তবে আপনার প্রকল্পটি যখন প্রথম আপনার অ্যাক্সেসের জন্য অনুরোধ করবে তখনই আপনাকে ব্যবহারকারীকে অনুরোধ জানানো হবে। আরও তথ্যের জন্য প্রম্পটিং পুনরায় সম্মতি দেখুন।

সম্ভাব্য মানগুলি হ'ল:

none কোনও প্রমাণীকরণ বা সম্মতি স্ক্রিন প্রদর্শন করবেন না। অন্যান্য মান সহ নির্দিষ্ট করা উচিত নয়।
consent ব্যবহারকারীকে সম্মতি জানাতে অনুরোধ করুন।
select_account ব্যবহারকারীকে একটি অ্যাকাউন্ট নির্বাচন করতে অনুরোধ করুন।

পদক্ষেপ 2: গুগলের OAuth 2.0 সার্ভারে পুনঃনির্দেশ করুন

প্রমাণীকরণ এবং অনুমোদনের প্রক্রিয়া শুরু করতে ব্যবহারকারীকে গুগলের OAuth 2.0 সার্ভারে পুনর্নির্দেশ করুন। সাধারণত, যখন আপনার অ্যাপ্লিকেশনটির ব্যবহারকারীর ডেটা অ্যাক্সেস করা প্রয়োজন তখন এটি ঘটে। বর্ধিত অনুমোদনের ক্ষেত্রে, এই পদক্ষেপটি তখনও ঘটে যখন আপনার অ্যাপ্লিকেশনটিকে প্রথমে অতিরিক্ত সংস্থানগুলি অ্যাক্সেস করতে হবে যা এটির অ্যাক্সেসের অনুমতি নেই।

পিএইচপি

  1. গুগলের 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. গুগলের OAuth 2.0 সার্ভার থেকে অ্যাক্সেসের জন্য একটি URL তৈরি করুন:
    auth_uri = auth_client.authorization_uri.to_s
    ef
  2. ব্যবহারকারীকে auth_uri পুনঃনির্দেশ করুন।

HTTP / REST

নমুনা গুগলের অনুমোদনের সার্ভারে পুনর্নির্দেশ

পঠনযোগ্যতার জন্য লাইন ব্রেক এবং স্পেস সহ একটি উদাহরণ 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 তৈরি করার পরে, ব্যবহারকারীকে এটিতে পুনর্নির্দেশ করুন।

গুগলের ওআউথ ২.০ সার্ভার ব্যবহারকারীকে অনুমোদন দেয় এবং অনুরোধকৃত স্কোপগুলি অ্যাক্সেস করার জন্য আপনার অ্যাপ্লিকেশনটির জন্য ব্যবহারকারীর কাছ থেকে সম্মতি গ্রহণ করে। আপনার নির্দিষ্ট করা পুনঃনির্দেশ URL ব্যবহার করে প্রতিক্রিয়াটি আপনার অ্যাপ্লিকেশনটিতে ফিরে পাঠানো হবে।

পদক্ষেপ 3: গুগল ব্যবহারকারীকে সম্মতি জানাতে অনুরোধ করে

এই পদক্ষেপে, ব্যবহারকারী আপনার অ্যাপ্লিকেশনটিকে অনুরোধ করা অ্যাক্সেস মঞ্জুর করবেন কিনা তা স্থির করে। এই পর্যায়ে, গুগল একটি সম্মতি উইন্ডো প্রদর্শন করে যা আপনার অ্যাপ্লিকেশনটির নাম এবং গুগল এপিআই পরিষেবাগুলি দেখায় যা এটি ব্যবহারকারীর অনুমোদনের শংসাপত্রগুলির সাথে অ্যাক্সেসের অনুমতিের জন্য অনুরোধ করছে এবং মঞ্জুর হওয়ার অ্যাক্সেসের স্কোপের একটি সারাংশ। তারপরে ব্যবহারকারী আপনার আবেদনের দ্বারা অনুরোধ করা এক বা একাধিক স্কোপে অ্যাক্সেস দিতে সম্মতি দিতে বা অনুরোধ প্রত্যাখ্যান করতে পারেন।

আপনার অ্যাপ্লিকেশনটির এই পর্যায়ে কিছু করার দরকার নেই কারণ এটি 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 টিতে ক্লিক করে এই প্রবাহটি পরীক্ষা করতে পারেন, যা আপনার গুগল ড্রাইভে ফাইলগুলির মেটাডেটা দেখতে কেবল পঠনযোগ্য অ্যাক্সেসের অনুরোধ করে:

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 API Console Credentials page দেওয়া আপনার প্রকল্পের জন্য তালিকাভুক্ত করা পুনর্নির্দেশ URI উল্লিখিত এক client_id

নিম্নলিখিত স্নিপেট একটি নমুনা অনুরোধ দেখায়:

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

গুগল এই অনুরোধটির প্রতিক্রিয়া জানায় এমন একটি JSON বস্তু যা একটি স্বল্প-কালীন অ্যাক্সেস টোকেন এবং একটি রিফ্রেশ টোকেন ধারণ করে returning মনে রাখবেন যে রিফ্রেশ টোকেন কেবল তখনই ফিরে আসে যখন আপনার অ্যাপ্লিকেশনটি access_type প্যারামিটারটিকে Google এর অনুমোদনের সার্ভারে প্রাথমিক অনুরোধে offline সেট করে।

প্রতিক্রিয়াটিতে নিম্নলিখিত ক্ষেত্রগুলি রয়েছে:

ক্ষেত্র
access_token আপনার অ্যাপ্লিকেশন কোনও গুগল এপিআই অনুরোধ অনুমোদনের জন্য প্রেরণ টোকেন।
expires_in সেকেন্ডের মধ্যে অ্যাক্সেস টোকেনের অবশিষ্ট জীবনকাল।
refresh_token একটি নতুন টোকেন যা আপনি নতুন অ্যাক্সেস টোকেন পেতে ব্যবহার করতে পারেন। রিফ্রেশ টোকেনগুলি ব্যবহারকারী অ্যাক্সেস প্রত্যাহার না করা অবধি বৈধ। আবার, এই ক্ষেত্রটি কেবলমাত্র প্রতিক্রিয়াতে উপস্থিত থাকে যদি আপনি গুগলের অনুমোদনের সার্ভারের প্রাথমিক অনুরোধে access_type প্যারামিটারটিকে offline সেট করেন।
scope অ্যাক্সেস_ 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

পিএইচপি

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();

পাইথন

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.

পিএইচপি

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));
}

পাইথন

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.

    পিএইচপি

    $client->setIncludeGrantedScopes(true);

    পাইথন

    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.

    পিএইচপি

    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.

    পাইথন

    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:

    ক্ষেত্র
    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.

    পিএইচপি

    To programmatically revoke a token, call revokeToken() :

    $client->revokeToken();

    পাইথন

    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.