browser.identity

설명

chrome.identity API를 사용하여 OAuth2 액세스 토큰을 가져옵니다.

권한

identity

유형

AccountInfo

속성

• id

  문자열

  계정의 고유 식별자입니다. 이 ID는 계정의 전체 기간 동안 변경되지 않습니다.

AccountStatus

Chrome 84 이상 Chrome 148 이후 browser.*

열거형

'SYNC'
기본 계정에 동기화가 사용 설정되어 있음을 지정합니다.

'ANY'
기본 계정이 있는 경우 기본 계정의 존재를 지정합니다.

GetAuthTokenResult

Chrome 105 이상 브라우저.*(Chrome 148부터)

속성

• grantedScopes

  string[] 선택사항

  확장 프로그램에 부여된 OAuth2 범위 목록입니다.

• 토큰

  문자열 선택사항

  요청과 연결된 특정 토큰입니다.

InvalidTokenDetails

속성

• 토큰

  문자열

  캐시에서 삭제해야 하는 특정 토큰입니다.

ProfileDetails

Chrome 84 이상 Chrome 148 이후 browser.*

속성

• accountStatus

  AccountStatus 선택사항

  ProfileUserInfo를 반환해야 하는 프로필에 로그인한 기본 계정의 상태입니다. 기본값은 SYNC 계정 상태입니다.

ProfileUserInfo

속성

• 이메일

  문자열

  현재 프로필에 로그인한 사용자 계정의 이메일 주소입니다. 사용자가 로그인하지 않았거나 identity.email 매니페스트 권한이 지정되지 않은 경우 비어 있습니다.

• id

  문자열

  계정의 고유 식별자입니다. 이 ID는 계정의 전체 기간 동안 변경되지 않습니다. 사용자가 로그인하지 않았거나 (M41 이상에서) identity.email 매니페스트 권한이 지정되지 않은 경우 비어 있습니다.

TokenDetails

속성

• 계정

  AccountInfo 선택사항

  토큰을 반환할 계정 ID입니다. 지정하지 않으면 함수는 Chrome 프로필의 계정(동기화 계정이 있는 경우 동기화 계정, 없는 경우 첫 번째 Google 웹 계정)을 사용합니다.

• enableGranularPermissions

  불리언 선택사항

  Chrome 87 이상 browser.*(Chrome 148부터)

  enableGranularPermissions 플래그를 사용하면 확장 프로그램이 세분화된 권한 동의 화면을 조기에 선택할 수 있으며, 이 화면에서 요청된 권한이 개별적으로 부여되거나 거부됩니다.

• 양방향

  불리언 선택사항

  토큰을 가져오려면 사용자가 Chrome에 로그인하거나 애플리케이션에서 요청한 범위를 승인해야 할 수 있습니다. 대화형 플래그가 true이면 getAuthToken는 필요에 따라 사용자에게 메시지를 표시합니다. 플래그가 false이거나 생략된 경우 getAuthToken는 메시지가 필요할 때마다 실패를 반환합니다.

• 범위

  string[] 선택사항

  요청할 OAuth2 범위 목록입니다.

  scopes 필드가 있으면 manifest.json에 지정된 범위 목록을 재정의합니다.

WebAuthFlowDetails

속성

• abortOnLoadForNonInteractive

  불리언 선택사항

  Chrome 113 이상 Chrome 148 이후 browser.*

  페이지 로드 후 비대화형 요청에 대해 launchWebAuthFlow를 종료할지 여부입니다. 이 파라미터는 대화형 흐름에 영향을 미치지 않습니다.

  true (기본값)로 설정하면 페이지가 로드된 직후 흐름이 종료됩니다. false로 설정하면 timeoutMsForNonInteractive가 지난 후에만 흐름이 종료됩니다. 이는 JavaScript를 사용하여 페이지 로드 후 리디렉션을 실행하는 ID 공급업체에 유용합니다.

