토큰 모델 사용

google.accounts.oauth2 JavaScript 라이브러리를 사용하면 사용자 동의를 요청하고 사용자 데이터로 작업할 수 있는 액세스 토큰을 가져올 수 있습니다. OAuth 2.0 암시적 부여 플로우를 기반으로 하며 REST 및 CORS를 사용하여 Google API를 직접 호출하거나 JavaScript용 Google API 클라이언트 라이브러리 (gapi.client라고도 함)를 사용하여 더 복잡한 API에 유연하게 액세스할 수 있도록 설계되었습니다.

브라우저에서 보호된 사용자 데이터에 액세스하기 전에 사이트의 사용자가 Google의 웹 기반 계정 선택기, 로그인, 동의 프로세스를 트리거하고 마지막으로 Google의 OAuth 서버가 웹 앱에 액세스 토큰을 발급하고 반환합니다.

토큰 기반 승인 모델에서는 백엔드 서버에 사용자별 갱신 토큰을 저장할 필요가 없습니다.

이전 클라이언트 측 웹 애플리케이션용 OAuth 2.0 가이드에서 다루는 기술 대신 여기에 설명된 접근 방식을 따르는 것이 좋습니다.

기본 요건

설정에 설명된 단계에 따라 OAuth 동의 화면을 구성하고 클라이언트 ID를 가져오고 클라이언트 라이브러리를 로드합니다.

토큰 클라이언트 초기화

웹 앱의 클라이언트 ID로 새 토큰 클라이언트를 초기화하려면 initTokenClient()를 호출합니다. 사용자가 액세스해야 하는 범위 목록을 하나 이상 포함해야 합니다.

const client = google.accounts.oauth2.initTokenClient({
  client_id: 'YOUR_GOOGLE_CLIENT_ID',
  scope: 'https://www.googleapis.com/auth/calendar.readonly',
  callback: (response) => {
    ...
  },
});

OAuth 2.0 토큰 흐름 트리거

requestAccessToken() 메서드를 사용하여 토큰 UX 흐름을 트리거하고 액세스 토큰을 가져옵니다. Google에서 사용자에게 다음을 요청합니다.

  • 계정 선택
  • 아직 로그인하지 않은 경우 Google 계정에 로그인
  • 웹 앱이 요청된 각 범위에 액세스할 수 있도록 동의 부여

사용자 동작이 토큰 흐름을 트리거합니다.

<button onclick="client.requestAccessToken();">Authorize me</button>

그러면 Google에서 액세스 토큰과 사용자가 액세스 권한을 부여한 범위 목록 또는 오류가 포함된 TokenResponse를 콜백 핸들러에 반환합니다.

사용자가 계정 선택기 또는 로그인 창을 닫을 수 있으며, 이 경우 콜백 함수가 호출되지 않습니다.

앱의 디자인과 사용자 환경은 Google의 OAuth 2.0 정책을 철저히 검토한 후에만 구현해야 합니다. 이러한 정책은 여러 범위로 작업하는 방법, 사용자 동의를 처리하는 시점과 방법 등을 다룹니다.

점진적 승인 은 리소스에 대한 액세스를 요청하는 데 사용되는 정책 및 앱 설계 방법론으로, 한 번에 모두 요청하는 대신 필요할 때만 범위를 사용합니다. 사용자는 앱에서 요청한 개별 리소스의 공유를 승인하거나 거부할 수 있으며, 이를 세분화된 권한 이라고 합니다.

이 프로세스 중에 Google에서 사용자 동의를 요청하고, 요청된 각 범위를 개별적으로 나열하며, 사용자는 앱과 공유할 리소스를 선택하고, 마지막으로 Google에서 콜백 함수를 호출하여 액세스 토큰과 사용자 승인 범위를 반환합니다. 그러면 앱에서 세분화된 권한으로 가능한 다양한 결과를 안전하게 처리합니다.

하지만 예외가 있습니다. 도메인 전체 권한 위임이 있는 Google Workspace Enterprise 앱 또는 신뢰할 수 있음으로 표시된 앱은 세분화된 권한 동의 화면을 우회합니다. 이러한 앱의 경우 사용자에게 세분화된 권한 동의 화면이 표시되지 않습니다. 대신 앱에서 요청된 모든 범위 또는 범위를 받지 않습니다.

자세한 내용은 세분화된 권한을 처리하는 방법을 참고하세요.

점진적 승인

