Web Sunucusu Uygulamaları için OAuth 2.0'ı Kullanma

Bu belge, web sunucusu uygulamalarının Google API'lerine erişmek için OAuth 2.0 yetkilendirmesini uygulamak için Google API İstemci Kitaplıklarını veya Google OAuth 2.0 uç noktalarını nasıl kullandığını açıklar.

OAuth 2.0, kullanıcıların kullanıcı adlarını, şifrelerini ve diğer bilgileri gizli tutarken belirli verileri bir uygulamayla paylaşmasına olanak tanır. Örneğin, bir uygulama, kullanıcılardan Google Drive'larında dosya depolama izni almak için OAuth 2.0'ı kullanabilir.

Bu OAuth 2.0 akışı, özellikle kullanıcı yetkilendirmesi içindir. Gizli bilgileri depolayabilen ve durumu koruyabilen uygulamalar için tasarlanmıştır. Uygun şekilde yetkilendirilmiş bir web sunucusu uygulaması, kullanıcı uygulamayla etkileşime girerken veya kullanıcı uygulamadan ayrıldıktan sonra bir API'ye erişebilir.

Web sunucusu uygulamaları sıklıkla da kullanmak servis hesapları erişim proje bazlı verilere ziyade kullanıcıya özgü verilere Bulut API'leri çağırarak özellikle, API isteklerini yetkilendirmek. Web sunucusu uygulamaları, kullanıcı yetkilendirmesiyle birlikte hizmet hesaplarını kullanabilir.

İstemci kitaplıkları

Bu sayfayı kullanımına ilişkin dile özgü örnekleri Google API İstemci Kütüphaneleri OAuth 2.0 yetkilendirmesi uygulamaktır. Kod örneklerini çalıştırmak için önce dilinize uygun istemci kitaplığını yüklemelisiniz.

Uygulamanızın OAuth 2.0 akışını işlemek için bir Google API İstemci Kitaplığı kullandığınızda, istemci kitaplığı, uygulamanın aksi takdirde kendi başına gerçekleştirmesi gereken birçok eylemi gerçekleştirir. Örneğin, uygulamanın depolanan erişim belirteçlerini ne zaman kullanabileceğini veya yenileyebileceğini ve uygulamanın ne zaman yeniden onay alması gerektiğini belirler. İstemci kitaplığı ayrıca doğru yönlendirme URL'leri oluşturur ve erişim belirteçleri için yetkilendirme kodlarını değiş tokuş eden yeniden yönlendirme işleyicilerinin uygulanmasına yardımcı olur.

Aşağıdaki diller için istemci kitaplıkları mevcuttur:

Önkoşullar

Projeniz için API'leri etkinleştirin

Google API'leri çağıran herhangi bir uygulama bu API'leri etkinleştirmesi gerekir API Console.

Projeniz için bir API'yi etkinleştirmek için:

  1. Open the API Library içinde Google API Console.
  2. If prompted, select a project, or create a new one.
  3. API Library ürün ailesi ve popülerlik göre gruplandırılmış liste mevcut tüm API'leri. Etkinleştirmek istediğiniz API listesinde görünmüyorsa, kullanmak arama bulmak ya ait olduğu ürün ailesindeki Tümünü Görüntüle tıklayın.
  4. Etkinleştirmek istediğiniz API seçip Etkinleştir düğmesini tıklayın.
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

Yetkilendirme kimlik bilgileri oluşturun

Google API'lerine erişmek için OAuth 2.0 kullanan tüm uygulamalar, uygulamayı Google'ın OAuth 2.0 sunucusuna tanımlayan yetkilendirme kimlik bilgilerine sahip olmalıdır. Aşağıdaki adımlar, projeniz için kimlik bilgilerinin nasıl oluşturulacağını açıklar. Uygulamalarınız, o proje için etkinleştirdiğiniz API'lere erişmek için kimlik bilgilerini kullanabilir.

  1. Go to the Credentials page.
  2. > OAuth istemci kimliği kimlik bilgilerini oluşturma tıklayın.
  3. Web uygulaması uygulama tipini seçin.
  4. Formu doldurun ve Oluştur'u tıklayın. PHP, Java, Python, Ruby, ve .NET gibi kullanım dilleri ve çerçeveler yetkili yönlendirme URI'larını belirtmek gerekir Uygulamaları. Yönlendirme URI'leri, OAuth 2.0 sunucusunun yanıt gönderebileceği uç noktalardır. Bu bitiş noktaları uymalıdır Google'ın doğrulama kuralları .

    Test için, aşağıdakiler gibi yerel makineye atıfta URI'ları belirtebilirsiniz http://localhost:8080 . Akılda lütfen not ile bu belge kullanımında örneklerin tüm bu http://localhost:8080 yönlendirme URI olarak.

    Size tavsiye uygulamanızın yetkilendirme son noktalarını tasarım uygulamanız sayfadaki diğer kaynaklara yetkilendirme kodlarını açığa kalmaması.

Kimlik bilgilerinizi oluşturduktan sonra, gelen client_secret.json dosyasını indirmek API Console. Dosyayı yalnızca uygulamanızın erişebileceği bir konumda güvenli bir şekilde saklayın.

Erişim kapsamlarını tanımlayın

Kapsamlar, uygulamanızın yalnızca ihtiyaç duyduğu kaynaklara erişim talep etmesini sağlarken, kullanıcıların uygulamanıza verdikleri erişim miktarını kontrol etmelerine olanak tanır. Bu nedenle, talep edilen kapsam sayısı ile kullanıcı onayı alma olasılığı arasında ters bir ilişki olabilir.

