이 페이지는 Cloud Translation API를 통해 번역되었습니다.

웹사이트용 Google 제3자 승인 자바스크립트 라이브러리 - API 참조

이 참조에서는 Google에서 승인 코드를 로드하거나 토큰에 액세스하는 데 사용할 수 있는 Google 3P 승인 자바스크립트 라이브러리 API를 설명합니다.

메서드: google.accounts.auth2.initCodeClient

initCodeClient 메서드는 매개변수의 구성을 사용하여 코드 클라이언트를 초기화하고 반환합니다.

google.accounts.oauth2.initCodeClient(config: CodeClientConfig)

데이터 유형: CodeClientConfig

다음 표에는 CodeClientConfig 데이터 유형의 속성이 나와 있습니다.

속성
`client_id`	필수. 애플리케이션의 클라이언트 ID입니다. 이 값은 API 콘솔에서 확인할 수 있습니다.
`scope`	필수. 사용자를 대신하여 애플리케이션이 액세스할 수 있는 리소스를 식별하는 공백으로 구분된 범위의 목록입니다. 이 값은 Google이 사용자에게 표시하는 동의 화면에 알립니다.
`include_granted_scopes`	선택사항이며 기본값은 `true`입니다. 애플리케이션이 점진적 승인을 사용하여 컨텍스트에서 추가 범위에 대한 액세스를 요청할 수 있도록 합니다. 이 매개변수의 값을 `false`로 설정하고 승인 요청이 부여되면 새 액세스 토큰은 이 `CodeClientConfig`에서 `scope`가 요청한 범위만 포함합니다.
`redirect_uri`	리디렉션 UX에 필요합니다. 사용자가 승인 과정을 완료한 후 API 서버가 사용자를 리디렉션하는 위치를 결정합니다. 이 값은 API 콘솔에서 구성한 OAuth 2.0 클라이언트에 대해 승인된 리디렉션 URI 중 하나와 정확히 일치해야 하며 리디렉션 URI 유효성 검사 규칙을 준수해야 합니다. 팝업 UX에서 속성을 무시합니다.
`callback`	팝업 UX에 필요합니다. 반환된 코드 응답을 처리하는 자바스크립트 함수입니다. 리디렉션 UX에서 속성을 무시합니다.
`state`	선택사항. 리디렉션 UX에 권장됩니다. 애플리케이션이 승인 요청과 승인 서버의 응답 사이의 상태를 유지하기 위해 사용하는 문자열 값을 지정합니다.
`enable_serial_consent`	선택사항이며 기본값은 `true`입니다. `false`로 설정하면 2019년 이전에 생성된 OAuth 클라이언트 ID에 보다 세분화된 Google 계정 권한이 사용 중지됩니다. 더 세부적인 권한이 항상 사용 설정되므로 최신 OAuth 클라이언트 ID에는 영향을 미치지 않습니다.
`hint`	선택사항. 애플리케이션에서 요청을 승인해야 하는 사용자를 알고 있는 경우 이 속성을 사용하여 Google에 힌트를 제공할 수 있습니다. 대상 사용자의 이메일 주소입니다. 자세한 내용은 OpenID Connect 문서의 `login_hint` 필드를 참고하세요.
`hosted_domain`	선택사항. 애플리케이션에서 사용자가 속한 Workspace 도메인을 알고 있는 경우 이를 사용하여 Google에 힌트를 제공합니다. 자세한 내용은 OpenID Connect 문서의 `hd` 필드를 참고하세요.
`ux_mode`	선택사항. 승인 흐름에 사용할 UX 모드입니다. 기본적으로 팝업에서 동의 절차가 열립니다. 유효한 값은 `popup`, `redirect`입니다.
`select_account`	선택사항이며 기본값은 'false'입니다. 사용자에게 계정을 선택하라는 메시지를 표시하는 부울 값입니다.
`error_callback`	선택사항. 팝업 창이 열리지 않거나 OAuth 응답이 반환되기 전에 닫히는 등 OAuth가 아닌 일부 오류를 처리하는 자바스크립트 함수 입력 매개변수의 `유형` 필드에 자세한 이유가 표시됩니다. popup_failed_to_open 팝업 창을 열 수 없습니다. popup_closed OAuth 응답이 반환되기 전에 팝업 창이 닫힙니다. 알 수 없음 기타 오류의 자리표시자입니다.

데이터 유형: CodeClient

이 클래스에는 OAuth 2.0 코드 UX 흐름을 시작하는 공개 메서드 requestCode가 하나만 있습니다.

interface CodeClient {
  requestCode(): void;
}

데이터 유형: CodeResponse

CodeResponse 자바스크립트 객체가 팝업 UX의 callback 메서드에 전달됩니다. 리디렉션 UX에서 CodeResponse가 URL 매개변수로 전달됩니다.