웹 앱의 경우 다음 두 가지 상위 시나리오에서는 다음을 사용하여 점진적 승인을 보여줍니다.

  • 단일 페이지 Ajax 앱(리소스에 대한 동적 액세스와 함께 XMLHttpRequest를 사용하는 경우가 많음)
  • 여러 웹페이지, 리소스는 페이지별로 분리되어 관리됨

이 두 가지 시나리오는 설계 고려사항과 방법론을 설명하기 위해 제공되지만 앱에 동의를 빌드하는 방법에 대한 포괄적인 권장사항은 아닙니다. 실제 앱에서는 이러한 기술의 변형 또는 조합을 사용할 수 있습니다.

Ajax

requestAccessToken()을 여러 번 호출하고 OverridableTokenClientConfig 객체의 scope 매개변수를 사용하여 필요할 때만 개별 범위를 요청하여 앱에 점진적 승인 지원을 추가합니다. 이 예에서는 사용자 동작이 접힌 콘텐츠 섹션을 펼친 후에만 리소스가 요청되고 표시됩니다.

Ajax 앱
페이지 로드 시 토큰 클라이언트 초기화: 
        const client = google.accounts.oauth2.initTokenClient({
          client_id: 'YOUR_GOOGLE_CLIENT_ID',
          callback: "onTokenResponse",
        });
사용자 동작을 통해 동의를 요청하고 액세스 토큰을 가져옵니다. `+` 를 클릭하여 엽니다.

읽을 문서

최근 문서 표시

          client.requestAccessToken(
            overrideConfig = ({
               scope = 'https://www.googleapis.com/auth/documents.readonly'
             })
           );

예정된 이벤트

캘린더 정보 표시

          client.requestAccessToken(
            overrideConfig = ({
               scope = 'https://www.googleapis.com/auth/calendar.readonly'
             })
           );

사진 표시

          client.requestAccessToken(
            overrideConfig = ({
               scope = 'https://www.googleapis.com/auth/photoslibrary.readonly'
             })
           );

requestAccessToken을 호출할 때마다 사용자 동의 순간이 트리거됩니다. 앱은 사용자가 펼치도록 선택한 섹션에 필요한 리소스에만 액세스할 수 있으므로 사용자 선택을 통해 리소스 공유가 제한됩니다.

여러 웹페이지

점진적 승인을 설계할 때는 여러 페이지를 사용하여 페이지를 로드하는 데 필요한 범위만 요청하므로 복잡성이 줄어들고 사용자 동의를 얻고 액세스 토큰을 검색하기 위해 여러 번 호출할 필요가 없습니다.

다중 페이지 앱
웹페이지 코드
페이지 1. 읽을 문서 
  const client = google.accounts.oauth2.initTokenClient({
    client_id: 'YOUR_GOOGLE_CLIENT_ID',
    callback: "onTokenResponse",
    scope: 'https://www.googleapis.com/auth/documents.readonly',
  });
  client.requestAccessToken();
페이지 2. 예정된 이벤트 
  const client = google.accounts.oauth2.initTokenClient({
    client_id: 'YOUR_GOOGLE_CLIENT_ID',
    callback: "onTokenResponse",
    scope: 'https://www.googleapis.com/auth/calendar.readonly',
  });
  client.requestAccessToken();
페이지 3. 사진 캐러셀 
  const client = google.accounts.oauth2.initTokenClient({
    client_id: 'YOUR_GOOGLE_CLIENT_ID',
    callback: "onTokenResponse",
    scope: 'https://www.googleapis.com/auth/photoslibrary.readonly',
  });
  client.requestAccessToken();

각 페이지는 로드 시 initTokenClient() 및 requestAccessToken()을 호출하여 필요한 범위를 요청하고 액세스 토큰을 가져옵니다. 이 시나리오에서는 개별 웹페이지를 사용하여 범위별로 사용자 기능과 리소스를 명확하게 구분합니다. 실제 상황에서는 개별 페이지에서 여러 관련 범위를 요청할 수 있습니다.

세분화된 권한

세분화된 권한은 모든 시나리오에서 동일한 방식으로 처리됩니다. requestAccessToken()이 콜백 함수를 호출하고 액세스 토큰이 반환된 후 hasGrantedAllScopes() 또는 hasGrantedAnyScope()를 사용하여 사용자가 요청된 범위를 승인했는지 확인합니다. 예를 들면 다음과 같습니다.