OAuth 2.0 yetkilendirmesini uygulamaya başlamadan önce, uygulamanızın erişim iznine ihtiyaç duyacağı kapsamları belirlemenizi öneririz.

Ayrıca yetkilendirme için uygulama isteği erişimi yoluyla kapsamları tavsiye artan yetki uygulamanız bağlamında kullanıcı verilerine erişim talep ettiği süreç. Bu en iyi uygulama, kullanıcıların uygulamanızın neden talep ettiği erişime ihtiyacı olduğunu daha kolay anlamalarına yardımcı olur.

OAuth 2.0 API Kapsamı dokümanda, erişimi Google API'leri için kullanabileceği bu kapsamları tam listesini içerir.

Dile özgü gereksinimler

Bu belgedeki kod örneklerinden herhangi birini çalıştırmak için bir Google hesabına, İnternet erişimine ve bir web tarayıcısına ihtiyacınız olacak. API istemci kitaplıklarından birini kullanıyorsanız aşağıdaki dile özgü gereksinimlere de bakın.

PHP

Bu belgedeki PHP kod örneklerini çalıştırmak için şunlara ihtiyacınız olacak:

  • Komut satırı arabirimi (CLI) ve yüklü JSON uzantısıyla PHP 5.4 veya üstü.
  • Besteci bağımlılık yönetim aracı.
  • PHP için Google API'leri İstemci Kitaplığı:

    php composer.phar require google/apiclient:^2.0

piton

Bu belgedeki Python kod örneklerini çalıştırmak için şunlara ihtiyacınız olacak:

  • Python 2.6 veya üstü
  • Pip paket yönetim aracı.
  • Python için Google API Client Kütüphanesi:
    pip install --upgrade google-api-python-client
  • google-auth , google-auth-oauthlib ve google-auth-httplib2 kullanıcı yetkilendirme için.
    pip install --upgrade google-auth google-auth-oauthlib google-auth-httplib2
  • Flask Python web uygulaması çerçevesi.
    pip install --upgrade flask
  • requests HTTP kütüphanesi.
    pip install --upgrade requests

yakut

Bu belgedeki Ruby kod örneklerini çalıştırmak için şunlara ihtiyacınız olacak:

  • Ruby 2.2.2 veya üstü
  • Ruby için Google API'leri İstemci Kitaplığı:

    gem install google-api-client
  • Sinatra Ruby web uygulaması çerçevesi.

    gem install sinatra

HTTP/DİNLENME

OAuth 2.0 uç noktalarını doğrudan çağırabilmek için herhangi bir kitaplık yüklemeniz gerekmez.

OAuth 2.0 erişim belirteçlerini alma

Aşağıdaki adımlar, kullanıcı adına bir API isteği gerçekleştirmek için bir kullanıcının onayını almak için uygulamanızın Google'ın OAuth 2.0 sunucusuyla nasıl etkileşime girdiğini gösterir. Uygulamanızın, kullanıcı yetkilendirmesi gerektiren bir Google API isteği yürütebilmesi için bu izni almış olması gerekir.

Aşağıdaki liste bu adımları hızlı bir şekilde özetlemektedir:

  1. Uygulamanız ihtiyaç duyduğu izinleri tanımlar.
  2. Uygulamanız, kullanıcıyı istenen izinler listesiyle birlikte Google'a yönlendirir.
  3. Kullanıcı, uygulamanıza izin verilip verilmeyeceğine karar verir.
  4. Uygulamanız, kullanıcının neye karar verdiğini öğrenir.
  5. Kullanıcı istenen izinleri verdiyse, uygulamanız kullanıcı adına API istekleri yapmak için gereken belirteçleri alır.

Adım 1: Yetkilendirme parametrelerini ayarlayın

İlk adımınız yetkilendirme talebini oluşturmaktır. Bu istek, uygulamanızı tanımlayan parametreleri ayarlar ve kullanıcıdan uygulamanıza vermesi istenecek izinleri tanımlar.

  • OAuth 2.0 kimlik doğrulaması ve yetkilendirme için bir Google istemci kitaplığı kullanıyorsanız, bu parametreleri tanımlayan bir nesne oluşturur ve yapılandırırsınız.
  • Google OAuth 2.0 uç noktasını doğrudan ararsanız, bir URL oluşturur ve bu URL'deki parametreleri ayarlarsınız.

Aşağıdaki sekmeler, web sunucusu uygulamaları için desteklenen yetkilendirme parametrelerini tanımlar. Dile özgü örnekler, bu parametreleri ayarlayan bir nesneyi yapılandırmak için bir istemci kitaplığının veya yetki kitaplığının nasıl kullanılacağını da gösterir.

PHP

Kod parçacığı altında bir oluşturur Google_Client() yetkilendirme isteğinde parametreleri tanımlar nesneyi.

Senin client_secret.json dosyasından O nesne kullanımları bilgi başvurunuzun tanımlamak için. (Bkz yetkilendirme kimlik oluşturma o dosya hakkında daha fazla bilgi için.) Nesnesi ayrıca uygulama erişim izni ve Google'ın OAuth 2.0 sunucudan yanıtını idare edecek uygulamanın yetkilendirme bitiş noktasına URL'yi talep olduğunu kapsamları tanımlar. Son olarak, kod isteğe setleri access_type ve include_granted_scopes parametrelerini.

Örneğin, bu kod, bir kullanıcının Google Drive'ına salt okunur, çevrimdışı erişim ister:

