OAuth 기반 Google 로그인의 '간소화된' 연결을 통한 계정 연결

OAuth 기반 Google 로그인 '간소화' 연결 유형은 OAuth 기반 계정 연결 위에 Google 로그인을 추가합니다. 이를 통해 Google 사용자는 원활한 음성 기반 연결을 이용할 수 있으며, Google 이외의 ID로 서비스에 등록한 사용자는 계정 연결을 이용할 수 있습니다.

이 연결 유형은 사용자의 Google 프로필 정보가 시스템에 있는지 확인할 수 있는 Google 로그인으로 시작됩니다. 사용자의 정보가 시스템에 없으면 표준 OAuth 흐름이 시작됩니다. 사용자는 Google 프로필 정보로 새 계정을 만들 수도 있습니다.

그림 1: 작업이 사용자의 Google 프로필에 액세스한 후 이를 사용하여 인증 시스템에서 사용자를 찾을 수 있습니다.

간소화된 연결 유형으로 계정 연결을 실행하려면 다음 일반 단계를 따르세요.

1. 먼저 사용자에게 Google 프로필에 액세스할 수 있도록 동의를 요청합니다.
2. 프로필의 정보를 사용하여 사용자를 식별합니다.
3. 인증 시스템에서 Google 사용자를 찾을 수 없는 경우, 음성을 통해 또는 웹사이트에서만 사용자 계정을 만들 수 있도록 Actions 콘솔에서 Actions 프로젝트를 구성했는지에 따라 흐름이 진행됩니다.
   • 음성을 통한 계정 생성을 허용하는 경우 Google에서 수신한 ID 토큰을 검증합니다. 그런 다음 ID 토큰에 포함된 프로필 정보를 기반으로 사용자를 만들 수 있습니다.
   • 음성을 통한 계정 생성을 허용하지 않으면 사용자가 브라우저로 트랜스퍼되어 승인 페이지를 로드하고 사용자 생성 흐름을 완료할 수 있습니다.

그림 2. 사용자의 정보가 시스템에서 발견되지 않은 경우의 OAuth 및 Google 로그인 흐름을 시각적으로 표현한 것입니다.

음성을 통한 계정 생성 지원

음성을 통해 사용자 계정 생성을 허용하는 경우 어시스턴트는 사용자에게 다음 작업을 수행할지 묻습니다.

• Google 계정 정보를 사용하여 시스템에 새 계정을 만듭니다.
• 기존 Google 이외 계정이 있는 경우 다른 계정으로 인증 시스템에 로그인합니다.

계정 생성 흐름의 불편함을 최소화하려면 음성을 통한 계정 생성을 허용하는 것이 좋습니다. 사용자가 기존의 비 Google 계정을 사용하여 로그인하려면 음성 흐름을 종료해야 합니다.

음성을 통한 계정 생성 허용 안 함

음성을 통한 사용자 계정 생성을 허용하지 않은 경우 어시스턴트는 사용자 인증을 위해 제공한 웹사이트의 URL을 엽니다. 화면이 없는 기기에서 상호작용이 발생하는 경우 어시스턴트는 사용자에게 휴대전화로 이동하여 계정 연결 흐름을 계속 진행하도록 안내합니다.

다음과 같은 경우 생성을 허용하지 않는 것이 좋습니다.

• Google 계정이 없는 사용자가 새 사용자 계정을 만들지 못하도록 하고 대신 인증 시스템의 기존 사용자 계정에 연결하도록 하려고 합니다. 예를 들어 포인트 적립 프로그램을 제공하는 경우 사용자가 기존 계정에서 적립한 포인트를 잃지 않도록 해야 할 수 있습니다.

• 계정 생성 흐름을 완전히 제어할 수 있어야 합니다. 예를 들어 계정 생성 중에 사용자에게 서비스 약관을 표시해야 하는 경우 생성을 허용하지 않을 수 있습니다.

참고: 아래의 흐름 옵션 중 하나를 선택하여 선택한 흐름의 구현에 대해 자세히 알아보세요. 필요한 경우 선택에 맞게 가이드의 콘텐츠가 다시 로드됩니다.

음성을 통한 계정 생성 허용 음성을 통한 계정 생성 허용 안 함

OAuth 기반 Google 로그인 '간소화된' 연결 구현

계정은 업계 표준 OAuth 2.0 흐름과 연결됩니다. Actions on Google은 암시적 흐름과 승인 코드 흐름을 지원합니다.