• 양방향

  불리언 선택사항

  대화형 모드에서 인증 흐름을 실행할지 여부입니다.

  일부 인증 흐름은 결과 URL로 즉시 리디렉션될 수 있으므로 launchWebAuthFlow는 첫 번째 탐색이 최종 URL로 리디렉션되거나 표시할 페이지 로드가 완료될 때까지 웹 보기를 숨깁니다.

  interactive 플래그가 true이면 페이지 로드가 완료될 때 창이 표시됩니다. 플래그가 false이거나 생략된 경우 초기 탐색에서 흐름을 완료하지 않으면 launchWebAuthFlow에서 오류가 반환됩니다.

  리디렉션에 JavaScript를 사용하는 흐름의 경우 abortOnLoadForNonInteractive를 false로 설정하고 timeoutMsForNonInteractive를 설정하여 페이지에서 리디렉션을 실행할 수 있습니다.

• timeoutMsForNonInteractive

  number 선택사항

  Chrome 113 이상 Chrome 148 이후 browser.*

  launchWebAuthFlow가 비대화형 모드에서 실행될 수 있는 최대 시간(밀리초)입니다. interactive가 false인 경우에만 적용됩니다.

• URL

  문자열

  인증 흐름을 시작하는 URL입니다.

메서드

clearAllCachedAuthTokens()

Chrome 87 이상 browser.*(Chrome 148부터)

browser.identity.clearAllCachedAuthTokens(): Promise<void>

Identity API의 상태를 재설정합니다.

• 토큰 캐시에서 모든 OAuth2 액세스 토큰을 삭제합니다.
• 사용자의 계정 환경설정 삭제
• 모든 인증 흐름에서 사용자의 승인을 취소합니다.

반환 값

• 약속<void>

  Chrome 106 이상 Chrome 148 이후의 browser.*

  상태가 삭제되면 결정되는 프로미스를 반환합니다.

getAccounts()

개발자 채널

browser.identity.getAccounts(): Promise<AccountInfo[]>

프로필에 있는 계정을 설명하는 AccountInfo 객체 목록을 가져옵니다.

getAccounts은 개발자 채널에서만 지원됩니다.

반환 값

• Promise<AccountInfo[]>

getAuthToken()

browser.identity.getAuthToken(
  details?: TokenDetails,
): Promise<GetAuthTokenResult>

manifest.json의 oauth2 섹션에 지정된 클라이언트 ID와 범위를 사용하여 OAuth2 액세스 토큰을 가져옵니다.

Identity API는 메모리에 액세스 토큰을 캐시하므로 토큰이 필요할 때마다 비대화형으로 getAuthToken를 호출해도 됩니다. 토큰 캐시는 만료를 자동으로 처리합니다.

좋은 사용자 환경을 제공하려면 승인의 목적을 설명하는 앱의 UI에서 대화형 토큰 요청을 시작하는 것이 중요합니다. 이렇게 하지 않으면 사용자에게 승인 요청이 표시되거나, 로그인하지 않은 경우 맥락 없이 Chrome 로그인 화면이 표시됩니다. 특히 앱이 처음 실행될 때 getAuthToken를 대화형으로 사용하지 마세요.

참고: 콜백과 함께 호출되면 이 함수는 객체를 반환하는 대신 콜백에 전달된 별도의 인수로 두 속성을 반환합니다.

매개변수

• 세부정보

  TokenDetails 선택사항

  토큰 옵션입니다.

반환 값

• Promise<GetAuthTokenResult>

  Chrome 105 이상 브라우저.*(Chrome 148부터)

  매니페스트에 지정된 OAuth2 액세스 토큰으로 확인되는 프로미스를 반환하거나 오류가 있는 경우 거부합니다. grantedScopes 매개변수는 Chrome 87부터 채워집니다. 사용 가능한 경우 이 매개변수에는 반환된 토큰에 해당하는 부여된 범위 목록이 포함됩니다.

getProfileUserInfo()