$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

İstek aşağıdaki bilgileri belirtir:

parametreler
client_id Gerekli

Uygulamanız için istemci kimliği. Sen Bu değeri bulabilirsiniz API ConsoleCredentials page.

PHP'de, çağrı setAuthConfig bir client_secret.json dosyasından yetkilendirme kimlik bilgilerini yüklemek için işlevini.

$client = new Google_Client();
$client->setAuthConfig('client_secret.json');
redirect_uri Gerekli

Kullanıcı yetkilendirme akışını tamamladıktan sonra API sunucusunun kullanıcıyı nereye yönlendireceğini belirler. Değeri tam olarak müşterinizin yapılandırılan OAuth 2.0 müşteri için yetkili yönlendirme URI'lerinin birine uygun olmalıdır API ConsoleCredentials page. Bu değer sağlanan için yetkili yönlendirme URI uymuyorsa client_id bir alacak redirect_uri_mismatch hatası.

Not olduğunu http veya https düzeni, vaka ve Sondaki eğik çizgi ( ' / ') tüm maç gerekir.

PHP bu değeri ayarlamak için çağrı setRedirectUri fonksiyonunu. Verdiğiniz için geçerli bir yönlendirme URI belirtmeniz gerektiğini Not client_id .

$client->setRedirectUri('https://oauth2.example.com/code');
scope Gerekli

Uygulamanızın kullanıcı adına erişebileceği kaynakları tanımlayan, boşlukla sınırlı bir kapsam listesi. Bu değerler, Google'ın kullanıcıya gösterdiği izin ekranını bilgilendirir.

Kapsamlar, uygulamanızın yalnızca ihtiyaç duyduğu kaynaklara erişim talep etmesine ve aynı zamanda kullanıcıların uygulamanıza verdikleri erişim miktarını kontrol etmesine olanak tanır. Bu nedenle, talep edilen kapsam sayısı ile kullanıcı onayı alma olasılığı arasında ters bir ilişki vardır.

PHP bu değeri ayarlamak için çağrı addScope fonksiyonu:

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

Uygulamanızın, mümkün olduğunda bağlam içinde yetkilendirme kapsamlarına erişim talep etmesini öneririz. Aracılığıyla, bağlamda kullanıcı verilerine erişim talebinde bulunarak artan yetkilendirme , başvurunuzun o isteyen erişmesi gerektiği neden daha kolay kullanıcıların anlamamıza yardımcı olur.

access_type Tavsiye edilen

Kullanıcı tarayıcıda olmadığında uygulamanızın erişim belirteçlerini yenileyip yenileyemeyeceğini gösterir. Geçerli parametre değerleri şunlardır online varsayılan değeri ve hangi offline .

İçin değerini ayarlayın offline kullanıcı tarayıcısı mevcut değilken, uygulamanızın ihtiyaç erişim belirteçleri yenilemek için eğer. Bu, bu belgede daha sonra açıklanan erişim belirteçlerini yenileme yöntemidir. Bu değer belirteci yenileme ve ilk defa belirteci bir erişim döndürmek için Google yetkilendirme sunucusuna yönlendirir simgeleri için başvurunuzun borsaları bir yetkilendirme kodu olduğunu.

PHP bu değeri ayarlamak için çağrı setAccessType fonksiyonu:

$client->setAccessType('offline');
state Tavsiye edilen

Yetkilendirme isteğiniz ile yetkilendirme sunucusunun yanıtı arasındaki durumu korumak için uygulamanızın kullandığı herhangi bir dize değerini belirtir. Sunucu bir şekilde göndermek Söz konusu tam değerini verir name=value URL sorgu bileşeninde çiftinin ( ? ) Ait redirect_uri kullanıcı rızalar sonra veya uygulamanızın erişim isteğini reddeder.

Bu parametreyi, kullanıcıyı uygulamanızda doğru kaynağa yönlendirmek, nonces göndermek ve siteler arası istek sahteciliğini azaltmak gibi çeşitli amaçlar için kullanabilirsiniz. Senin bu yana redirect_uri tahmin edilebilir, bir kullanan state değerini gelen bağlantı kimlik doğrulama isteği sonucu olduğunu da güvence artırabilir. İstemcinin durumunu yakalayan rastgele bir dize oluşturur veya bir tanımlama bilgisinin karmasını veya başka bir değeri kodlarsanız, istek ve yanıtın aynı tarayıcıdan kaynaklandığından emin olmak için yanıtı doğrulayarak siteler arası saldırılara karşı koruma sağlayabilirsiniz. sahtecilik iste. Bkz OpenID Bağlan oluşturmak ve onaylamak için nasıl bir örnek belgelerine state belirteci.

PHP bu değeri ayarlamak için çağrı setState işlevini:

$client->setState($sample_passthrough_value);
include_granted_scopes İsteğe bağlı

Uygulamaların, bağlamda ek kapsamlara erişim istemek için artımlı yetkilendirmeyi kullanmasını sağlar. Eğer bu parametrenin değerini ayarlarsanız true ve yetkilendirme başvuru kabul edilirse, o zaman yeni bir erişim belirteci de kullanıcının daha önce uygulama erişim izni olan herhangi kapsamları kapsayacak. Bkz artan yetkilendirme örnekleri için bölüm.

PHP bu değeri ayarlamak için çağrı setIncludeGrantedScopes fonksiyonu:

$client->setIncludeGrantedScopes(true);
login_hint İsteğe bağlı

