OAuth 및 Google 로그인 (Dialogflow)을 통한 계정 연결

OAuth 및 Google 로그인 연결 유형은 OAuth 기반에 Google 로그인을 추가합니다. 계정 연결 이를 통해 Google 사용자에게 원활한 음성 기반 연결이 제공됩니다. 또한 서비스에 등록한 사용자의 계정 연결을 사용 설정할 수 있습니다. Google이 아닌 다른 ID를 사용하는 경우일 수 있습니다

이 연결 유형은 Google 로그인으로 시작하며, 이를 통해 사용자의 Google 프로필 정보가 시스템에 존재합니다. 사용자 정보가 시스템에서 찾을 수 없는 경우 표준 OAuth 흐름이 시작됩니다. 사용자는 다음 작업도 가능합니다. Google 프로필 정보를 사용하여 새 계정을 만들기로 선택하는 경우

<ph type="x-smartling-placeholder">

</ph>

그림 1: 작업이 사용자의 Google 프로필을 사용하여 인증 시스템에서 사용자와 일치하는 항목을 찾을 수 있습니다.

OAuth 및 Google 로그인으로 계정을 연결하려면 다음 일반 단계를 따르세요. 단계:

1. 먼저 사용자에게 Google 프로필 액세스에 동의해 달라고 요청합니다.
2. 사용자 프로필의 정보를 사용하여 사용자를 식별합니다.
3. 인증 시스템에서 Google 사용자와 일치하는 항목을 찾을 수 없는 경우 작업 프로젝트를 구성했는지 여부에 따라 흐름이 진행됩니다. 확인할 수 있습니다
   • 음성을 통한 계정 생성을 허용하는 경우 ID를 검증하세요. 토큰입니다. 그런 다음 ID 토큰에 포함된 프로필 정보입니다.
   • 음성을 통한 계정 생성을 허용하지 않으면 사용자가 다음으로 이전됩니다. 승인 페이지를 로드하고 사용자 인증 정보를 완료할 수 있는 브라우저 만들 수 있습니다.

그림 2. OAuth 및 Google Cloud 콘솔의 시각적 표시 시스템에서 사용자 정보를 찾을 수 없는 경우의 로그인 흐름

음성을 통한 계정 생성 지원

음성을 통한 사용자 계정 생성을 허용하면 어시스턴트에서 사용자에게 다음과 같이 하려고 합니다.

• Google 계정 정보를 사용하여 시스템에서 새 계정을 만듭니다.
• 다른 계정이 있는 경우 다른 계정으로 인증 시스템에 로그인하세요. 계정에 연결할 수 없습니다.

이러한 문제를 최소화하려면 음성을 통한 계정 생성을 허용하는 것이 좋습니다. 계정 생성 흐름의 마찰이 있습니다 사용자는 음성 흐름에서 나가기만 하면 됨 (Google 계정이 아닌 기존 계정을 사용하여 로그인하려는 경우).

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

음성을 통한 사용자 계정 생성을 허용하지 않은 경우 어시스턴트는 사용자 인증을 위해 제공한 웹사이트가 포함됩니다. 상호 작용이 발생하는 경우 화면이 없는 기기에서는 어시스턴트가 사용자를 휴대전화로 안내합니다. 계정 연결 절차를 계속 진행합니다.

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

• Google 이외의 계정이 있는 사용자가 해당 사용자가 계정의 기존 사용자 계정에 연결하도록 하려는 인증 시스템을 사용할 것입니다. 예를 들어 포인트 멤버십을 제공하는 경우 사용자가 포인트를 잃어버리지 않도록 계정을 만들 수 있습니다.

• 계정 생성 절차를 완전히 관리할 수 있어야 합니다. 예를 들어 사용자에게 서비스 약관을 표시해야 하는 경우 계정 만들기

를 통해 개인정보처리방침을 정의할 수 있습니다.

참고: 아래의 흐름 옵션 중 하나를 선택하여 선택할 수 있습니다 필요한 경우 가이드의 내용이 선택할 수 있습니다

<ph type="x-smartling-placeholder"></ph> 음성을 통한 계정 생성 허용 음성을 통한 계정 생성 허용 안함

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 OAuth2 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

프로젝트 구성

OAuth 및 Google 로그인 계정을 사용하도록 프로젝트 구성 다음 단계를 따르세요.

1. Actions 콘솔을 열고 사용하려는 프로젝트를 선택합니다.
2. 개발 탭을 클릭하고 계정 연결을 선택합니다.
3. 계정 연결 옆의 스위치를 켭니다. <ph type="x-smartling-placeholder">
4. 계정 만들기 섹션에서 예를 선택합니다.

5. 연결 유형에서 OAuth & Google 로그인 및 암시적

   

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

   • 내 작업에서 Google에 발급한 클라이언트 ID에 값을 할당하여 Google에서 전송하는 요청입니다. <ph type="x-smartling-placeholder"></ph>
   • 승인 및 토큰 교환 엔드포인트의 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 OAuth2 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:

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.

Note: The keys should not be hardcoded. Instead, follow OpenID connect discovery protocol and check the cache-control header to decide how long the key should be cached.

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

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:

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.

Note: The keys should not be hardcoded. Instead, follow OpenID connect discovery protocol and check the cache-control header to decide how long the key should be cached.

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

인증 흐름 시작

경고: 사용자에게 필수 계정을 제공하지 마세요. 작업 관련 대화를 시작할 때 메시지를 생성합니다 대신 인증되지 않은 사용자에게 작업의 작동 방식을 보여주는 게스트 플로우를 제공합니다. 계속 진행하는 데 필요한 경우에만 계정 연결을 요청하세요. 사용자가 계정 연결 문제로 인해 작업을 지속적으로 중단하는 경우 액션을 적극적으로 홍보하지 않아 액션의 사용자 트래픽이 감소할 수 있습니다.

확인된 사용자만 계정 연결을 수행할 수 있습니다. 사용자가 계정을 연결할 수 없습니다. 식별 및 처리 알아보기 게스트 사용자가 필요합니다.

계정 로그인 도우미 인텐트 사용 인증 흐름을 시작합니다.

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

</ph>

Dialogflow (Node.js)

const app = dialogflow({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
})

// Intent that starts the account linking flow.
app.intent('Start Signin', conv => {
  conv.ask(new SignIn('To get your account details'))
})

드림

<ph type="x-smartling-placeholder">

</ph>

Dialogflow (Java)

private String clientId = "<your_client_id>";

@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

드림

<ph type="x-smartling-placeholder">

</ph>

Actions SDK (Node.js)

const app = actionssdk({
  clientId: CLIENT_ID,
})

app.intent('Start Signin', conv => {
  conv.ask(new SignIn('To get your account details'))
})

드림

<ph type="x-smartling-placeholder">

</ph>

Actions SDK (Java)

private String clientId = "<your_client_id>";

@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

데이터 액세스 요청 처리

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