chrome.identity (original) (raw)

Przejdź do głównej treści

• Dokumenty

  • Przegląd
  • Rozpocznij
  • Rozwój współpracy
  • Poradniki
  • AI
  • Materiały referencyjne
  • Sample
  • Chrome Web Store

• Studia przypadków

• Blog

• Nowości w Chrome

• Manifest V3

• ➡ Manifest V2

• accessibilityFeatures

• action

• alarms

• audio

• bookmarks

• browsingData

• certificateProvider

• commands

• contentSettings

• contextMenus

• cookies

• debugger

• declarativeContent

• declarativeNetRequest

• desktopCapture

• devtools.inspectedWindow

• devtools.network

• devtools.panels

• devtools.performance

• devtools.recorder

• dns

• documentScan

• dom

• downloads

• enterprise.deviceAttributes

• enterprise.hardwarePlatform

• enterprise.login

• enterprise.networkingAttributes

• enterprise.platformKeys

• events

• extension

• extensionTypes

• fileBrowserHandler

• fileSystemProvider

• fontSettings

• gcm

• history

• i18n

• identity

• idle

• input.ime

• instanceID

• loginState

• management

• notifications

• offscreen

• omnibox

• pageCapture

• permissions

• platformKeys

• power

• printerProvider

• printing

• printingMetrics

• privacy

• processes

• proxy

• readingList

• runtime

• scripting

• search

• sessions

• sidePanel

• storage

• system.cpu

• system.display

• system.memory

• system.storage

• systemLog

• tabCapture

• tabGroups

• tabs

• topSites

• tts

• ttsEngine

• types

• userScripts

• vpnProvider

• wallpaper

• webAuthenticationProxy

• webNavigation

• webRequest

• windows

chrome.identity

Opis

Użyj interfejsu chrome.identity API, aby uzyskać tokeny dostępu OAuth2.

Uprawnienia

identity

Typy

AccountInfo

Właściwości

• Unikalny identyfikator konta. Ten identyfikator nie zmieni się przez cały okres istnienia konta.

AccountStatus

Typ wyliczeniowy

„SYNC”
Określa, że synchronizacja jest włączona na koncie głównym.

„ANY”
Określa, czy istnieje konto podstawowe.

GetAuthTokenResult

Właściwości

• grantedScopes
  string[] opcjonalne
  Lista zakresów OAuth 2.0 przyznanych rozszerzeniu.
• Konkretny token powiązany z żądaniem.

InvalidTokenDetails

Właściwości

• Konkretny token, który należy usunąć z pamięci podręcznej.

ProfileDetails

Właściwości

• accountStatus
  AccountStatus opcjonalny
  Stan konta głównego zalogowanego w profilu, którego ProfileUserInfo powinien zostać zwrócony. Domyślna wartość to stan konta SYNC.

ProfileUserInfo

Właściwości

• Adres e-mail konta użytkownika zalogowanego w bieżącym profilu. Puste, jeśli użytkownik nie jest zalogowany lub nie określono uprawnienia identity.email w pliku manifestu.
• Unikalny identyfikator konta. Ten identyfikator nie zmieni się przez cały okres istnienia konta. Puste, jeśli użytkownik nie jest zalogowany lub (w przypadku M41+) nie określono uprawnienia identity.email w pliku manifestu.

TokenDetails

Właściwości

• konto
  AccountInfo opcjonalnie
  Identyfikator konta, dla którego ma zostać zwrócony token. Jeśli nie zostanie podane, funkcja użyje konta z profilu Chrome: konta synchronizacji, jeśli takie istnieje, lub pierwszego konta Google w internecie.
• enableGranularPermissions
  wartość logiczna opcjonalna
  Chrome w wersji 87 lub nowszej
  Flaga enableGranularPermissions umożliwia rozszerzeniom wcześniejsze włączenie ekranu zgody na szczegółowe uprawnienia, na którym można przyznawać lub odrzucać poszczególne żądane uprawnienia.
• interaktywny
  wartość logiczna opcjonalna
  Pobranie tokena może wymagać zalogowania się użytkownika w Chrome lub zatwierdzenia przez niego zakresów żądanych przez aplikację. Jeśli flaga interaktywności ma wartość true, getAuthToken wyświetli użytkownikowi odpowiedni komunikat. Gdy flaga ma wartość false lub jest pominięta, funkcja getAuthToken zwraca błąd za każdym razem, gdy wymagany jest prompt.
• zakresy
  string[] opcjonalne
  Lista zakresów OAuth 2.0, o które należy poprosić.
  Jeśli pole scopes jest obecne, zastępuje listę zakresów podaną w pliku manifest.json.

WebAuthFlowDetails

Właściwości

• abortOnLoadForNonInteractive
  wartość logiczna opcjonalna
  Określa, czy w przypadku żądań nieinteraktywnych należy zakończyć launchWebAuthFlow po wczytaniu strony. Ten parametr nie ma wpływu na interaktywne procesy.
  Gdy ta opcja jest ustawiona na true (domyślnie), przepływ kończy się natychmiast po załadowaniu strony. Jeśli ustawisz wartość false, proces zakończy się dopiero po upłynięciu czasu timeoutMsForNonInteractive. Jest to przydatne w przypadku dostawców tożsamości, którzy używają JavaScriptu do przekierowywania po wczytaniu strony.