Uygulamanız hangi kullanıcının kimliğini doğrulamaya çalıştığını biliyorsa, Google Kimlik Doğrulama Sunucusuna bir ipucu sağlamak için bu parametreyi kullanabilir. Sunucu, oturum açma formundaki e-posta alanını önceden doldurarak veya uygun çoklu oturum açma oturumunu seçerek oturum açma akışını basitleştirmek için ipucunu kullanır.

Bir e-posta adresine veya parametre değerini ayarlayın sub kullanıcının Google kimliğiyle eş değer tanımlayıcı.

PHP bu değeri ayarlamak için çağrı setLoginHint fonksiyonu:

$client->setLoginHint('None');
prompt İsteğe bağlı

Kullanıcıya sunmak için boşlukla ayrılmış, büyük/küçük harfe duyarlı bir bilgi istemleri listesi. Bu parametreyi belirtmezseniz, kullanıcıya yalnızca projeniz ilk kez erişim istediğinde sorulur. Bkz yeniden rızasını Prompting fazla bilgi için.

PHP bu değeri ayarlamak için çağrı setApprovalPrompt fonksiyonu:

$client->setApprovalPrompt('consent');

Olası değerler şunlardır:

none Herhangi bir kimlik doğrulama veya izin ekranı görüntülemeyin. Diğer değerlerle belirtilmemelidir.
consent Kullanıcıdan onay isteyin.
select_account Kullanıcıdan bir hesap seçmesini isteyin.

piton

Aşağıdaki kod parçası kullanan google-auth-oauthlib.flow yetkilendirme talebi oluşturmak için modül.

Kod oluşturur Flow Peşinde indirilen bu client_secret.json dosyasından uygulama kullanarak bilgileri tanımlayan nesne, yetkilendirme kimlik oluşturma . Bu nesne ayrıca, uygulamanızın erişim izni istediği kapsamları ve Google'ın OAuth 2.0 sunucusundan gelen yanıtı işleyecek olan uygulamanızın yetkilendirme uç noktasının URL'sini tanımlar. Son olarak, kod isteğe setleri access_type ve include_granted_scopes parametrelerini.

Örneğin, bu kod, bir kullanıcının Google Drive'ına salt okunur, çevrimdışı erişim ister:

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')

İstek aşağıdaki bilgileri belirtir:

parametreler
client_id Gerekli

Uygulamanız için istemci kimliği. Sen Bu değeri bulabilirsiniz API ConsoleCredentials page.

Python'da, çağrı from_client_secrets_file bir client_secret.json dosyasından istemci kimliği almak için yöntem. (Ayrıca kullanabilirsiniz from_client_config başlangıçta bir istemci sırları dosyasında göründü ama dosyayı kendisi erişmez olarak istemci yapılandırmasını geçer yöntemi.)

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

Kullanıcı yetkilendirme akışını tamamladıktan sonra API sunucusunun kullanıcıyı nereye yönlendireceğini belirler. Değeri tam olarak müşterinizin yapılandırılan OAuth 2.0 müşteri için yetkili yönlendirme URI'lerinin birine uygun olmalıdır API ConsoleCredentials page. Bu değer sağlanan için yetkili yönlendirme URI uymuyorsa client_id bir alacak redirect_uri_mismatch hatası.

Not olduğunu http veya https düzeni, vaka ve Sondaki eğik çizgi ( ' / ') tüm maç gerekir.

Python bu değeri ayarlamak için set flow nesnenin redirect_uri özelliğini:

flow.redirect_uri = 'https://oauth2.example.com/code'
scope Gerekli

Uygulamanızın kullanıcı adına erişebileceği kaynakları tanımlayan kapsamların listesi. Bu değerler, Google'ın kullanıcıya gösterdiği izin ekranını bilgilendirir.

Kapsamlar, uygulamanızın yalnızca ihtiyaç duyduğu kaynaklara erişim talep etmesini sağlarken, kullanıcıların uygulamanıza verdikleri erişim miktarını kontrol etmelerine olanak tanır. Bu nedenle, talep edilen kapsam sayısı ile kullanıcı onayı alma olasılığı arasında ters bir ilişki vardır.

Python, ayarlamak için kullandığınız aynı yöntemi kullanmak client_id kapsamları listesini belirtmek için.

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

Uygulamanızın, mümkün olduğunda, bağlam içinde yetkilendirme kapsamlarına erişim talep etmesini öneririz. Aracılığıyla, bağlamda kullanıcı verilerine erişim talebinde bulunarak artan yetkilendirme , başvurunuzun o isteyen erişmesi gerektiği neden daha kolay kullanıcıların anlamamıza yardımcı olur.

access_type Tavsiye edilen

Kullanıcı tarayıcıda olmadığında uygulamanızın erişim belirteçlerini yenileyip yenileyemeyeceğini gösterir. Geçerli parametre değerleri şunlardır online varsayılan değeri ve hangi offline .

İçin değerini ayarlayın offline kullanıcı tarayıcısı mevcut değilken, uygulamanızın ihtiyaç erişim belirteçleri yenilemek için eğer. Bu, bu belgede daha sonra açıklanan erişim belirteçlerini yenileme yöntemidir. Bu değer belirteci yenileme ve ilk defa belirteci bir erişim döndürmek için Google yetkilendirme sunucusuna yönlendirir simgeleri için başvurunuzun borsaları bir yetkilendirme kodu olduğunu.

Python'da, set access_type belirterek parametreyi access_type çağrılırken bir anahtar kelime argüman olarak flow.authorization_url yöntemi:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    include_granted_scopes='true')
state Tavsiye edilen

