OAuth를 사용한 계정 연결

OAuth 연결 유형은 두 가지 업계 표준 OAuth 2.0 흐름, 즉 암시적 및 승인 코드 흐름을 지원합니다.

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.

OAuth 계정 연결 구현

프로젝트 구성

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

1. Actions Console을 열고 사용할 프로젝트를 선택합니다.
2. 개발 탭을 클릭하고 계정 연결을 선택합니다.
3. 계정 연결 옆에 있는 스위치를 사용 설정합니다.
4. 계정 생성 섹션에서 아니요, 내 웹사이트에서만 계정 생성을 허용하고 싶습니다를 선택합니다.

5. 연결 유형에서 OAuth 및 암시적을 선택합니다.

   

6. 클라이언트 정보:

   • Actions에서 Google에 발행한 클라이언트 ID에 값을 할당하여 Google에서 수신되는 요청을 식별합니다.
   • 승인 및 토큰 교환 엔드포인트의 URL을 삽입합니다.

6. 저장을 클릭합니다.

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:

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.

인증 흐름을 위한 음성 사용자 인터페이스 설계

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

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

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

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

계정 연결 장면 맞춤설정

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

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

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

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

데이터 액세스 요청 처리

Assistant 요청에 액세스 토큰이 포함되어 있으면 먼저 액세스 토큰이 유효하고 만료되지 않았는지 확인한 후 데이터베이스에서 연결된 사용자 계정을 검색합니다.