chrome.identity

Deskripsi

Gunakan chrome.identity API untuk mendapatkan token akses OAuth2.

Izin

identity

Jenis

AccountInfo

Properti

  • id

    string

    ID unik untuk akun. ID ini tidak akan berubah selama masa aktif akun.

AccountStatus

Chrome 84+

Enum

"SYNC"
Menentukan bahwa Sinkronisasi diaktifkan untuk akun utama.

"ANY"
Menentukan keberadaan akun utama, jika ada.

GetAuthTokenResult

Chrome 105+

Properti

  • grantedScopes

    string[] opsional

    Daftar cakupan OAuth2 yang diberikan ke ekstensi.

  • token

    string opsional

    Token tertentu yang terkait dengan permintaan.

InvalidTokenDetails

Properti

  • token

    string

    Token tertentu yang harus dihapus dari cache.

ProfileDetails

Chrome 84+

Properti

  • accountStatus

    AccountStatus opsional

    Status akun utama yang login ke profil yang ProfileUserInfo-nya harus ditampilkan. Default-nya adalah status akun SYNC.

ProfileUserInfo

Properti

  • email

    string

    Alamat email untuk akun pengguna yang login ke profil saat ini. Kosong jika pengguna tidak login atau izin manifes identity.email tidak ditentukan.

  • id

    string

    ID unik untuk akun. ID ini tidak akan berubah selama masa aktif akun. Kosong jika pengguna tidak login atau (di M41+) izin manifes identity.email tidak ditentukan.

TokenDetails

Properti

  • akun

    AccountInfo opsional

    ID akun yang tokennya harus ditampilkan. Jika tidak ditentukan, fungsi akan menggunakan akun dari profil Chrome: akun Sinkronisasi jika ada, atau akun web Google pertama jika tidak ada.

  • enableGranularPermissions

    boolean opsional

    Chrome 87+

    Dengan tanda enableGranularPermissions, ekstensi dapat memilih untuk menggunakan layar izin izin terperinci lebih awal, yang memungkinkan izin yang diminta diberikan atau ditolak satu per satu.

  • interaktif

    boolean opsional

    Pengambilan token mungkin mengharuskan pengguna login ke Chrome, atau menyetujui cakupan yang diminta aplikasi. Jika tanda interaktif adalah true, getAuthToken akan meminta pengguna sesuai kebutuhan. Jika tanda adalah false atau tidak ada, getAuthToken akan menampilkan kegagalan setiap kali perintah diperlukan.

  • cakupan

    string[] opsional

    Daftar cakupan OAuth2 yang akan diminta.

    Jika ada, kolom scopes akan menggantikan daftar cakupan yang ditentukan dalam manifest.json.

WebAuthFlowDetails

Properti

  • abortOnLoadForNonInteractive

    boolean opsional

    Chrome 113+

    Apakah akan menghentikan launchWebAuthFlow untuk permintaan non-interaktif setelah halaman dimuat. Parameter ini tidak memengaruhi alur interaktif.

    Jika disetel ke true (default), alur akan segera dihentikan setelah halaman dimuat. Jika disetel ke false, alur hanya akan berakhir setelah timeoutMsForNonInteractive berlalu. Hal ini berguna untuk penyedia identitas yang menggunakan JavaScript untuk melakukan pengalihan setelah halaman dimuat.

  • interaktif

    boolean opsional

    Apakah akan meluncurkan alur autentikasi dalam mode interaktif.

    Karena beberapa alur autentikasi dapat langsung mengalihkan ke URL hasil, launchWebAuthFlow menyembunyikan tampilan webnya hingga navigasi pertama mengalihkan ke URL akhir, atau selesai memuat halaman yang akan ditampilkan.

    Jika tanda interactive adalah true, jendela akan ditampilkan saat pemuatan halaman selesai. Jika tanda adalah false atau tidak ada, launchWebAuthFlow akan menampilkan error jika navigasi awal tidak menyelesaikan alur.

    Untuk alur yang menggunakan JavaScript untuk pengalihan, abortOnLoadForNonInteractive dapat disetel ke false bersama dengan setelan timeoutMsForNonInteractive untuk memberi halaman kesempatan melakukan pengalihan.

  • timeoutMsForNonInteractive

    nomor opsional

    Chrome 113+

    Jumlah waktu maksimum, dalam milidetik, launchWebAuthFlow diizinkan untuk berjalan dalam mode non-interaktif secara total. Hanya berpengaruh jika interactive adalah false.

  • url

    string

    URL yang memulai alur autentikasi.

