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을 삽입합니다.
  1. 저장을 클릭합니다.

OAuth 서버 구현

OAuth 2.0 암시적 흐름을 지원하기 위해 서비스 승인 사용할 수 있습니다 이 엔드포인트는 데이터 액세스에 대한 사용자의 동의 받기 승인 엔드포인트 아직 로그인하지 않은 사용자에게 로그인 UI를 표시하고 액세스할 수 있도록 합니다.

작업이 서비스의 승인된 API 중 하나를 호출해야 하는 경우 Google은 이 엔드포인트를 있습니다.

Google에서 시작한 일반적인 OAuth 2.0 암시적 흐름 세션에는 다음 흐름을 따라 하세요.

  1. Google은 사용자의 브라우저에서 승인 엔드포인트를 엽니다. 이 사용자가 로그인하지 않은 경우 로그인하고 Google에 액세스 권한을 부여합니다. 아직 권한을 부여하지 않은 경우 API를 통해 해당 데이터에 액세스할 수 있습니다.
  2. 서비스에서 액세스 토큰을 만들고 이를 액세스 토큰을 사용하여 사용자의 브라우저를 Google로 다시 리디렉션함 이 요청에 첨부됩니다.
  3. Google은 서비스의 API를 호출하고 실행할 수 있습니다 서비스에서 액세스 토큰이 Google에 인증한 다음 API 호출을 완료합니다.

승인 요청 처리

작업이 OAuth 2.0 암시적 흐름을 통해 계정 연결을 수행해야 하는 경우 Google은 다음을 포함한 요청과 함께 사용자를 승인 엔드포인트로 보냅니다. 다음과 같습니다.

승인 엔드포인트 매개변수
client_id Google에 할당한 클라이언트 ID입니다.
redirect_uri 이 요청에 대한 응답을 보낼 URL입니다.
state 정해진 기간에 변경되지 않고 Google에 다시 전달되는 리디렉션 URI를 사용할 수 있습니다.
response_type 응답에서 반환할 값의 유형입니다. OAuth 2.0 암시적 흐름에서 응답 유형은 항상 token입니다.

예를 들어 승인 엔드포인트를 https://myservice.example.com/auth에서 사용할 수 있는 경우 요청은 다음과 같을 수 있습니다.

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

승인 엔드포인트가 로그인 요청을 처리하려면 다음 단계를 따르세요.

  1. 다음과 같이 client_id 및 redirect_uri 값을 확인합니다. 의도하지 않았거나 잘못 구성된 클라이언트 앱에 액세스 권한을 부여하지 않도록 합니다.

    • client_id가 등록된 클라이언트 ID와 일치하는지 확인합니다. 확인할 수 있습니다
    • redirect_uri에서 지정한 URL인지 확인합니다. 매개변수의 형식은 다음과 같습니다. 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      YOUR_PROJECT_ID는 프로젝트 설정 페이지에 있는 ID입니다. 기능을 살펴보겠습니다

  2. 사용자가 서비스에 로그인했는지 확인합니다. 사용자가 로그인하지 않은 경우 서비스의 로그인 또는 가입 절차를 완료합니다.

  3. Google에서 API에 액세스하는 데 사용할 액세스 토큰을 생성합니다. 이 액세스 토큰은 임의의 문자열 값이 될 수 있지만 클라이언트와 클라이언트에게 전달하며 추측할 수 없어야 합니다.

  4. 사용자의 브라우저를 URL로 리디렉션하는 HTTP 응답 전송 redirect_uri 매개변수로 지정됩니다. 다음을 모두 포함 다음 매개변수를 포함합니다.

    • access_token: 방금 생성한 액세스 토큰입니다.
    • token_type: 문자열 bearer
    • state: 원본의 수정되지 않은 상태 값입니다. 요청 다음은 결과 URL의 예입니다. 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google의 OAuth 2.0 리디렉션 핸들러가 액세스 토큰을 수신하고 state 값이 변경되지 않았음을 확인합니다. Google이 Google에서 후속 호출에 토큰을 첨부합니다. 작업을 AppRequest의 일부로 추가해야 합니다.

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

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

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

  1. 조건의 추가 아이콘을 클릭합니다.
  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 요청에 액세스 토큰이 포함되어 있으면 먼저 액세스 토큰이 유효하고 만료되지 않았는지 확인한 후 데이터베이스에서 연결된 사용자 계정을 검색합니다.