참고: 금융 정보를 처리하기 위해 계정 연결을 구현하는 경우 작업에 추가 정책이 적용될 수 있습니다. 계정 연결을 통해 금융 정보를 수집하는 작업을 검토하는 데 최대 6주가 걸릴 수 있으므로 출시 일정을 계획할 때 이 점을 고려하세요. 검토 절차를 간소화하려면 검토를 위해 작업을 제출하기 전에 금융 서비스 정책을 준수해야 합니다.

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

In the authorization code flow, you need two endpoints:

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

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

Note: Please choose which OAuth 2.0 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

프로젝트 구성

간소화된 연결을 사용하도록 프로젝트를 구성하려면 다음 단계를 따르세요.

1. Actions 콘솔을 열고 사용할 프로젝트를 선택합니다.
2. 개발 탭을 클릭하고 계정 연결을 선택합니다.
3. 계정 연결 옆에 있는 스위치를 사용 설정합니다.
4. 계정 생성 섹션에서 예를 선택합니다.

5. 연결 유형에서 OAuth 및 Google 로그인과 암시적을 선택합니다.

   

6. 클라이언트 정보에서 다음을 수행합니다.

   • Google에 대한 작업에서 발급한 클라이언트 ID에 값을 할당하여 Google에서 들어오는 요청을 식별합니다.
   • 승인 및 토큰 교환 엔드포인트의 URL을 삽입합니다.

7. 저장을 클릭합니다.

OAuth 서버 구현

To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.

When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.

A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:

1. Google opens your authorization endpoint in the user's browser. The user signs in if not signed in already, and grants Google permission to access their data with your API if they haven't already granted permission.
2. Your service creates an access token and returns it to Google by redirecting the user's browser back to Google with the access token attached to the request.
3. Google calls your service's APIs, and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.

Handle authorization requests

When your Action needs to perform account linking via an OAuth 2.0 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:

Authorization endpoint parameters
client_id	The client ID you assigned to Google.
redirect_uri	The URL to which you send the response to this request.
state	A bookkeeping value that is passed back to Google unchanged in the redirect URI.
response_type	The type of value to return in the response. For the OAuth 2.0 implicit flow, the response type is always token.

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

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

For your authorization endpoint to handle sign-in requests, do the following steps:

1. Verify the client_id and redirect_uri values to prevent granting access to unintended or misconfigured client apps:

   • Confirm that the client_id matches the client ID you assigned to Google.
   • Confirm that the URL specified by the redirect_uri parameter has the following form:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID

     YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.

2. Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.

3. Generate an access token that Google will use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.

4. Send an HTTP response that redirects the user's browser to the URL specified by the redirect_uri parameter. Include all of the following parameters in the URL fragment:

   • access_token: the access token you just generated
   • token_type: the string bearer
   • state: the unmodified state value from the original request The following is an example of the resulting URL:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google's OAuth 2.0 redirect handler will receive the access token and confirm that the state value hasn't changed. After Google has obtained an access token for your service, Google will attach the token to subsequent calls to your Action as part of the AppRequest.

Handle automatic linking

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

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

The request has the following form:

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

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

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

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

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

JWT 어설션 검증 및 디코딩

해당 언어의 JWT 디코딩 라이브러리를 사용하여 JWT 어설션을 검증하고 디코딩할 수 있습니다. Google의 공개 키 (JWK 또는 PEM 형식)을 사용하여 토큰의 서명합니다.

참고: 키를 하드코딩하면 안 됩니다. 대신 OpenID Connect Discovery를 프로토콜 cache-control 헤더를 확인하여 키를 캐시하는 기간을 결정합니다.

JWT 어설션은 디코딩될 때 다음 예시와 같이 표시됩니다.

{
  "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": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

토큰의 서명을 확인하는 것 외에도 어설션의 발급자가 (iss 필드)가 https://accounts.google.com이고 잠재고객 (aud 필드) 는 작업에 할당된 클라이언트 ID입니다.

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

Check whether either of the following conditions are true:

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

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

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

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

{
  "error":"user_not_found",
}

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

Handle account creation via Google Sign-In

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

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

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

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

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

JWT 어설션 검증 및 디코딩

해당 언어의 JWT 디코딩 라이브러리를 사용하여 JWT 어설션을 검증하고 디코딩할 수 있습니다. Google의 공개 키 (JWK 또는 PEM 형식)을 사용하여 토큰의 서명합니다.

참고: 키를 하드코딩하면 안 됩니다. 대신 OpenID Connect Discovery를 프로토콜 cache-control 헤더를 확인하여 키를 캐시하는 기간을 결정합니다.

JWT 어설션은 디코딩될 때 다음 예시와 같이 표시됩니다.

{
  "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": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

토큰의 서명을 확인하는 것 외에도 어설션의 발급자가 (iss 필드)가 https://accounts.google.com이고 잠재고객 (aud 필드) 는 작업에 할당된 클라이언트 ID입니다.

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":"[e-mail]"
}

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
}