browser.identity.getProfileUserInfo(
  details?: ProfileDetails,
): Promise<ProfileUserInfo>

프로필에 로그인한 사용자의 이메일 주소와 난독화된 Gaia ID를 가져옵니다.

identity.email 매니페스트 권한이 필요합니다. 그렇지 않으면 빈 결과를 반환합니다.

이 API는 두 가지 측면에서 identity.getAccounts와 다릅니다. 반환되는 정보는 오프라인에서 사용할 수 있으며 프로필의 기본 계정에만 적용됩니다.

매개변수

• 세부정보

  ProfileDetails 선택사항

  Chrome 84 이상 Chrome 148 이후 browser.*

  프로필 옵션

반환 값

• Promise<ProfileUserInfo>

  Chrome 106 이상 Chrome 148 이후의 browser.*

  기본 Chrome 계정의 ProfileUserInfo로 확인되는 프로미스를 반환하거나, 지정된 details가 있는 계정이 존재하지 않는 경우 빈 ProfileUserInfo를 반환합니다.

getRedirectURL()

browser.identity.getRedirectURL(
  path?: string,
): string

launchWebAuthFlow에서 사용할 리디렉션 URL을 생성합니다.

생성된 URL은 https://<app-id>.chromiumapp.org/* 패턴과 일치합니다.

매개변수

• 경로

  문자열 선택사항

  생성된 URL 끝에 추가되는 경로입니다.

반환 값

• 문자열

launchWebAuthFlow()

browser.identity.launchWebAuthFlow(
  details: WebAuthFlowDetails,
): Promise<string | undefined>

지정된 URL에서 인증 흐름을 시작합니다.

이 메서드는 웹 보기를 실행하고 제공업체의 인증 흐름에서 첫 번째 URL로 이동하여 Google 이외의 ID 공급업체에서 인증 흐름을 사용 설정합니다. 제공업체가 https://<app-id>.chromiumapp.org/* 패턴과 일치하는 URL로 리디렉션하면 창이 닫히고 최종 리디렉션 URL이 callback 함수에 전달됩니다.

좋은 사용자 환경을 제공하려면 승인의 목적을 설명하는 앱의 UI에서 대화형 승인 흐름을 시작하는 것이 중요합니다. 이렇게 하지 않으면 사용자에게 맥락이 없는 승인 요청이 표시됩니다. 특히 앱이 처음 실행될 때 대화형 인증 흐름을 실행하지 마세요.

매개변수

• 세부정보

  WebAuthFlowDetails

  WebAuth 흐름 옵션입니다.

반환 값

• Promise<string | undefined>

  Chrome 106 이상 Chrome 148 이후의 browser.*

  애플리케이션으로 다시 리디렉션된 URL로 확인되는 프로미스를 반환합니다.

removeCachedAuthToken()

browser.identity.removeCachedAuthToken(
  details: InvalidTokenDetails,
): Promise<void>

Identity API의 토큰 캐시에서 OAuth2 액세스 토큰을 삭제합니다.

액세스 토큰이 잘못된 것으로 확인되면 removeCachedAuthToken에 전달하여 캐시에서 삭제해야 합니다. 그러면 앱이 getAuthToken를 사용하여 새 토큰을 가져올 수 있습니다.

매개변수

• 세부정보

  InvalidTokenDetails

  토큰 정보입니다.

반환 값

• 약속<void>

  Chrome 106 이상 Chrome 148 이후의 browser.*

  토큰이 캐시에서 삭제되면 확인되는 프로미스를 반환합니다.

이벤트

onSignInChanged

browser.identity.onSignInChanged.addListener(
  callback: function,
)

사용자 프로필에 있는 계정의 로그인 상태가 변경될 때 실행됩니다.

매개변수

• callback

  함수

  callback 매개변수는 다음과 같습니다.

  (account: AccountInfo, signedIn: boolean) => void

  • 계정

    AccountInfo

  • signedIn

    부울