다음 표에는 CodeResponse 데이터 유형의 속성이 나와 있습니다.

속성
`code`	성공적인 토큰 응답의 승인 코드입니다.
`scope`	사용자가 승인한 범위 목록으로 공백으로 구분됩니다.
`state`	애플리케이션이 승인 요청과 응답 사이의 상태를 유지하는 데 사용하는 문자열 값입니다.
`error`	단일 ASCII 오류 코드입니다.
`error_description`	추가 정보를 제공하는 사람이 읽을 수 있는 ASCII 텍스트로, 클라이언트 개발자가 발생한 오류를 이해하는 데 도움이 됩니다.
`error_uri`	오류에 관한 정보가 포함된 사람이 읽을 수 있는 웹페이지를 식별하는 URI로, 클라이언트 개발자에게 오류에 관한 추가 정보를 제공합니다.

메서드: google.accounts.auth2.initTokenClient

initTokenClient 메서드는 매개변수의 구성을 사용하여 토큰 클라이언트를 초기화하고 반환합니다.

google.accounts.oauth2.initTokenClient(config: TokenClientConfig)

데이터 유형: TokenClientConfig

다음 표에는 TokenClientConfig 데이터 유형의 속성이 나와 있습니다.

속성
`client_id`	필수. 애플리케이션의 클라이언트 ID입니다. 이 값은 API 콘솔에서 확인할 수 있습니다.
`callback`	필수. 반환된 토큰 응답을 처리하는 자바스크립트 함수입니다.
`scope`	필수. 사용자를 대신하여 애플리케이션이 액세스할 수 있는 리소스를 식별하는 공백으로 구분된 범위의 목록입니다. 이 값은 Google이 사용자에게 표시하는 동의 화면에 알립니다.
`include_granted_scopes`	선택사항이며 기본값은 `true`입니다. 애플리케이션이 점진적 승인을 사용하여 컨텍스트에서 추가 범위에 대한 액세스를 요청할 수 있도록 합니다. 이 매개변수의 값을 `false`로 설정하고 승인 요청이 부여되면 새 액세스 토큰은 이 `TokenClientConfig`에서 `scope`가 요청한 범위만 포함합니다.
`prompt`	선택사항이며 기본값은 'select_account'입니다. 공백으로 구분된 사용자 표시 메시지 목록입니다. 가능한 값은 다음과 같습니다. 빈 문자열: 앱에서 처음 액세스를 요청할 때만 사용자에게 메시지가 표시됩니다. 다른 값으로 지정할 수 없습니다. 'none' 인증 또는 동의 화면을 표시하지 않습니다. 다른 값으로 지정해서는 안 됩니다. 'consent': 사용자에게 동의를 요청합니다. 'select_account': 사용자에게 계정을 선택하라는 메시지를 표시합니다.
`enable_serial_consent`	선택사항이며 기본값은 `true`입니다. `false`로 설정하면 2019년 이전에 생성된 OAuth 클라이언트 ID에 보다 세분화된 Google 계정 권한이 사용 중지됩니다. 더 세부적인 권한이 항상 사용 설정되므로 최신 OAuth 클라이언트 ID에는 영향을 미치지 않습니다.
`hint`	선택사항. 애플리케이션에서 요청을 승인해야 하는 사용자를 알고 있는 경우 이 속성을 사용하여 Google에 힌트를 제공할 수 있습니다. 대상 사용자의 이메일 주소입니다. 자세한 내용은 OpenID Connect 문서의 `login_hint` 필드를 참고하세요.
`hosted_domain`	선택사항. 애플리케이션에서 사용자가 속한 Workspace 도메인을 알고 있는 경우 이를 사용하여 Google에 힌트를 제공합니다. 자세한 내용은 OpenID Connect 문서의 `hd` 필드를 참고하세요.
`state`	선택사항. 권장하지 않음 애플리케이션이 승인 요청과 승인 서버의 응답 사이의 상태를 유지하기 위해 사용하는 문자열 값을 지정합니다.
`error_callback`	선택사항. 팝업 창이 열리지 않거나 OAuth 응답이 반환되기 전에 닫히는 등 OAuth가 아닌 일부 오류를 처리하는 자바스크립트 함수 입력 매개변수의 `유형` 필드에 자세한 이유가 표시됩니다. popup_failed_to_open 팝업 창을 열 수 없습니다. popup_closed OAuth 응답이 반환되기 전에 팝업 창이 닫힙니다. 알 수 없음 기타 오류의 자리표시자입니다.

데이터 유형: TokenClient

이 클래스에는 OAuth 2.0 토큰 UX 흐름을 시작하는 공개 메서드 requestAccessToken가 하나만 있습니다.

interface TokenClient {
  requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}

인수
`overrideConfig`	재정의 가능한 토큰 클라이언트 구성	선택사항. 이 메서드에서 재정의할 구성입니다.

