chrome.identity

Description

Utilisez l'API chrome.identity pour obtenir des jetons d'accès OAuth2.

Autorisations

identity

Types

AccountInfo

Propriétés

  • id

    chaîne

    Identifiant unique du compte. Cet ID ne changera pas pendant toute la durée de vie du compte.

AccountStatus

Chrome 84 et versions ultérieures

Énumération

"SYNC"
Indique que la synchronisation est activée pour le compte principal.

"ANY"
Spécifie l'existence d'un compte principal, le cas échéant.

GetAuthTokenResult

Chrome 105 et versions ultérieures

Propriétés

  • grantedScopes

    string[] facultatif

    Liste des champs d'application OAuth2 accordés à l'extension.

  • jeton

    chaîne facultative

    Jeton spécifique associé à la requête.

InvalidTokenDetails

Propriétés

  • jeton

    chaîne

    Jeton spécifique à supprimer du cache.

ProfileDetails

Chrome 84 et versions ultérieures

Propriétés

  • accountStatus

    AccountStatus facultatif

    État du compte principal connecté à un profil dont le ProfileUserInfo doit être renvoyé. La valeur par défaut est l'état du compte SYNC.

ProfileUserInfo

Propriétés

  • e-mail

    chaîne

    Adresse e-mail du compte utilisateur connecté au profil actuel. Vide si l'utilisateur n'est pas connecté ou si l'autorisation du fichier manifeste identity.email n'est pas spécifiée.

  • id

    chaîne

    Identifiant unique du compte. Cet ID ne changera pas pendant toute la durée de vie du compte. Vide si l'utilisateur n'est pas connecté ou (dans M41+) si l'autorisation de fichier manifeste identity.email n'est pas spécifiée.

TokenDetails

Propriétés

  • compte

    AccountInfo facultatif

    Numéro du compte dont le jeton doit être renvoyé. Si aucun compte n'est spécifié, la fonction utilise un compte du profil Chrome : le compte de synchronisation, s'il existe, ou le premier compte Web Google.

  • enableGranularPermissions

    booléen facultatif

    Chrome 87 et versions ultérieures

    L'indicateur enableGranularPermissions permet aux extensions d'activer l'écran de consentement pour les autorisations détaillées de manière anticipée, dans lequel les autorisations demandées sont accordées ou refusées individuellement.

  • interactive

    booléen facultatif

    Pour récupérer un jeton, l'utilisateur peut être amené à se connecter à Chrome ou à approuver les champs d'application demandés par l'application. Si le signalement interactif est défini sur true, getAuthToken invite l'utilisateur si nécessaire. Lorsque l'indicateur est défini sur false ou omis, getAuthToken renvoie un échec chaque fois qu'une invite est requise.

  • scopes

    string[] facultatif

    Liste des habilitations OAuth2 à demander.

    Lorsque le champ scopes est présent, il remplace la liste des champs d'application spécifiés dans manifest.json.

WebAuthFlowDetails

Propriétés

  • abortOnLoadForNonInteractive

    booléen facultatif

    Chrome 113 et versions ultérieures

    Indique si launchWebAuthFlow doit être arrêté pour les requêtes non interactives après le chargement de la page. Ce paramètre n'a aucune incidence sur les flux interactifs.

    Si la valeur est définie sur true (par défaut), le flux se termine immédiatement après le chargement de la page. Lorsque ce paramètre est défini sur false, le flux ne se termine qu'une fois le timeoutMsForNonInteractive écoulé. Cela est utile pour les fournisseurs d'identité qui utilisent JavaScript pour effectuer des redirections après le chargement de la page.

  • interactive

    booléen facultatif

    Indique si le flux d'authentification doit être lancé en mode interactif.

    Étant donné que certains flux d'authentification peuvent rediriger immédiatement vers une URL de résultat, launchWebAuthFlow masque sa vue Web jusqu'à ce que la première navigation redirige vers l'URL finale ou termine de charger une page destinée à être affichée.

    Si l'indicateur interactive est défini sur true, la fenêtre s'affiche une fois le chargement d'une page terminé. Si l'indicateur est défini sur false ou omis, launchWebAuthFlow renverra une erreur si la navigation initiale ne termine pas le flux.

    Pour les flux qui utilisent JavaScript pour la redirection, abortOnLoadForNonInteractive peut être défini sur false en combinaison avec la définition de timeoutMsForNonInteractive pour donner à la page la possibilité d'effectuer des redirections.

  • timeoutMsForNonInteractive

    number facultatif

    Chrome 113 et versions ultérieures

    launchWebAuthFlow est la durée maximale, en millisecondes, pendant laquelle l'exécution en mode non interactif est autorisée au total. N'a d'effet que si interactive est défini sur false.

  • url

    chaîne

    URL qui lance le flux d'authentification.