Metode

clearAllCachedAuthTokens()

Chrome 87+ 
chrome.identity.clearAllCachedAuthTokens(): Promise<void>

Mereset status Identity API:

  • Menghapus semua token akses OAuth2 dari cache token
  • Menghapus preferensi akun pengguna
  • Membatalkan otorisasi pengguna dari semua alur autentikasi

Hasil

  • Promise<void>

    Chrome 106+

getAccounts()

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

Mengambil daftar objek AccountInfo yang menjelaskan akun yang ada di profil.

getAccounts hanya didukung di saluran dev.

Hasil

getAuthToken()

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

Mendapatkan token akses OAuth2 menggunakan client ID dan cakupan yang ditentukan di bagian oauth2 dari manifest.json.

Identity API menyimpan token akses dalam cache di memori, sehingga Anda dapat memanggil getAuthToken secara non-interaktif kapan saja saat token diperlukan. Cache token otomatis menangani masa berlaku token.

Untuk pengalaman pengguna yang baik, permintaan token interaktif yang dimulai oleh UI di aplikasi Anda harus menjelaskan tujuan otorisasi. Jika hal ini tidak dilakukan, pengguna Anda akan mendapatkan permintaan otorisasi, atau layar login Chrome jika mereka tidak login, tanpa konteks. Khususnya, jangan gunakan getAuthToken secara interaktif saat aplikasi Anda pertama kali diluncurkan.

Catatan: Saat dipanggil dengan callback, alih-alih menampilkan objek, fungsi ini akan menampilkan dua properti sebagai argumen terpisah yang diteruskan ke callback.

Parameter

Hasil

getProfileUserInfo()

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

Mengambil alamat email dan ID gaia yang di-obfuscate dari pengguna yang login ke profil.

Memerlukan izin manifes identity.email. Jika tidak, akan menampilkan hasil kosong.

API ini berbeda dengan identity.getAccounts dalam dua hal. Informasi yang ditampilkan tersedia secara offline, dan hanya berlaku untuk akun utama profil.

Parameter

Hasil

getRedirectURL()

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

Membuat URL pengalihan untuk digunakan di launchWebAuthFlow.

URL yang dihasilkan cocok dengan pola https://<app-id>.chromiumapp.org/*.

Parameter

  • jalur

    string opsional

    Jalur yang ditambahkan ke bagian akhir URL yang dibuat.

Hasil

  • string

launchWebAuthFlow()

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

Memulai alur autentikasi di URL yang ditentukan.

Metode ini memungkinkan alur autentikasi dengan penyedia identitas non-Google dengan meluncurkan tampilan web dan mengarahkannya ke URL pertama dalam alur autentikasi penyedia. Saat penyedia mengalihkan ke URL yang cocok dengan pola https://<app-id>.chromiumapp.org/*, jendela akan ditutup, dan URL pengalihan akhir akan diteruskan ke fungsi callback.

Untuk memberikan pengalaman pengguna yang baik, alur autentikasi interaktif yang dimulai oleh UI di aplikasi Anda yang menjelaskan tujuan otorisasi sangatlah penting. Jika hal ini tidak dilakukan, pengguna Anda akan mendapatkan permintaan otorisasi tanpa konteks. Khususnya, jangan luncurkan alur autentikasi interaktif saat aplikasi Anda diluncurkan pertama kali.

Parameter

Hasil

  • Promise<string | undefined>

    Chrome 106+

removeCachedAuthToken()

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

Menghapus token akses OAuth2 dari cache token Identity API.

Jika token akses diketahui tidak valid, token tersebut harus diteruskan ke removeCachedAuthToken untuk menghapusnya dari cache. Aplikasi kemudian dapat mengambil token baru dengan getAuthToken.

Parameter

Hasil

  • Promise<void>

    Chrome 106+

Acara

onSignInChanged

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

Dipicu saat status login berubah untuk akun di profil pengguna.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

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