Yetkilendirme isteğiniz ile yetkilendirme sunucusunun yanıtı arasındaki durumu korumak için uygulamanızın kullandığı herhangi bir dize değerini belirtir. Sunucu bir şekilde göndermek Söz konusu tam değerini verir name=value URL sorgu bileşeninde çiftinin ( ? ) Ait redirect_uri kullanıcı rızalar sonra veya uygulamanızın erişim isteğini reddeder.

Bu parametreyi, kullanıcıyı uygulamanızda doğru kaynağa yönlendirmek, nonces göndermek ve siteler arası istek sahteciliğini azaltmak gibi çeşitli amaçlar için kullanabilirsiniz. Senin bu yana redirect_uri tahmin edilebilir, bir kullanan state değerini gelen bağlantı kimlik doğrulama isteği sonucu olduğunu da güvence artırabilir. İstemcinin durumunu yakalayan rastgele bir dize oluşturur veya bir tanımlama bilgisinin karmasını veya başka bir değeri kodlarsanız, istek ve yanıtın aynı tarayıcıdan kaynaklandığından emin olmak için yanıtı doğrulayarak siteler arası saldırılara karşı koruma sağlayabilirsiniz. sahtecilik iste. Bkz OpenID Bağlan oluşturmak ve onaylamak için nasıl bir örnek belgelerine state belirteci.

Python'da, set state belirterek parametre state çağrılırken bir anahtar kelime argüman olarak flow.authorization_url yöntemi:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    state=sample_passthrough_value,
    include_granted_scopes='true')
include_granted_scopes İsteğe bağlı

Uygulamaların, bağlamda ek kapsamlara erişim istemek için artımlı yetkilendirmeyi kullanmasını sağlar. Eğer bu parametrenin değerini ayarlarsanız true ve yetkilendirme başvuru kabul edilirse, o zaman yeni bir erişim belirteci de kullanıcının daha önce uygulama erişim izni olan herhangi kapsamları kapsayacak. Bkz artan yetkilendirme örnekleri için bölüm.

Python'da, set include_granted_scopes parametre belirterek include_granted_scopes çağrılırken bir anahtar kelime argüman olarak flow.authorization_url yöntemi:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    include_granted_scopes='true')
login_hint İsteğe bağlı

Uygulamanız hangi kullanıcının kimliğini doğrulamaya çalıştığını biliyorsa, Google Kimlik Doğrulama Sunucusuna bir ipucu sağlamak için bu parametreyi kullanabilir. Sunucu, oturum açma formundaki e-posta alanını önceden doldurarak veya uygun çoklu oturum açma oturumunu seçerek oturum açma akışını basitleştirmek için ipucunu kullanır.

Bir e-posta adresine veya parametre değerini ayarlayın sub kullanıcının Google kimliğiyle eş değer tanımlayıcı.

Python'da, set login_hint belirterek parametreyi login_hint çağrılırken bir anahtar kelime argüman olarak flow.authorization_url yöntemi:

authorization_url, state = flow.authorization_url(
    access_type='offline',
    login_hint='None',
    include_granted_scopes='true')
prompt İsteğe bağlı

Kullanıcıya sunmak için boşlukla ayrılmış, büyük/küçük harfe duyarlı bir bilgi istemleri listesi. Bu parametreyi belirtmezseniz, kullanıcıya yalnızca projeniz ilk kez erişim istediğinde sorulur. Bkz yeniden rızasını Prompting fazla bilgi için.

Python'da, set prompt belirterek parametre prompt çağrılırken bir anahtar kelime argüman olarak flow.authorization_url yöntemi:

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

Olası değerler şunlardır:

none Herhangi bir kimlik doğrulama veya izin ekranı görüntülemeyin. Diğer değerlerle belirtilmemelidir.
consent Kullanıcıdan onay isteyin.
select_account Kullanıcıdan bir hesap seçmesini isteyin.

yakut

Uygulamanızda bir istemci nesnesini yapılandırmak için oluşturduğunuz client_secrets.json dosyasını kullanın. Bir istemci nesnesi yapılandırdığınızda, uygulamanızın OAuth 2.0 sunucusundan gelen yanıtı işleyecek olan auth bitiş noktasının URL'si ile birlikte uygulamanızın erişmesi gereken kapsamları belirtirsiniz.

Örneğin, bu kod, bir kullanıcının Google Drive'ına salt okunur, çevrimdışı erişim ister:

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

Uygulamanız, yetkilendirme isteği URL'leri oluşturma ve HTTP isteklerine erişim belirteçleri uygulama gibi OAuth 2.0 işlemlerini gerçekleştirmek için istemci nesnesini kullanır.

HTTP/DİNLENME

Google'ın OAuth 2.0 bitiş noktası olan https://accounts.google.com/o/oauth2/v2/auth . Bu uç noktaya yalnızca HTTPS üzerinden erişilebilir. Düz HTTP bağlantıları reddedilir.

Google yetkilendirme sunucusu, web sunucusu uygulamaları için aşağıdaki sorgu dizesi parametrelerini destekler:

parametreler
client_id Gerekli

Uygulamanız için istemci kimliği. Sen Bu değeri bulabilirsiniz API ConsoleCredentials page.

redirect_uri Gerekli