Méthodes

clearAllCachedAuthTokens()

Promise Chrome 87 et versions ultérieures 
chrome.identity.clearAllCachedAuthTokens(
  callback?: function,
): Promise<void>

Réinitialise l'état de l'API Identity :

  • Supprime tous les jetons d'accès OAuth2 du cache de jetons.
  • Supprime les préférences de compte de l'utilisateur
  • Supprime l'autorisation de l'utilisateur pour tous les flux d'authentification

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 106 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getAccounts()

Promesse Version en développement 
chrome.identity.getAccounts(
  callback?: function,
): Promise<AccountInfo[]>

Récupère une liste d'objets AccountInfo décrivant les comptes présents dans le profil.

getAccounts n'est disponible que sur le canal de développement.

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (accounts: AccountInfo[]) => void

Renvoie

  • Promise<AccountInfo[]>

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getAuthToken()

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

Obtient un jeton d'accès OAuth 2 à l'aide de l'ID client et des champs d'application spécifiés dans la section oauth2 du fichier manifest.json.

L'API Identity met en cache les jetons d'accès en mémoire. Vous pouvez donc appeler getAuthToken de manière non interactive chaque fois qu'un jeton est requis. Le cache de jetons gère automatiquement l'expiration.

Pour une bonne expérience utilisateur, il est important que les demandes de jetons interactifs soient initiées par l'UI de votre application, en expliquant à quoi sert l'autorisation. Si vous ne le faites pas, vos utilisateurs recevront des demandes d'autorisation ou des écrans de connexion Chrome (s'ils ne sont pas connectés) sans aucun contexte. En particulier, n'utilisez pas getAuthToken de manière interactive lorsque votre application est lancée pour la première fois.

Remarque : Lorsqu'elle est appelée avec un rappel, au lieu de renvoyer un objet, cette fonction renvoie les deux propriétés sous forme d'arguments distincts transmis au rappel.

Paramètres

Renvoie

  • Chrome 105 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getProfileUserInfo()

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

Récupère l'adresse e-mail et l'ID GAIA obscurci de l'utilisateur connecté à un profil.

Nécessite l'autorisation de fichier manifeste identity.email. Sinon, renvoie un résultat vide.

Cette API diffère de identity.getAccounts de deux manières. Les informations renvoyées sont disponibles hors connexion et ne s'appliquent qu'au compte principal du profil.

Paramètres

  • détails

    ProfileDetails facultatif

    Chrome 84 et versions ultérieures

    Options de profil.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (userInfo: ProfileUserInfo) => void

Renvoie

  • Promise<ProfileUserInfo>

    Chrome 106 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getRedirectURL()

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

Génère une URL de redirection à utiliser dans launchWebAuthFlow.

Les URL générées correspondent au format https://<app-id>.chromiumapp.org/*.

Paramètres

  • chemin d'accès

    chaîne facultative

    Chemin ajouté à la fin de l'URL générée.

Renvoie

  • chaîne

launchWebAuthFlow()

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

Démarre un flux d'authentification à l'URL spécifiée.

Cette méthode permet les flux d'authentification avec des fournisseurs d'identité non Google en lançant une vue Web et en la redirigeant vers la première URL du flux d'authentification du fournisseur. Lorsque le fournisseur redirige vers une URL correspondant au modèle https://<app-id>.chromiumapp.org/*, la fenêtre se ferme et l'URL de redirection finale est transmise à la fonction callback.

Pour une expérience utilisateur optimale, il est important que les flux d'authentification interactifs soient initiés par l'UI de votre application, qui explique à quoi sert l'autorisation. Si vous ne le faites pas, vos utilisateurs recevront des demandes d'autorisation sans contexte. En particulier, ne lancez pas de flux d'authentification interactif au premier lancement de votre application.

Paramètres

  • Options du flux WebAuth.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (responseUrl?: string) => void

    • responseUrl

      chaîne facultative

Renvoie

  • Promise<string | undefined>

    Chrome 106 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

removeCachedAuthToken()

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

Supprime un jeton d'accès OAuth2 du cache de jetons de l'API Identity.

Si un jeton d'accès s'avère non valide, il doit être transmis à removeCachedAuthToken pour être supprimé du cache. L'application peut ensuite récupérer un nouveau jeton avec getAuthToken.

Paramètres

  • Informations sur le jeton.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 106 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onSignInChanged

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

Déclenché lorsque l'état de connexion d'un compte du profil de l'utilisateur change.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

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