데이터 유형: OverridableTokenClientConfig

다음 표에는 OverridableTokenClientConfig 데이터 유형의 속성이 나와 있습니다.

속성
`scope`	선택사항. 사용자를 대신하여 애플리케이션이 액세스할 수 있는 리소스를 식별하는 공백으로 구분된 범위 목록입니다. 이 값은 Google이 사용자에게 표시하는 동의 화면에 알립니다.
`include_granted_scopes`	선택사항이며 기본값은 `true`입니다. 애플리케이션이 점진적 승인을 사용하여 컨텍스트에서 추가 범위에 대한 액세스를 요청할 수 있도록 합니다. 이 매개변수의 값을 `false`로 설정하고 승인 요청이 부여되면 새 액세스 토큰은 이 `OverridableTokenClientConfig`에서 `scope`가 요청한 범위만 포함합니다.
`prompt`	선택사항. 사용자에게 표시할 메시지(공백으로 구분된) 목록입니다.
`enable_serial_consent`	선택사항이며 기본값은 `true`입니다. `false`로 설정하면 2019년 이전에 생성된 OAuth 클라이언트 ID에 보다 세분화된 Google 계정 권한이 사용 중지됩니다. 더 세부적인 권한이 항상 사용 설정되므로 최신 OAuth 클라이언트 ID에는 영향을 미치지 않습니다.
`hint`	선택사항. 애플리케이션에서 요청을 승인해야 하는 사용자를 알고 있는 경우 이 속성을 사용하여 Google에 힌트를 제공할 수 있습니다. 대상 사용자의 이메일 주소입니다. 자세한 내용은 OpenID Connect 문서의 `login_hint` 필드를 참고하세요.
`state`	선택사항. 권장하지 않음 애플리케이션이 승인 요청과 승인 서버의 응답 사이의 상태를 유지하기 위해 사용하는 문자열 값을 지정합니다.

데이터 유형: TokenResponse

TokenResponse 자바스크립트 객체가 팝업 UX의 콜백 메서드에 전달됩니다.

다음 표에는 TokenResponse 데이터 유형의 속성이 나와 있습니다.

속성
`access_token`	성공적인 토큰 응답의 액세스 토큰입니다.
`expires_in`	액세스 토큰의 전체 기간(초)입니다.
`hd`	로그인한 사용자가 속한 호스트 도메인입니다.
`prompt`	TokenClientConfig 또는 OverridableTokenClientConfig에서 지정한 가능한 값 목록에서 사용된 프롬프트 값입니다.
`token_type`	발급된 토큰 유형입니다.
`scope`	사용자가 승인한 범위 목록으로 공백으로 구분됩니다.
`state`	애플리케이션이 승인 요청과 응답 사이의 상태를 유지하는 데 사용하는 문자열 값입니다.
`error`	단일 ASCII 오류 코드입니다.
`error_description`	추가 정보를 제공하는 사람이 읽을 수 있는 ASCII 텍스트입니다. 클라이언트 개발자가 발생한 오류를 이해하는 데 도움이 됩니다.
`error_uri`	오류에 관한 정보가 포함된 사람이 읽을 수 있는 웹페이지를 식별하는 URI로, 클라이언트 개발자에게 오류에 관한 추가 정보를 제공합니다.

메서드: google.accounts.auth2.hasGrantedAllScopes

사용자가 지정된 범위를 모두 부여했는지 확인합니다.

google.accounts.oauth2.hasGrantedAllScopes(
                                            tokenResponse: TokenResponse,
                                            firstScope: string, ...restScopes: string[]
                                          ): boolean;

인수
`tokenResponse`	`TokenResponse`	필수. `TokenResponse` 객체
`firstScope`	문자열	필수. 확인할 범위입니다.
`restScopes`	문자열[]	선택사항. 확인할 다른 범위입니다.

반환 값
boolean	모든 범위가 부여된 경우 true입니다.

메서드: google.accounts.auth2.hasGrantedAnyScope

사용자가 지정된 범위 중 하나를 부여했는지 확인합니다.

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;

인수
`tokenResponse`	`TokenResponse`	필수. `TokenResponse` 객체
`firstScope`	문자열	필수. 확인할 범위입니다.
`restScopes`	문자열[]	선택사항. 확인할 다른 범위입니다.

반환 값
boolean	부여된 범위가 하나라도 있는 경우 true입니다.

메서드: google.accounts.auth2.revoke

revoke 메서드는 사용자가 앱에 부여한 모든 범위를 취소합니다. 권한을 취소하려면 유효한 액세스 토큰이 필요합니다.

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;

인수
`accessToken`	문자열	필수. 유효한 액세스 토큰입니다.
`done`	함수	선택사항. 취소 작업이 완료되면 콜백 함수