Kullanıcı yetkilendirme akışını tamamladıktan sonra API sunucusunun kullanıcıyı nereye yönlendireceğini belirler. Değeri tam olarak müşterinizin yapılandırılan OAuth 2.0 müşteri için yetkili yönlendirme URI'lerinin birine uygun olmalıdır API ConsoleCredentials page. Bu değer sağlanan için yetkili yönlendirme URI uymuyorsa client_id bir alacak redirect_uri_mismatch hatası.

Not olduğunu http veya https düzeni, vaka ve Sondaki eğik çizgi ( ' / ') tüm maç gerekir.

response_type Gerekli

Google OAuth 2.0 uç noktasının bir yetkilendirme kodu döndürüp döndürmediğini belirler.

Parametre değerini ayarlayın code web sunucusu uygulamaları için.

scope Gerekli

Uygulamanızın kullanıcı adına erişebileceği kaynakları tanımlayan, boşlukla sınırlı bir kapsam listesi. Bu değerler, Google'ın kullanıcıya gösterdiği izin ekranını bilgilendirir.

Kapsamlar, uygulamanızın yalnızca ihtiyaç duyduğu kaynaklara erişim talep etmesini sağlarken, kullanıcıların uygulamanıza verdikleri erişim miktarını kontrol etmelerine olanak tanır. Bu nedenle, talep edilen kapsam sayısı ile kullanıcı onayı alma olasılığı arasında ters bir ilişki vardır.

Uygulamanızın, mümkün olduğunda bağlam içinde yetkilendirme kapsamlarına erişim talep etmesini öneririz. Aracılığıyla, bağlamda kullanıcı verilerine erişim talebinde bulunarak artan yetkilendirme , başvurunuzun o isteyen erişmesi gerektiği neden daha kolay kullanıcıların anlamamıza yardımcı olur.

access_type Tavsiye edilen

Kullanıcı tarayıcıda olmadığında uygulamanızın erişim belirteçlerini yenileyip yenileyemeyeceğini gösterir. Geçerli parametre değerleri şunlardır online varsayılan değeri ve hangi offline .

İçin değerini ayarlayın offline kullanıcı tarayıcısı mevcut değilken, uygulamanızın ihtiyaç erişim belirteçleri yenilemek için eğer. Bu, bu belgede daha sonra açıklanan erişim belirteçlerini yenileme yöntemidir. Bu değer belirteci yenileme ve ilk defa belirteci bir erişim döndürmek için Google yetkilendirme sunucusuna yönlendirir simgeleri için başvurunuzun borsaları bir yetkilendirme kodu olduğunu.

state Tavsiye edilen

Yetkilendirme isteğiniz ile yetkilendirme sunucusunun yanıtı arasındaki durumu korumak için uygulamanızın kullandığı herhangi bir dize değerini belirtir. Sunucu bir şekilde göndermek Söz konusu tam değerini verir name=value URL sorgu bileşeninde çiftinin ( ? ) Ait redirect_uri kullanıcı rızalar sonra veya uygulamanızın erişim isteğini reddeder.

Bu parametreyi, kullanıcıyı uygulamanızda doğru kaynağa yönlendirmek, nonces göndermek ve siteler arası istek sahteciliğini azaltmak gibi çeşitli amaçlar için kullanabilirsiniz. Senin bu yana redirect_uri tahmin edilebilir, bir kullanan state değerini gelen bağlantı kimlik doğrulama isteği sonucu olduğunu da güvence artırabilir. İstemcinin durumunu yakalayan rastgele bir dize oluşturur veya bir tanımlama bilgisinin karmasını veya başka bir değeri kodlarsanız, istek ve yanıtın aynı tarayıcıdan kaynaklandığından emin olmak için yanıtı doğrulayarak siteler arası saldırılara karşı koruma sağlayabilirsiniz. sahtecilik iste. Bkz OpenID Bağlan oluşturmak ve onaylamak için nasıl bir örnek belgelerine state belirteci.

include_granted_scopes İsteğe bağlı

Uygulamaların, bağlamda ek kapsamlara erişim istemek için artımlı yetkilendirmeyi kullanmasını sağlar. Eğer bu parametrenin değerini ayarlarsanız true ve yetkilendirme başvuru kabul edilirse, o zaman yeni bir erişim belirteci de kullanıcının daha önce uygulama erişim izni olan herhangi kapsamları kapsayacak. Bkz artan yetkilendirme örnekleri için bölüm.

login_hint İsteğe bağlı

Uygulamanız hangi kullanıcının kimliğini doğrulamaya çalıştığını biliyorsa, Google Kimlik Doğrulama Sunucusuna bir ipucu sağlamak için bu parametreyi kullanabilir. Sunucu, oturum açma formundaki e-posta alanını önceden doldurarak veya uygun çoklu oturum açma oturumunu seçerek oturum açma akışını basitleştirmek için ipucunu kullanır.

Bir e-posta adresine veya parametre değerini ayarlayın sub kullanıcının Google kimliğiyle eş değer tanımlayıcı.

prompt İsteğe bağlı

Kullanıcıya sunmak için boşlukla ayrılmış, büyük/küçük harfe duyarlı bir bilgi istemleri listesi. Bu parametreyi belirtmezseniz, kullanıcıya yalnızca projeniz ilk kez erişim istediğinde sorulur. Bkz yeniden rızasını Prompting fazla bilgi için.

Olası değerler şunlardır:

none Herhangi bir kimlik doğrulama veya izin ekranı görüntülemeyin. Diğer değerlerle belirtilmemelidir.
consent Kullanıcıdan onay isteyin.
select_account Kullanıcıdan bir hesap seçmesini isteyin.

