OAuth tabanlı Google ile Oturum Açma "Kolaylaştırılmış" bağlama türü, OAuth tabanlı hesap bağlamanın üzerine Google ile Oturum Açma özelliğini ekler. Bu sayede Google kullanıcıları için sorunsuz bir ses tabanlı bağlantı oluştururken Google dışı bir kimlikle hizmetinize kaydolan kullanıcılar için hesap bağlamayı da etkinleştirebilirsiniz.
Bu bağlantı türü, kullanıcının Google profili bilgilerinin sisteminizde mevcut olup olmadığını kontrol etmenize olanak tanıyan Google ile Oturum Açma özelliğiyle başlar. Kullanıcının bilgileri sisteminizde bulunamazsa standart bir OAuth akışı başlar. Kullanıcı, Google profil bilgileriyle yeni bir hesap oluşturmayı da seçebilir.
Basitleştirilmiş bağlantı türüyle hesap bağlama işlemi gerçekleştirmek için aşağıdaki genel adımları uygulayın:
- Öncelikle kullanıcıdan Google profiline erişim için izin vermesini isteyin.
- Kullanıcıyı tanımlamak için kullanıcının profilindeki bilgileri kullanın.
- Kimlik doğrulama sisteminizde Google kullanıcısı için eşleşme bulamazsanız, Actions Console'daki Actions projenizi sesle mi yoksa yalnızca web sitenizde mi yapılandırdığınıza bağlı olarak süreç devam eder.
- Sesle hesap oluşturmaya izin veriyorsanız Google'dan alınan kimlik jetonunu doğrulayın. Daha sonra, kimlik jetonunda bulunan profil bilgilerine dayalı bir kullanıcı oluşturabilirsiniz.
- Sesle hesap oluşturmaya izin vermezseniz kullanıcı, yetkilendirme sayfanızı yükleyebileceği ve kullanıcı oluşturma akışını tamamlayabileceği bir tarayıcıya aktarılır.
Sesle hesap oluşturma desteği
Sesle kullanıcı hesabı oluşturmaya izin verirseniz Asistan, kullanıcıya aşağıdakileri yapmak isteyip istemediğini sorar:
- Google hesap bilgilerini kullanarak sisteminizde yeni bir hesap oluşturun veya
- Google dışı bir hesapları varsa kimlik doğrulama sisteminizde farklı bir hesapla oturum açın.
Hesap oluşturma akışının zorluklarını en aza indirmek istiyorsanız sesle hesap oluşturmaya izin vermeniz önerilir. Kullanıcının yalnızca mevcut bir Google dışı hesabı kullanarak oturum açmak istediği durumlarda ses akışından ayrılması gerekir.
Sesle hesap oluşturmaya izin verme
Sesle kullanıcı hesabı oluşturmaya izin vermediyseniz Asistan, kullanıcı kimlik doğrulaması için sağladığınız web sitesinin URL'sini açar. Etkileşim, ekranı olmayan bir cihazda gerçekleşiyorsa Asistan, hesap bağlama akışına devam etmesi için kullanıcıyı telefona yönlendirir.
Aşağıdaki durumlarda oluşturmaya izin vermemeniz önerilir:
Google dışı hesapları olan kullanıcıların yeni bir kullanıcı hesabı oluşturmasına izin vermek istemiyor ve bunun yerine bu kullanıcıların, kimlik doğrulama sisteminizdeki mevcut kullanıcı hesaplarına bağlamasını istiyorsanız. Örneğin, bir bağlılık programı sunuyorsanız kullanıcının mevcut hesabında biriken puanları kaybetmediğinden emin olmak isteyebilirsiniz.
Hesap oluşturma akışı üzerinde tam kontrole sahip olmanız gerekir. Örneğin, hesap oluşturma sırasında hizmet şartlarınızı kullanıcıya göstermeniz gerekirse oluşturma işlemine izin vermemeyi tercih edebilirsiniz.
OAuth tabanlı Google ile Oturum Açma "Kolaylaştırılmış" bağlantıyı uygulayın
Hesaplar endüstri standardı OAuth 2.0 akışlarına bağlıdır. Actions on Google, dolaylı ve yetkilendirme kodu akışlarını destekler.
Dolaylı kod akışında Google, yetkilendirme uç noktanızı kullanıcının tarayıcısında açar. Başarılı bir şekilde oturum açtıktan sonra Google'a uzun ömürlü bir erişim jetonu döndürürsünüz. Bu erişim jetonu artık Asistan'dan Action'ınıza gönderilen her isteğe dahil edilir.
Yetkilendirme kodu akışında iki uç noktaya ihtiyacınız vardır:
- Oturum açma kullanıcı arayüzünü henüz oturum açmamış kullanıcılara sunmaktan ve istenen erişime kısa süreli bir yetkilendirme kodu biçiminde izin kaydetmekten sorumlu olan yetkilendirme uç noktası.
- İki tür exchange'den sorumlu olan jeton değişimi uç noktası:
- Yetkilendirme kodunu uzun ömürlü yenileme jetonu ve kısa ömürlü erişim jetonu ile değiştirir. Bu değişim, kullanıcı hesap bağlama akışından geçer.
- Kısa ömürlü bir erişim jetonu için uzun süreli yenileme jetonunu değiştirir. Bu exchange, Google'ın süresi dolmuş olduğundan yeni bir erişim jetonuna ihtiyacı olduğunda gerçekleşir.
Örtülü akış kullanılarak verilen erişim jetonlarının geçerlilik süresinin hiçbir zaman dolmaması, Google'ın örtülü akışla kullanılması nedeniyle kullanıcının hesabını tekrar bağlamayı zorunlu kıldığı için Google, örtülü akış akışının uygulanmasını önerir. Güvenlik nedeniyle jetonun süresinin dolması gerekiyorsa kimlik doğrulama kodu akışını kullanmanız önerilir.
Projeyi yapılandırma
Projenizi Basitleştirilmiş bağlantı kullanacak şekilde yapılandırmak için aşağıdaki adımları uygulayın:
- Actions konsolunu açın ve kullanmak istediğiniz projeyi seçin.
- Geliştirme sekmesini tıklayın ve Hesap bağlama'yı seçin.
- Hesap bağlama'nın yanındaki anahtarı etkinleştirin.
- Hesap oluşturma bölümünde Evet'i seçin.
Bağlantı türü bölümünde OAuth ve Google ile Oturum Açma ile Dolaylı'yı seçin.
Müşteri Bilgileri bölümünde aşağıdakileri yapın:
- Google'dan gelen istekleri tanımlamak için Actions to Google'a (İşlemleriniz tarafından Google'a gönderilen) bir değer atayın.
- Yetkilendirme ve Jeton Değişimi uç noktalarınızın URL'lerini ekleyin.
Kaydet'i tıklayın.
OAuth sunucunuzu uygulama
To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.
When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.
A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:
- Google opens your authorization endpoint in the user's browser. The user signs in if not signed in already, and grants Google permission to access their data with your API if they haven't already granted permission.
- Your service creates an access token and returns it to Google by redirecting the user's browser back to Google with the access token attached to the request.
- Google calls your service's APIs, and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.
Handle authorization requests
When your Action needs to perform account linking via an OAuth 2.0 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:
Authorization endpoint parameters | |
---|---|
client_id |
The client ID you assigned to Google. |
redirect_uri |
The URL to which you send the response to this request. |
state |
A bookkeeping value that is passed back to Google unchanged in the redirect URI. |
response_type |
The type of value to return in the response. For the OAuth 2.0 implicit
flow, the response type is always token . |
For example, if your authorization endpoint is available at https://myservice.example.com/auth
,
a request might look like:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token
For your authorization endpoint to handle sign-in requests, do the following steps:
Verify the
client_id
andredirect_uri
values to prevent granting access to unintended or misconfigured client apps:- Confirm that the
client_id
matches the client ID you assigned to Google. - Confirm that the URL specified by the
redirect_uri
parameter has the following form:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.
- Confirm that the
Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.
Generate an access token that Google will use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.
Send an HTTP response that redirects the user's browser to the URL specified by the
redirect_uri
parameter. Include all of the following parameters in the URL fragment:access_token
: the access token you just generatedtoken_type
: the stringbearer
state
: the unmodified state value from the original request The following is an example of the resulting URL:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
Google's OAuth 2.0 redirect handler will receive the access token and confirm
that the state
value hasn't changed. After Google has obtained an
access token for your service, Google will attach the token to subsequent calls
to your Action as part of the AppRequest.
Otomatik bağlamayı işleme
Kullanıcı, İşleminize Google profiline erişmesi için izin verdikten sonra Google, Google kullanıcısının kimliği için imzalı bir onay içeren bir istek gönderir. Onay, kullanıcının Google Hesabı kimliğini, adını ve e-posta adresini içeren bilgiler içerir. Projeniz için yapılandırılan jeton değişimi uç noktası bu isteği işler.
İlgili Google hesabı kimlik doğrulama sisteminizde zaten mevcutsa jeton değişimi uç noktanız kullanıcı için bir jeton döndürür. Google hesabı mevcut bir kullanıcıyla eşleşmezse jeton değişimi uç noktanız user_not_found
hatası döndürür.
İstek aşağıdaki biçimde olur:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES
Jeton değişimi uç noktanız aşağıdaki parametreleri işleyebilmelidir:
Jeton uç nokta parametreleri | |
---|---|
grant_type |
Alınan jetonun türü. Bu istekler için bu parametre urn:ietf:params:oauth:grant-type:jwt-bearer değerine sahiptir. |
intent |
Bu istekler için parametre değeri "get"tir. |
assertion |
Google kullanıcı kimliği için imzalı bir onay sağlayan JSON Web Token (JWT). JWT, kullanıcının Google Hesabı kimliğini, adını ve e-posta adresini içeren bilgiler içerir. |
consent_code |
İsteğe bağlı: Mevcut olduğunda, kullanıcının İşleminizin belirtilen kapsamlara erişmesine izin verdiğini belirten tek seferlik bir kod. |
scope |
İsteğe bağlı: Google'ın kullanıcılardan isteyeceği şekilde yapılandırdığınız tüm kapsamlar. |
Jeton değişimi uç noktanız bağlantı isteğini aldığında aşağıdakileri yapmalıdır:
Validate and decode the JWT assertion
You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.
When decoded, the JWT assertion looks like the following example:
{ "sub": 1234567890, // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "locale": "en_US" }
In addition to verifying the token's signature, verify that the assertion's issuer
(iss
field) is https://accounts.google.com
and that the audience (aud
field)
is the client ID assigned to your Action.
Google hesabının kimlik doğrulama sisteminizde mevcut olup olmadığını kontrol edin
Aşağıdaki koşullardan birinin doğru olup olmadığını kontrol edin:
- Onayın
sub
alanında bulunan Google Hesabı Kimliği, kullanıcı veritabanınızda yer alır. - Onaydaki e-posta adresi, kullanıcı veritabanınızdaki bir kullanıcıyla eşleşiyor.
İki koşul da doğruysa kullanıcı zaten kaydolmuştur ve erişim jetonu düzenleyebilirsiniz.
Onayda belirtilen Google Hesabı Kimliği veya e-posta adresi veritabanınızdaki bir kullanıcıyla eşleşmiyorsa kullanıcı henüz kaydolmamıştır. Bu durumda jeton değişimi uç noktanız, aşağıdaki örnekte olduğu gibi error=user_not_found
belirten bir HTTP 401 hatasıyla yanıt vermelidir:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"user_not_found", }Google,
user_not_found
hatası içeren 401 hatası yanıtı aldığında, intent
parametresi değeri create olarak ayarlanmış jeton değişimi uç noktanızı çağırır ve istekle birlikte kullanıcının profil bilgilerini içeren bir kimlik jetonu gönderir.
Google ile Oturum Açma aracılığıyla hesap oluşturma
Kullanıcının hizmetinizde bir hesap oluşturması gerektiğinde Google, aşağıdaki örnekte olduğu gibi, intent=create
değerini belirten jeton değişimi uç noktanıza bir istek gönderir:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]
assertion
parametresi, Google kullanıcısının kimliği için imzalı bir onay sağlayan JSON Web Token (JWT) içerir. JWT, hizmetinizde yeni bir hesap oluşturmak için kullanabileceğiniz, kullanıcının Google Hesabı kimliğini, adını ve e-posta adresini içeren bilgiler içerir.
Hesap oluşturma isteklerine yanıt vermek için jeton değişimi uç noktanızın aşağıdakileri yapması gerekir:
Validate and decode the JWT assertion
You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.
When decoded, the JWT assertion looks like the following example:
{ "sub": 1234567890, // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "locale": "en_US" }
In addition to verifying the token's signature, verify that the assertion's issuer
(iss
field) is https://accounts.google.com
and that the audience (aud
field)
is the client ID assigned to your Action.
Kullanıcı bilgilerini doğrulayın ve yeni hesap oluşturun
Aşağıdaki koşullardan birinin doğru olup olmadığını kontrol edin:
- Onayın
sub
alanında bulunan Google Hesabı Kimliği, kullanıcı veritabanınızda yer alır. - Onaydaki e-posta adresi, kullanıcı veritabanınızdaki bir kullanıcıyla eşleşiyor.
İki koşuldan biri doğruysa, aşağıdaki örnekte olduğu gibi error=linking_error
özelliğini ve kullanıcının e-posta adresini login_hint
olarak belirterek isteğe yanıt vererek kullanıcıdan mevcut hesabını Google Hesabı ile bağlamasını isteyin:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
Hiçbir koşul doğru değilse JWT'de sağlanan bilgileri kullanarak yeni bir kullanıcı hesabı oluşturun. Yeni hesaplarda genellikle şifre belirlenmez. Kullanıcıların uygulama platformlarında Google aracılığıyla giriş yapabilmesi için Google ile Oturum Açma özelliğini diğer platformlara eklemeniz önerilir. Alternatif olarak, kullanıcıya diğer platformlarda oturum açmak için şifre belirleme izni vermek amacıyla şifre kurtarma akışınızı başlatan bir bağlantıyı kullanıcıya e-posta ile gönderebilirsiniz.
Oluşturma işlemi tamamlandığında bir erişim jetonu ve aşağıdaki örnekte gösterildiği gibi, HTTPS yanıtınızın gövdesinde bir JSON nesnesindeki değerleri döndürün:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Kimlik doğrulama akışı için ses kullanıcı arayüzünü tasarlama
Kullanıcının doğrulanıp doğrulanmadığını kontrol etme ve hesap bağlama akışını başlatma
- Actions Console'da Actions Builder projenizi açın.
- İşleminizde hesap bağlamayı başlatmak için yeni bir sahne oluşturun:
- Sahneler'i tıklayın.
- Yeni bir sahne eklemek için ekle (+) simgesini tıklayın.
- Yeni oluşturulan sahnede Koşullar için ekle add simgesini tıklayın.
- Görüşmeyle ilişkilendirilen kullanıcının doğrulanmış bir kullanıcı olup olmadığını kontrol eden bir koşul ekleyin. Kontrol başarısız olursa İşleminiz görüşme sırasında hesap bağlama işlemi gerçekleştiremez ve hesap bağlamayı gerektirmeyen işlevlere erişim sağlamaya devam etmelidir.
- Koşul bölümündeki
Enter new expression
alanına aşağıdaki mantığı girin:user.verificationStatus != "VERIFIED"
- Geçiş bölümünde, hesap bağlama gerektirmeyen bir düzen veya yalnızca konuklara özel işleve giriş noktası olan bir düzen seçin.
- Koşul bölümündeki
- Koşullar için add ekle simgesini tıklayın.
- Kullanıcının ilişkili bir kimliği yoksa hesap bağlama akışını tetiklemek için bir koşul ekleyin.
- Koşul bölümündeki
Enter new expression
alanına aşağıdaki mantığı girin:user.verificationStatus == "VERIFIED"
- Geçiş bölümünde, Hesap Bağlama sistem sahnesini seçin.
- Kaydet'i tıklayın.
- Koşul bölümündeki
Kaydettikten sonra projenize <SceneName>_AccountLinking
adlı yeni bir hesap bağlama sistemi düzeni eklenir.
Hesap bağlama sahnesini özelleştirin
- Sahneler bölümünde, hesap bağlama sistemi sahnesini seçin.
- İstem gönder'i tıklayın ve işlemin neden kimliğine erişmesi gerektiğini kullanıcıya açıklamak için kısa bir cümle ekleyin (örneğin, "Tercihlerinizi kaydetmek için").
- Kaydet'i tıklayın.
- Koşullar bölümünde, Kullanıcı hesap bağlamayı başarıyla tamamlarsa'yı tıklayın.
- Kullanıcı, hesabını bağlamayı kabul ederse akışın nasıl devam edeceğini yapılandırın. Örneğin, gerekli olan özel iş mantığını işlemesi ve kaynak sahneye geri dönmesi için webhook'u çağırın.
- Kaydet'i tıklayın.
- Koşullar bölümünde, Kullanıcı hesap bağlamayı iptal eder veya reddederse'yi tıklayın.
- Kullanıcı, hesabını bağlamayı kabul etmezse akışın nasıl devam edeceğini yapılandırın. Örneğin, onaylama mesajı gönderin ve kullanıcıları, hesap bağlamayı gerektirmeyen işlevler sunan sahnelere yönlendirin.
- Kaydet'i tıklayın.
- Koşullar bölümünde, Sistem veya ağ hatası oluşursa'yı tıklayın.
- Hesap bağlama akışı sistem veya ağ hataları nedeniyle tamamlanamıyorsa akışın nasıl devam edeceğini yapılandırın. Örneğin, onaylama mesajı gönderin ve kullanıcıları, hesap bağlamayı gerektirmeyen işlevler sunan sahnelere yönlendirin.
- Kaydet'i tıklayın.
Veri erişim isteklerini işleme
Asistan isteği erişim jetonu içeriyorsa öncelikle erişim jetonunun geçerli olduğundan ve süresinin dolmadığından emin olun, ardından kullanıcı hesabı veritabanınızdan jetonla ilişkili kullanıcı hesabını alın.