• interaktywny
  wartość logiczna opcjonalna
  Określa, czy proces autoryzacji ma być uruchamiany w trybie interaktywnym.
  Niektóre procesy uwierzytelniania mogą od razu przekierowywać do adresu URL wyniku, dlatego launchWebAuthFlow ukrywa widok internetowy do momentu, gdy pierwsze przekierowanie nastąpi do końcowego adresu URL lub gdy zakończy się ładowanie strony, która ma być wyświetlana.
  Jeśli flaga interactive ma wartość true, okno będzie wyświetlane po załadowaniu strony. Jeśli flaga ma wartość false lub jest pominięta, funkcja launchWebAuthFlow zwróci błąd, jeśli początkowa nawigacja nie zakończy przepływu.
  W przypadku przepływów, które używają JavaScriptu do przekierowania, wartość parametru abortOnLoadForNonInteractive można ustawić na false w połączeniu z ustawieniem parametru timeoutMsForNonInteractive, aby umożliwić stronie wykonanie przekierowań.
• timeoutMsForNonInteractive
  number opcjonalny
  Maksymalny łączny czas (w milisekundach), przez jaki launchWebAuthFlow może działać w trybie nieinteraktywnym. Działa tylko wtedy, gdy zasada interactive ma wartość false.
• Adres URL, który rozpoczyna proces autoryzacji.

Metody

clearAllCachedAuthTokens()

Chrome w wersji 87 lub nowszej

chrome.identity.clearAllCachedAuthTokens(): Promise

Resetuje stan interfejsu Identity API:

• Usuwa z pamięci podręcznej tokenów wszystkie tokeny dostępu OAuth2.
• Usuwa ustawienia konta użytkownika
• Cofanie autoryzacji użytkownika we wszystkich procesach uwierzytelniania

Zwroty

getAccounts()

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

Pobiera listę obiektów AccountInfo opisujących konta w profilu.

Atrybut getAccounts jest obsługiwany tylko w wersji deweloperskiej.

Zwroty

getAuthToken()

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

Pobiera token dostępu OAuth2, używając identyfikatora klienta i zakresów określonych w sekcji oauth2 pliku manifest.json.

Interfejs Identity API buforuje tokeny dostępu w pamięci, więc można wywoływać getAuthToken w sposób nieinteraktywny za każdym razem, gdy jest potrzebny token. Pamięć podręczna tokenów automatycznie obsługuje wygasanie.

Aby zapewnić użytkownikom wygodę, ważne jest, aby żądania interaktywnych tokenów były inicjowane przez interfejs w aplikacji, który wyjaśnia, do czego służy autoryzacja. Jeśli tego nie zrobisz, użytkownicy będą otrzymywać prośby o autoryzację lub ekrany logowania w Chrome (jeśli nie są zalogowani) bez kontekstu. W szczególności nie używaj funkcji getAuthToken interaktywnie przy pierwszym uruchomieniu aplikacji.

Uwaga: jeśli funkcja jest wywoływana z wywołaniem zwrotnym, zamiast zwracać obiekt, zwraca 2 właściwości jako osobne argumenty przekazywane do wywołania zwrotnego.

Parametry

• szczegóły
  TokenDetails opcjonalny
  Opcje tokena.

Zwroty

• Promise<GetAuthTokenResult>

getProfileUserInfo()

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

Pobiera adres e-mail i zaciemniony identyfikator Gaia użytkownika zalogowanego w profilu.

Wymaga uprawnienia identity.email w pliku manifestu. W przeciwnym razie zwraca pusty wynik.

Ten interfejs API różni się od interfejsu identity.getAccounts na 2 sposoby. Zwrócone informacje są dostępne offline i dotyczą tylko konta głównego w profilu.

Parametry

• szczegóły
  ProfileDetails opcjonalnie
  Opcje profilu.

Zwroty

getRedirectURL()

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

Generuje przekierowanie do użycia w zmiennej launchWebAuthFlow.

Wygenerowane adresy URL pasują do wzorca https://<app-id>.chromiumapp.org/*.

Parametry

• ścieżka
  string opcjonalny
  Ścieżka dołączana na końcu wygenerowanego adresu URL.

Zwroty

launchWebAuthFlow()

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

Rozpoczyna proces uwierzytelniania pod określonym adresem URL.

Ta metoda umożliwia przepływy uwierzytelniania z użyciem dostawców tożsamości innych niż Google. W tym celu uruchamia widok internetowy i przekierowuje go do pierwszego adresu URL w przepływie uwierzytelniania dostawcy. Gdy dostawca przekieruje użytkownika na adres URL pasujący do wzorca https://<app-id>.chromiumapp.org/*, okno zostanie zamknięte, a ostateczny adres URL przekierowania zostanie przekazany do funkcji callback.

Aby zapewnić użytkownikom wygodę, ważne jest, aby interaktywne procesy uwierzytelniania były inicjowane przez interfejs w aplikacji, który wyjaśnia, do czego służy autoryzacja. Jeśli tego nie zrobisz, użytkownicy będą otrzymywać prośby o autoryzację bez kontekstu. W szczególności nie uruchamiaj interaktywnego procesu uwierzytelniania przy pierwszym uruchomieniu aplikacji.

Parametry

• Opcje procedury WebAuth.

Zwroty

• Promise<string | undefined>

removeCachedAuthToken()

chrome.identity.removeCachedAuthToken(
  details: InvalidTokenDetails,
): Promise

Usuwa token dostępu OAuth2 z pamięci podręcznej tokenów interfejsu API tożsamości.

Jeśli token dostępu okaże się nieprawidłowy, należy przekazać go do funkcji removeCachedAuthToken, aby usunąć go z pamięci podręcznej. Aplikacja może wtedy pobrać nowy token z parametrem getAuthToken.

Parametry

• Informacje o tokenie.

Zwroty

Wydarzenia

onSignInChanged

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

Wyzwalane, gdy stan logowania konta w profilu użytkownika ulegnie zmianie.

Parametry

• Parametr callback wygląda tak:
  (account: AccountInfo, signedIn: boolean) => void
  • signedIn
    Wartość logiczna

O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.

Ostatnia aktualizacja: 2025-08-11 UTC.