2. Adım: Google'ın OAuth 2.0 sunucusuna yönlendirin

Kimlik doğrulama ve yetkilendirme sürecini başlatmak için kullanıcıyı Google'ın OAuth 2.0 sunucusuna yönlendirin. Genellikle bu, uygulamanızın kullanıcı verilerine ilk kez erişmesi gerektiğinde ortaya çıkar. Durumunda artan yetkilendirme Başvurunuz ilk henüz erişim izni yok erişimin ek kaynaklara ihtiyaç duyduğunda, bu adım da ortaya çıkar.

PHP

  1. : Google'ın OAuth 2.0 sunucu gelen istek erişim için URL oluşturun
    $auth_url = $client->createAuthUrl();
  2. Yeniden yönlendirin $auth_url :
    header('Location: ' . filter_var($auth_url, FILTER_SANITIZE_URL));

piton

Bu örnek, Flask web uygulaması çerçevesini kullanarak kullanıcının yetkilendirme URL'sine nasıl yönlendirileceğini gösterir:

return flask.redirect(authorization_url)

yakut

  1. : Google'ın OAuth 2.0 sunucu gelen istek erişim için URL oluşturun
    auth_uri = auth_client.authorization_uri.to_s
  2. Kullanıcı yönlendir auth_uri .

HTTP/DİNLENME

Google'ın yetkilendirme sunucusuna yönlendirme örneği

Aşağıda, okunabilirlik için satır sonları ve boşluklarla birlikte örnek bir URL gösterilmektedir.

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

İstek URL'sini oluşturduktan sonra kullanıcıyı ona yönlendirin.

Google'ın OAuth 2.0 sunucusu, kullanıcının kimliğini doğrular ve uygulamanızın istenen kapsamlara erişmesi için kullanıcıdan izin alır. Yanıt, belirttiğiniz yönlendirme URL'si kullanılarak uygulamanıza geri gönderilir.

3. Adım: Google, kullanıcıdan izin ister

Bu adımda kullanıcı, uygulamanıza istenen erişimi verip vermemeye karar verir. Bu aşamada Google, uygulamanızın adını ve kullanıcının yetkilendirme bilgileriyle erişim izni istediği Google API hizmetlerini ve verilecek erişim kapsamlarının bir özetini gösteren bir izin penceresi görüntüler. Kullanıcı daha sonra uygulamanız tarafından talep edilen bir veya daha fazla kapsama erişim izni verebilir veya talebi reddedebilir.

Google'ın OAuth 2.0 sunucusundan herhangi bir erişim verilip verilmediğini belirten yanıtı beklediğinden, uygulamanızın bu aşamada herhangi bir şey yapmasına gerek yoktur. Bu yanıt aşağıdaki adımda açıklanmıştır.

Hatalar

Google'ın OAuth 2.0 yetkilendirme uç noktasına yönelik istekler, beklenen kimlik doğrulama ve yetkilendirme akışları yerine kullanıcıya yönelik hata mesajları görüntüleyebilir. Yaygın hata kodları ve önerilen çözümler aşağıda listelenmiştir.

admin_policy_enforced

Google Hesabı, Google Workspace yöneticilerinin politikaları nedeniyle istenen bir veya daha fazla kapsamı yetkilendiremiyor. Google Çalışma Alanı Yönetici yardım makalesine bakın üçüncü taraf & iç uygulamalar Google Çalışma Alanı verilere erişmek Kontrol erişim açıkça OAuth istemci kimliği verilir kadar bir yönetici tüm kapsamları veya hassas ve sınırlı kapsamları erişimi kısıtlayabilir hakkında daha fazla bilgi için.

disallowed_useragent

Yetki bitiş noktası Google'ın tarafından izin verilmedi gömülü kullanıcı aracısı içinde görüntülenir OAuth 2.0 Politikalar .

Android

Yetkilendirme isteklerini açarken Android geliştiricileri bu hata mesajını karşılaşabilir android.webkit.WebView . Geliştiriciler yerine gibi Android kütüphaneleri kullanmalıdır Android için Google Oturum Açma veya OpenID Vakfı Android için AppAuth .

Web geliştiricileri, bir Android uygulaması yerleşik bir kullanıcı aracısında genel bir web bağlantısı açtığında ve bir kullanıcı sitenizden Google'ın OAuth 2.0 yetkilendirme uç noktasına gittiğinde bu hatayla karşılaşabilir. Geliştiriciler genel bağlantılar içerir işletim sistemi, varsayılan bağlantı işleyicisi açılmasına izin vermelidir Android Uygulama Linkler işleyicileri veya varsayılan tarayıcı uygulamasını. Android Custom Sekmeler kütüphanesi de desteklenen bir seçenektir.

iOS

yetkilendirme isteklerini açarken iOS ve MacOS geliştiriciler bu hatayla karşılaşabilirsiniz WKWebView . Geliştiriciler yerine gibi iOS kütüphaneleri kullanmalıdır iOS için Google Oturum Açma veya OpenID Vakfı iOS için AppAuth .

Web geliştiricileri, bir iOS veya macOS uygulaması yerleşik bir kullanıcı aracısında genel bir web bağlantısı açtığında ve bir kullanıcı sitenizden Google'ın OAuth 2.0 yetkilendirme uç noktasına gittiğinde bu hatayla karşılaşabilir. Geliştiriciler genel bağlantılar içerir işletim sistemi, varsayılan bağlantı işleyicisi açılmasına izin vermelidir Evrensel Linkler işleyicileri veya varsayılan tarayıcı uygulamasını. SFSafariViewController kütüphanesi de desteklenen bir seçenektir.

