OAuth 기반 Google 로그인 '간소화된' 연결 유형은 OAuth 기반 계정 연결 위에 Google 로그인을 추가합니다. 이렇게 하면 Google 사용자에게 원활한 음성 기반 연결이 제공되는 동시에 Google 이외의 ID로 서비스에 등록한 사용자에게 계정 연결이 가능합니다.
이 연결 유형은 Google 로그인으로 시작하며, 이를 통해 사용자의 Google 프로필 정보가 시스템에 있는지 확인할 수 있습니다. 시스템에서 사용자 정보를 찾을 수 없으면 표준 OAuth 흐름이 시작됩니다. 사용자는 Google 프로필 정보를 사용하여 새 계정을 만들 수도 있습니다.
간소화된 연결 유형으로 계정 연결을 수행하려면 다음과 같은 일반적인 단계를 따르세요.
- 먼저 사용자에게 Google 프로필에 액세스하는 데 동의해 달라고 요청합니다.
- 프로필의 정보를 사용하여 사용자를 식별합니다.
- 인증 시스템에서 Google 사용자와 일치하는 항목을 찾을 수 없는 경우 사용자 계정 생성을 음성이나 웹사이트에서만 허용하도록 작업 콘솔에서 작업 프로젝트를 구성했는지 여부에 따라 흐름이 진행됩니다.
- 음성을 통한 계정 생성을 허용하는 경우 Google에서 수신한 ID 토큰을 검증합니다. 그런 다음 ID 토큰에 포함된 프로필 정보를 기반으로 사용자를 만들 수 있습니다.
- 음성을 통한 계정 생성을 허용하지 않으면 사용자는 브라우저로 이동되며 여기에서 사용자가 승인 페이지를 로드하고 사용자 생성 흐름을 완료할 수 있습니다.
음성을 통한 계정 생성 지원
음성을 통한 사용자 계정 생성을 허용하면 어시스턴트가 사용자에게 다음 작업을 할지 묻습니다.
- 사용자의 Google 계정 정보를 사용하여 시스템에서 새 계정을 만듭니다.
- 기존 Google 이외의 계정이 있는 경우 다른 계정으로 인증 시스템에 로그인합니다.
계정 생성 흐름의 마찰을 최소화하려면 음성을 통한 계정 생성을 허용하는 것이 좋습니다. 사용자는 Google 이외의 기존 계정을 사용하여 로그인하려는 경우에만 음성 흐름을 종료하면 됩니다.
음성을 통한 계정 생성 허용 안함
음성을 통한 사용자 계정 생성을 허용하지 않은 경우 어시스턴트는 사용자 인증을 위해 제공된 웹사이트 URL을 엽니다. 화면이 없는 기기에서 상호작용이 발생하면 어시스턴트는 사용자를 휴대전화로 안내하여 계정 연결 흐름을 계속 진행합니다.
다음과 같은 경우 생성을 허용하지 않는 것이 좋습니다.
Google 이외의 계정을 가진 사용자가 신규 사용자 계정을 만들고 인증 시스템의 기존 사용자 계정에 연결하도록 허용하지 않을 것입니다. 예를 들어 포인트 제도를 제공하는 경우 사용자가 기존 계정에서 누적된 포인트가 사라지지 않도록 하는 것이 좋습니다.
계정 만들기 흐름을 완전히 관리할 수 있어야 합니다. 예를 들어 계정을 만드는 동안 사용자에게 서비스 약관을 표시해야 하는 경우 생성을 허용하지 않을 수 있습니다.
OAuth 기반 Google 로그인의 '간소화된' 연결 구현
계정은 업계 표준 OAuth 2.0 흐름에 연결됩니다. Actions on Google은 암시적 코드 흐름과 승인 코드 흐름을 지원합니다.
암시적 코드 흐름에서 Google은 사용자의 브라우저에서 승인 엔드포인트를 엽니다. 로그인에 성공하면 수명이 긴 액세스 토큰을 Google에 반환합니다. 이제 어시스턴트에서 작업으로 전송되는 모든 요청에 이 액세스 토큰이 포함됩니다.
승인 코드 흐름에는 두 개의 엔드포인트가 필요합니다.
- 승인 엔드포인트: 아직 로그인하지 않은 사용자에게 로그인 UI를 표시하고 요청한 액세스에 대한 동의를 단기 승인 코드 형식으로 기록하는 역할을 합니다.
- 두 가지 유형의 교환을 담당하는 토큰 교환 엔드포인트:
- 장기 갱신 토큰과 단기 액세스 토큰으로 승인 코드를 교환합니다. 이 교환은 사용자가 계정 연결 흐름을 진행할 때 이루어집니다.
- 장기 갱신 토큰을 단기 액세스 토큰으로 교환합니다. 이 교환은 액세스 토큰이 만료되어 Google에 새 액세스 토큰이 필요할 때 발생합니다.
암시적 코드 흐름을 구현하는 것이 더 간단하지만 암시적 흐름을 사용하여 발급된 액세스 토큰은 만료되지 않는 것이 좋습니다. 토큰 만료를 암시적 흐름과 함께 사용하면 사용자가 계정을 다시 연결하게 되기 때문입니다. 보안상의 이유로 토큰 만료가 필요하다면 인증 코드 흐름을 대신 사용하는 것이 좋습니다.
프로젝트 구성
간소화된 연결을 사용하도록 프로젝트를 구성하려면 다음 단계를 따르세요.
- Actions 콘솔을 열고 사용할 프로젝트를 선택합니다.
- 개발 탭을 클릭하고 계정 연결을 선택합니다.
- 계정 연결 옆에 있는 스위치를 사용 설정합니다.
- 계정 만들기 섹션에서 예를 선택합니다.
연결 유형에서 OAuth 및 Google 로그인 및 암시적을 선택합니다.
클라이언트 정보에서 다음을 수행합니다.
- Actions에서 Google에 발행한 클라이언트 ID에 값을 할당하여 Google에서 수신되는 요청을 식별합니다.
- 승인 및 토큰 교환 엔드포인트의 URL을 삽입합니다.
저장을 클릭합니다.
OAuth 서버 구현
To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.
When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.
A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:
- 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: YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
- 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.
Handle automatic linking
After the user gives your Action consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.
If the corresponding Google account is already present in your authentication system,
your token exchange endpoint returns a token for the user. If the Google account doesn't
match an existing user, your token exchange endpoint returns a user_not_found
error.
The request has the following form:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES
Your token exchange endpoint must be able to handle the following parameters:
Token endpoint parameters | |
---|---|
grant_type |
The type of token being exchanged. For these requests, this
parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer . |
intent |
For these requests, the value of this parameter is `get`. |
assertion |
A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address. |
consent_code |
Optional: When present, a one-time code that indicates that the user has granted consent for your Action to access the specified scopes. |
scope |
Optional: Any scopes you configured Google to request from users. |
When your token exchange endpoint receives the linking request, it should do the following:
Validate and decode the JWT assertion
You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.
When decoded, the JWT assertion looks like the following example:
{ "sub": 1234567890, // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "locale": "en_US" }
In addition to verifying the token's signature, verify that the assertion's issuer
(iss
field) is https://accounts.google.com
and that the audience (aud
field)
is the client ID assigned to your Action.
Check if the Google account is already present in your authentication system
Check whether either of the following conditions are true:
- The Google Account ID, found in the assertion's
sub
field, is in your user database. - The email address in the assertion matches a user in your user database.
If either condition is true, the user has already signed up and you can issue an access token.
If neither the Google Account ID nor the email address specified in the assertion
matches a user in your database, the user hasn't signed up yet. In this case, your
token exchange endpoint should reply with a HTTP 401 error, that specifies error=user_not_found
,
as in the following example:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"user_not_found", }
user_not_found
error, Google
calls your token exchange endpoint with the value of the intent
parameter
set to create and sending an ID token that contains the user's profile information
with the request.
Handle account creation via Google Sign-In
When a user needs to create an account on your service, Google makes a
request to your token exchange endpoint that specifies
intent=create
, as in the following example:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]
The assertion
parameter contains A JSON Web Token (JWT) that provides
a signed assertion of the Google user's identity. The JWT contains information
that includes the user's Google Account ID, name, and email address, which you can use
to create a new account on your service.
To respond to account creation requests, your token exchange endpoint must do the following:
Validate and decode the JWT assertion
You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.
When decoded, the JWT assertion looks like the following example:
{ "sub": 1234567890, // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "locale": "en_US" }
In addition to verifying the token's signature, verify that the assertion's issuer
(iss
field) is https://accounts.google.com
and that the audience (aud
field)
is the client ID assigned to your Action.
Validate user information and create new account
Check whether either of the following conditions are true:
- The Google Account ID, found in the assertion's
sub
field, is in your user database. - The email address in the assertion matches a user in your user database.
If either condition is true, prompt the user to link their existing account with
their Google Account by responding to the request with an HTTP 401 error, specifying
error=linking_error
and the user's email address as the login_hint
, as in the
following example:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
If neither condition is true, create a new user account using the information provided in the JWT. New accounts do not typically have a password set. It is recommended that you add Google Sign In to other platforms to enable users to log in via Google across the surfaces of your application. Alternatively, you can email the user a link that starts your password recovery flow to allow the user to set a password for signing in on other platforms.
When the creation is completed, issue an access token and return the values in a JSON object in the body of your HTTPS response, like in the following example:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
인증 흐름을 위한 음성 사용자 인터페이스 설계
사용자가 인증되었는지 확인하고 계정 연결 흐름을 시작합니다.
- Actions 콘솔에서 Actions Builder 프로젝트를 엽니다.
- 작업에서 계정 연결을 시작할 새 장면을 만듭니다.
- 장면을 클릭합니다.
- add (+) 아이콘을 클릭하여 새 장면을 추가합니다.
- 새로 만든 장면에서 조건의 추가 add 아이콘을 클릭합니다.
- 대화와 연결된 사용자가 인증된 사용자인지 확인하는 조건을 추가합니다. 검사에 실패하면 작업이 대화 중에 계정 연결을 실행할 수 없으며 계정 연결이 필요하지 않은 기능에 대한 액세스 권한을 제공하는 것으로 대체됩니다.
- 조건의
Enter new expression
필드에 다음 로직을 입력합니다.user.verificationStatus != "VERIFIED"
- Transition에서 계정 연결이 필요하지 않은 장면이나 게스트 전용 기능의 진입점인 장면을 선택합니다.
- 조건의
- 조건의 추가 add 아이콘을 클릭합니다.
- 사용자에게 연결된 ID가 없는 경우 계정 연결 흐름을 트리거하는 조건을 추가합니다.
- 조건의
Enter new expression
필드에 다음 로직을 입력합니다.user.verificationStatus == "VERIFIED"
- Transition에서 Account Linking 시스템 장면을 선택합니다.
- 저장을 클릭합니다.
- 조건의
저장하면 <SceneName>_AccountLinking
라는 새 계정 연결 시스템 장면이 프로젝트에 추가됩니다.
계정 연결 장면 맞춤설정
- Scenes(장면)에서 계정 연결 시스템 장면을 선택합니다.
- 메시지 보내기를 클릭하고 작업에서 사용자 ID에 액세스해야 하는 이유를 설명하는 짧은 문장을 추가합니다 (예: '환경설정 저장').
- 저장을 클릭합니다.
- 조건에서 사용자가 계정 연결을 완료한 경우를 클릭합니다.
- 사용자가 계정 연결에 동의하는 경우 흐름을 어떻게 진행할지 구성합니다. 예를 들어 웹훅을 호출하여 필요한 맞춤 비즈니스 로직을 처리하고 원래 장면으로 다시 전환할 수 있습니다.
- 저장을 클릭합니다.
- 조건에서 사용자가 계정 연결을 취소하거나 닫은 경우를 클릭합니다.
- 사용자가 계정 연결에 동의하지 않는 경우 흐름을 진행하는 방법을 구성합니다. 예를 들어 확인 메시지를 보내고 계정 연결이 필요하지 않은 기능을 제공하는 장면으로 리디렉션합니다.
- 저장을 클릭합니다.
- 조건에서 시스템 또는 네트워크 오류가 발생한 경우를 클릭합니다.
- 시스템 또는 네트워크 오류로 인해 계정 연결 흐름을 완료할 수 없는 경우 흐름을 진행하는 방법을 구성합니다. 예를 들어 확인 메시지를 보내고 계정 연결이 필요하지 않은 기능을 제공하는 장면으로 리디렉션합니다.
- 저장을 클릭합니다.
데이터 액세스 요청 처리
어시스턴트 요청에 액세스 토큰이 포함되어 있으면 먼저 액세스 토큰이 유효하고 만료되지 않았는지 확인한 후 사용자 계정 데이터베이스에서 토큰과 연결된 사용자 계정을 검색합니다.