인증 흐름의 음성 사용자 인터페이스 설계

경고: 사용자가 작업과 대화를 시작할 때 필수 계정 연결 프롬프트를 제공하지 마세요. 대신 인증되지 않은 사용자에게 게스트 흐름을 제공하여 작업이 작동하는 방식을 보여주고 계속 진행하는 데 필요한 경우에만 계정 연결을 요청하세요. 사용자가 계정 연결 문제로 인해 지속적으로 작업을 종료하는 경우 Google에서는 작업을 적극적으로 홍보하지 않으며, 이로 인해 작업의 사용자 트래픽이 감소할 수 있습니다.

참고: Actions Builder를 사용하여 계정 연결을 구현하는 작업을 빌드해야 합니다.

사용자가 인증되었는지 확인하고 계정 연결 흐름 시작

1. Actions 콘솔에서 Actions Builder 프로젝트를 엽니다.
2. 작업에서 계정 연결을 시작할 새 장면을 만듭니다.
   1. 장면을 클릭합니다.
   2. 추가 (+) 아이콘을 클릭하여 새 장면을 추가합니다.
3. 새로 만든 장면에서 조건의 추가 아이콘을 클릭합니다.
4. 대화와 연결된 사용자가 인증된 사용자인지 확인하는 조건을 추가합니다. 확인이 실패하면 작업이 대화 중에 계정 연결을 실행할 수 없으며 계정 연결이 필요하지 않은 기능에 대한 액세스를 제공하도록 대체해야 합니다.
   1. 조건 아래의 Enter new expression 필드에 다음 논리를 입력합니다. user.verificationStatus != "VERIFIED"
   2. 전환에서 계정 연결이 필요하지 않은 장면이나 게스트 전용 기능의 진입점인 장면을 선택합니다.

1. 조건의 추가 아이콘을 클릭합니다.
2. 사용자에게 연결된 ID가 없는 경우 계정 연결 흐름을 트리거하는 조건을 추가합니다.
   1. 조건 아래의 Enter new expression 필드에 다음 논리를 입력합니다. user.verificationStatus == "VERIFIED"
   2. 전환에서 계정 연결 시스템 장면을 선택합니다.
   3. 저장을 클릭합니다.

저장하면 <SceneName>_AccountLinking라는 새 계정 연결 시스템 장면이 프로젝트에 추가됩니다.

계정 연결 장면 맞춤설정

1. 장면에서 계정 연결 시스템 장면을 선택합니다.
2. 프롬프트 보내기를 클릭하고 작업에서 사용자의 ID에 액세스해야 하는 이유를 설명하는 짧은 문장을 추가합니다 (예: '환경설정을 저장하기 위해').
3. 저장을 클릭합니다.

1. 조건에서 사용자가 계정 연결을 완료한 경우를 클릭합니다.
2. 사용자가 계정 연결에 동의하는 경우 흐름이 진행되는 방식을 구성합니다. 예를 들어 필요한 맞춤 비즈니스 로직을 처리하고 원래 장면으로 다시 전환하기 위해 웹훅을 호출합니다.
3. 저장을 클릭합니다.

1. 조건에서 사용자가 계정 연결을 취소하거나 닫는 경우를 클릭합니다.
2. 사용자가 계정 연결에 동의하지 않는 경우 흐름이 어떻게 진행되어야 하는지 구성합니다. 예를 들어 확인 메시지를 보내고 계정 연결이 필요하지 않은 기능을 제공하는 장면으로 리디렉션합니다.
3. 저장을 클릭합니다.

1. 조건에서 시스템 또는 네트워크 오류가 발생하는 경우를 클릭합니다.
2. 시스템 또는 네트워크 오류로 인해 계정 연결 흐름을 완료할 수 없는 경우 흐름이 진행되는 방식을 구성합니다. 예를 들어 확인 메시지를 보내고 계정 연결이 필요하지 않은 기능을 제공하는 장면으로 리디렉션합니다.
3. 저장을 클릭합니다.

데이터 액세스 요청 처리

어시스턴트 요청에 액세스 토큰이 포함된 경우 먼저 액세스 토큰이 유효하고 만료되지 않았는지 확인한 다음 토큰과 연결된 사용자 계정을 사용자 계정 데이터베이스에서 가져옵니다.