org_internal

İstekte OAuth istemci kimliği spesifik bir Google Hesabına erişimini sınırlayan bir projenin parçasıdır Google Bulut Teşkilatı . Bu yapılandırma seçeneği hakkında daha fazla bilgi için bkz: Kullanıcı tipi OAuth rıza ekran yardımı makalesinde kadar Setting bölümüne.

redirect_uri_mismatch

redirect_uri yetkilendirme isteği geçirilen OAuth istemci kimliği için yetkili yönlendirme URI eşleşmiyor. İnceleme içinde yönlendirme URI'ları yetkili Google API Console Credentials page.

4. Adım: OAuth 2.0 sunucu yanıtını işleyin

OAuth 2.0 sunucusu, istekte belirtilen URL'yi kullanarak uygulamanızın erişim isteğine yanıt verir.

Kullanıcı erişim talebini onaylarsa, yanıt bir yetkilendirme kodu içerir. Kullanıcı isteği onaylamazsa yanıt bir hata mesajı içerir. Web sunucusuna döndürülen yetkilendirme kodu veya hata mesajı, aşağıda gösterildiği gibi sorgu dizesinde görünür:

Bir hata yanıtı:

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

Yetkilendirme kodu yanıtı:

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

Örnek OAuth 2.0 sunucu yanıtı

Google Drive'ınızdaki dosyalar için meta verileri görüntülemek için salt okunur erişim isteyen aşağıdaki örnek URL'yi tıklayarak bu akışı test edebilirsiniz:

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

After completing the OAuth 2.0 flow, you should be redirected to http://localhost/oauth2callback , which will likely yield a 404 NOT FOUND error unless your local machine serves a file at that address. The next step provides more detail about the information returned in the URI when the user is redirected back to your application.

Step 5: Exchange authorization code for refresh and access tokens

After the web server receives the authorization code, it can exchange the authorization code for an access token.

PHP

To exchange an authorization code for an access token, use the authenticate method:

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

You can retrieve the access token with the getAccessToken method:

$access_token = $client->getAccessToken();

Python

On your callback page, use the google-auth library to verify the authorization server response. Then, use the flow.fetch_token method to exchange the authorization code in that response for an access 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}

Ruby

To exchange an authorization code for an access token, use the fetch_access_token! method:

auth_client.code = auth_code
auth_client.fetch_access_token!

HTTP/REST

To exchange an authorization code for an access token, call the https://oauth2.googleapis.com/token endpoint and set the following parameters:

Fields
client_id The client ID obtained from the API ConsoleCredentials page.
client_secret The client secret obtained from the API ConsoleCredentials page.
code The authorization code returned from the initial request.
grant_type As defined in the OAuth 2.0 specification , this field's value must be set to authorization_code .
redirect_uri One of the redirect URIs listed for your project in the API ConsoleCredentials page for the given client_id .

The following snippet shows a sample request:

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

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

Google responds to this request by returning a JSON object that contains a short-lived access token and a refresh token. Note that the refresh token is only returned if your application set the access_type parameter to offline in the initial request to Google's authorization server .

The response contains the following fields:

Fields
access_token The token that your application sends to authorize a Google API request.
expires_in The remaining lifetime of the access token in seconds.
refresh_token A token that you can use to obtain a new access token. Refresh tokens are valid until the user revokes access. Again, this field is only present in this response if you set the access_type parameter to offline in the initial request to Google's authorization server.
scope The scopes of access granted by the access_token expressed as a list of space-delimited, case-sensitive strings.
token_type The type of token returned. At this time, this field's value is always set to Bearer .

The following snippet shows a sample response:

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

Calling Google APIs

PHP

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

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

Python

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

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

Ruby

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

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

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

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

HTTP/REST

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

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

HTTP GET examples

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

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

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

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

curl examples

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

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

Or, alternatively, the query string parameter option:

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

Complete example

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

PHP

To run this example:

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

index.php

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

session_start();

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

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

oauth2callback.php

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

session_start();

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

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

Python

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

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

import os
import flask
import requests

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

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

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

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


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


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

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

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

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

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

  return flask.jsonify(**files)


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

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

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

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

  return flask.redirect(authorization_url)


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

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

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

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

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


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

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

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

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


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


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

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


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

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

Ruby

This example uses the Sinatra framework.

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

enable :sessions
set :session_secret, 'setme'

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

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

HTTP/REST

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

import json

import flask
import requests


app = flask.Flask(__name__)

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


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


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


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

Redirect URI validation rules

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

Validation rules
Scheme

Redirect URIs must use the HTTPS scheme, not plain HTTP. Localhost URIs (including localhost IP address URIs) are exempt from this rule.

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” .
  • Redirect 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 .

    Fragment

    Redirect URIs cannot contain the fragment component.

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

    Incremental authorization

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

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

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

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

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

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

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

    PHP

    $client->setIncludeGrantedScopes(true);

    Python

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

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

    Ruby

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

    HTTP/REST

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

    Refreshing an access token (offline access)

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

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

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

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

    PHP

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

    $client->setAccessType("offline");

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

    Python

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

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

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

    Ruby

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

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

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

    HTTP/REST

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

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

    The following snippet shows a sample request:

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

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

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

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

    Revoking a token

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

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

    PHP

    To programmatically revoke a token, call revokeToken() :

    $client->revokeToken();

    Python

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

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

    Ruby

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

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

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

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

    HTTP/REST

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

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

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

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