const client = google.accounts.oauth2.initTokenClient({
  client_id: 'YOUR_GOOGLE_CLIENT_ID',
  scope: 'https://www.googleapis.com/auth/calendar.readonly \
          https://www.googleapis.com/auth/documents.readonly \
          https://www.googleapis.com/auth/photoslibrary.readonly',
  callback: (tokenResponse) => {
    if (tokenResponse && tokenResponse.access_token) {
      if (google.accounts.oauth2.hasGrantedAnyScope(tokenResponse,
          'https://www.googleapis.com/auth/photoslibrary.readonly')) {
        // Look at pictures
        ...
      }
      if (google.accounts.oauth2.hasGrantedAllScopes(tokenResponse,
          'https://www.googleapis.com/auth/calendar.readonly',
          'https://www.googleapis.com/auth/documents.readonly')) {
        // Meeting planning and review documents
        ...
      }
    }
  },
});

이전 세션 또는 요청에서 이전에 수락된 모든 지원금도 응답에 포함됩니다. 사용자 동의 기록은 사용자 및 클라이언트 ID별로 유지되며 initTokenClient() 또는 requestAccessToken()에 대한 여러 호출에서 유지됩니다. 기본적으로 사용자 동의는 사용자가 웹사이트를 처음 방문하여 새 범위를 요청할 때만 필요하지만 토큰 클라이언트 구성 객체에서 prompt=consent를 사용하여 모든 페이지 로드에서 요청될 수 있습니다.

토큰 작업

토큰 모델에서는 액세스 토큰이 OS 또는 브라우저에 저장되지 않습니다. 대신 페이지 로드 시 또는 이후에 버튼 누르기와 같은 사용자 동작을 통해 requestAccessToken() 호출을 트리거하여 새 토큰을 먼저 가져옵니다.

Google API에서 REST 및 CORS 사용

액세스 토큰은 REST 및 CORS를 사용하여 Google API에 대해 인증된 요청을 하는 데 사용할 수 있습니다. 이를 통해 사용자는 로그인하고 동의를 부여하며 Google은 액세스 토큰을 발급하고 사이트는 사용자 데이터로 작업할 수 있습니다.

이 예에서는 tokenRequest()에서 반환된 액세스 토큰을 사용하여 로그인한 사용자의 예정된 캘린더 일정을 확인합니다.

var xhr = new XMLHttpRequest();
xhr.open('GET', 'https://www.googleapis.com/calendar/v3/calendars/primary/events');
xhr.setRequestHeader('Authorization', 'Bearer ' + tokenResponse.access_token);
xhr.send();

Google API는 기본적으로 CORS를 지원합니다. XMLHttpRequest 또는 fetch 요청에 액세스 토큰을 포함하면 CORS 프리플라이트 검사가 트리거됩니다. GET 또는 POST 전에 OPTIONS 요청이 발생합니다.

다음 섹션에서는 더 복잡한 API와 통합하는 방법을 다룹니다.

Google API JavaScript 라이브러리 작업

토큰 클라이언트는 JavaScript용 Google API 클라이언트 라이브러리 와 함께 작동합니다. 다음 코드 스니펫을 참고하세요.

const client = google.accounts.oauth2.initTokenClient({
  client_id: 'YOUR_GOOGLE_CLIENT_ID',
  scope: 'https://www.googleapis.com/auth/calendar.readonly',
  callback: (tokenResponse) => {
    if (tokenResponse && tokenResponse.access_token) {
      gapi.client.setApiKey('YOUR_API_KEY');
      gapi.client.load('calendar', 'v3', listUpcomingEvents);
    }
  },
});

function listUpcomingEvents() {
  gapi.client.calendar.events.list(...);
}

토큰 만료

액세스 토큰은 설계상 수명이 짧습니다. 사용자 세션이 끝나기 전에 액세스 토큰이 만료되면 버튼 누르기와 같은 사용자 중심 이벤트에서 requestAccessToken()을 호출하여 새 토큰을 가져옵니다.

google.accounts.oauth2.revoke 메서드를 호출하여 앱에 부여된 모든 범위에 대한 사용자 동의 및 리소스 액세스를 삭제합니다. 이 권한을 취소하려면 유효한 액세스 토큰이 필요합니다.

google.accounts.oauth2.revoke('414a76cb127a7ece7ee4bf287602ca2b56f8fcbf7fcecc2cd4e0509268120bd7', done => {
    console.log(done);
    console.log(done.successful);
    console.log(done.error);
    console.log(done.error_description);
  });