Save the date for Firebase Demo Day 2024. Learn how to build and run modern, AI-powered apps users love. Learn more.

Cette page a été traduite par l'API Cloud Translation.

firebase-admin.auth package

Authentification Firebase.

Les fonctions

Fonction	Description
getAuth (application)	Obtient le service Auth pour l’application par défaut ou une application donnée. `getAuth()` peut être appelé sans argument pour accéder au service Auth de l'application par défaut ou avec `getAuth(app)` pour accéder au service Auth associé à une application spécifique.

Des classes

Classe	Description
Authentification	Service d'authentification lié à l'application fournie. Une instance Auth peut avoir plusieurs locataires.
BaseAuth	Interface parent commune pour les API `Auth` et `TenantAwareAuth` .
MultiFactorInfo	Interface représentant les propriétés communes d'un deuxième facteur inscrit par l'utilisateur.
Paramètres multifacteurs	Les paramètres utilisateur liés à plusieurs facteurs.
TéléphoneMultiFactorInfo	Interface représentant un deuxième facteur enregistré par l'utilisateur spécifique au téléphone.
Configuration du projet	Représente une configuration de projet.
Gestionnaire de configuration de projet	Gère (obtient et met à jour) la configuration actuelle du projet.
Locataire	Représente une configuration de locataire. La prise en charge de l'architecture mutualisée nécessite la plate-forme d'identité de Google Cloud (GCIP). Pour en savoir plus sur GCIP, y compris les tarifs et les fonctionnalités, consultez la documentation GCIP. . Avant que la multilocation puisse être utilisée sur un projet Google Cloud Identity Platform, les locataires doivent être autorisés sur ce projet via l'interface utilisateur de Cloud Console. Une configuration de locataire fournit des informations telles que le nom d'affichage, l'identifiant du locataire et la configuration de l'authentification par courrier électronique. Pour la gestion de la configuration du fournisseur OIDC/SAML, les instances `TenantAwareAuth` doivent être utilisées à la place d'un `Tenant` pour récupérer la liste des IdP configurés sur un locataire. Lors de la configuration de ces fournisseurs, notez que les locataires hériteront des domaines sur liste blanche et des URI de redirection authentifiés de leur projet parent. Tous les autres paramètres d'un locataire seront également hérités. Ceux-ci devront être gérés à partir de l’interface utilisateur de Cloud Console.
TenantAwareAuth	Interface `Auth` adaptée aux locataires utilisée pour gérer les utilisateurs, configurer les fournisseurs SAML/OIDC, générer des liens de messagerie pour la réinitialisation du mot de passe, la vérification des e-mails, etc. pour des locataires spécifiques. La prise en charge de l'architecture mutualisée nécessite la plate-forme d'identité de Google Cloud (GCIP). Pour en savoir plus sur GCIP, y compris les tarifs et les fonctionnalités, consultez la documentation GCIP. . Chaque locataire contient ses propres fournisseurs d'identité, paramètres et ensembles d'utilisateurs. À l'aide `TenantAwareAuth` , les utilisateurs d'un locataire spécifique et les configurations OIDC/SAML correspondantes peuvent également être gérés, les jetons d'identification des utilisateurs connectés à un locataire spécifique peuvent être vérifiés et des liens d'action par courrier électronique peuvent également être générés pour les utilisateurs appartenant au locataire. Les instances `TenantAwareAuth` pour un `tenantId` spécifique peuvent être instanciées en appelant TenantManager.authForTenant() .
TenantManager	Définit le gestionnaire de locataires utilisé pour aider à gérer les opérations liées aux locataires. Ceci comprend: La possibilité de créer, mettre à jour, répertorier, obtenir et supprimer des locataires pour le projet sous-jacent. Obtention d'une instance `TenantAwareAuth` pour exécuter des opérations liées à l'authentification (gestion des utilisateurs, gestion de la configuration du fournisseur, vérification des jetons, génération de liens de courrier électronique, etc.) dans le contexte d'un locataire spécifié.
Informations utilisateur	Représente les informations d'un utilisateur provenant d'un fournisseur d'identité tiers tel que Google ou Facebook.
Métadonnées utilisateur	Représente les métadonnées d'un utilisateur.
Enregistrement utilisateur	Représente un utilisateur.

Interfaces

Interface	Description
Paramètres de code d'action	Il s'agit de l'interface qui définit l'URL de continuation/état requise avec les identifiants de bundle Android et iOS facultatifs.
Autoriser par défaut	Définit une politique consistant à autoriser chaque région par défaut et à ajouter des régions non autorisées à une liste d'interdiction.
AllowByDefaultWrap	Configuration de la région SMS exclusive mutuelle de l'interface AllowByDefault
Liste verte uniquement	Définit une politique consistant à autoriser uniquement les régions en les ajoutant explicitement à une liste verte.
ListeAutoriséeOnlyWrap	Configuration de la région SMS mutuellement exclusive de l'interface AllowlistOnly
AuthProviderConfigFilter	Interface de filtre utilisée pour répertorier les configurations du fournisseur. Ceci est utilisé lors de la spécification de la manière de répertorier les fournisseurs d'identité configurés via BaseAuth.listProviderConfigs() .
BaseAuthProviderConfig	L'interface de configuration de base du fournisseur d'authentification.
BaseCreateMultiFactorInfoRequest	Interface représentant les propriétés de base d'un deuxième facteur inscrit par l'utilisateur pour un `CreateRequest` .
BaseUpdateMultiFactorInfoRequest	Interface représentant les propriétés communes d’un deuxième facteur inscrit par l’utilisateur pour un `UpdateRequest` .
CreatePhoneMultiFactorInfoRequest	Interface représentant un deuxième facteur inscrit par l'utilisateur spécifique au téléphone pour un `CreateRequest` .
Créer une demande	Interface représentant les propriétés à définir sur une nouvelle fiche utilisateur à créer.
Configuration des options de force personnalisée	Contraintes à appliquer sur la politique de mot de passe
Jeton d'identification décodé	Interface représentant un jeton d'ID Firebase décodé, renvoyé par la méthode BaseAuth.verifyIdToken() . Les jetons d'identification Firebase sont des jetons Web JSON (JWT) conformes aux spécifications OpenID Connect. Consultez la [section Jeton d'ID de la spécification OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) pour plus d'informations sur les propriétés spécifiques ci-dessous.
Supprimer les utilisateursRésultat	Représente le résultat de BaseAuth.deleteUsers() . API.
Identifiant de courrier électronique	Utilisé pour rechercher un compte par e-mail. Voir BaseAuth.getUsers() .
EmailConfidentialitéConfig	La configuration de la confidentialité des e-mails d’un projet ou d’un locataire.
EmailSignInProviderConfig	La configuration du fournisseur de connexion par e-mail.
Obtenir le résultat des utilisateurs	Représente le résultat de l'API BaseAuth.getUsers() .
ListProviderConfigResults	L'interface de réponse pour répertorier les configurations du fournisseur. Ceci n'est disponible que lors de la liste des configurations de tous les fournisseurs d'identité via BaseAuth.listProviderConfigs() .
ListeLocatairesRésultat	Interface représentant l'objet renvoyé par une opération TenantManager.listTenants() . Contient la liste des locataires pour le lot actuel et le jeton de page suivante s'il est disponible.
ListeUtilisateursRésultat	Interface représentant l'objet renvoyé par une opération BaseAuth.listUsers() . Contient la liste des utilisateurs pour le lot en cours et le jeton de la page suivante si disponible.
Configuration multifacteur	Interface représentant une configuration multi-facteurs. Cela peut être utilisé pour définir si l'authentification multifacteur est activée ou désactivée et la liste des défis du deuxième facteur pris en charge.
MultiFactorCreateSettings	Paramètres utilisateur liés à plusieurs facteurs pour les opérations de création.
MultiFactorProviderConfig	Interface représentant une configuration de fournisseur d'authentification multifacteur. Cette interface est utilisée pour les fournisseurs d'authentification à second facteur autres que SMS. Actuellement, seul TOTP est pris en charge.
Paramètres de mise à jour multifacteur	Paramètres utilisateur liés à plusieurs facteurs pour les opérations de mise à jour.
Type de réponse OAuth	Interface représentant l'objet de réponse du fournisseur OIDC pour le flux d'autorisation OAuth. L'un des paramètres suivants est requis : Définissez `code` sur `true` pour le flux de code. Définissez `idToken` sur `true` pour le flux de jetons d'identification.
OIDCAuthProviderConfig	L'interface de configuration du fournisseur d'authentification [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). Un fournisseur OIDC peut être créé via BaseAuth.createProviderConfig() .
OIDCUpdateAuthProviderRequest	L'interface de requête pour la mise à jour d'un fournisseur d'authentification OIDC. Ceci est utilisé lors de la mise à jour de la configuration d'un fournisseur OIDC via BaseAuth.updateProviderConfig() .
Configuration de la politique de mot de passe	Une configuration de politique de mot de passe pour un projet ou un locataire
Identifiant de téléphone	Utilisé pour rechercher un compte par numéro de téléphone. Voir BaseAuth.getUsers() .
Identifiant du fournisseur	Utilisé pour rechercher un compte par fournisseur fédéré. Voir BaseAuth.getUsers() .
RecaptchaConfig	L'interface de requête pour la mise à jour d'une configuration reCAPTCHA. En activant l'intégration de reCAPTCHA Enterprise, vous acceptez les conditions d'utilisation de reCAPTCHA Enterprise. .
Clé de récupération	La configuration de la clé reCAPTCHA.
RecaptchaManagedRule	La configuration d'une règle d'action reCAPTCHA.
SAMLAuthProviderConfig	L'interface de configuration du fournisseur d'authentification [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html). Un fournisseur SAML peut être créé via BaseAuth.createProviderConfig() .
SAMLUpdateAuthProviderRequest	L'interface de requête pour la mise à jour d'un fournisseur d'authentification SAML. Ceci est utilisé lors de la mise à jour de la configuration d'un fournisseur SAML via BaseAuth.updateProviderConfig() .
Options de cookie de session	Interface représentant les options de cookie de session nécessaires à la méthode BaseAuth.createSessionCookie() .
TotpMultiFactorProviderConfig	Interface représentant les paramètres de configuration pour l’authentification TOTP à deuxième facteur.
Identifiant Uid	Utilisé pour rechercher un compte par uid. Voir BaseAuth.getUsers() .
UpdatePhoneMultiFactorInfoRequest	Interface représentant un deuxième facteur inscrit par l'utilisateur spécifique au téléphone pour un `UpdateRequest` .
UpdateProjectConfigRequest	Interface représentant les propriétés à mettre à jour sur la configuration du projet fournie.
Demande de mise à jour	Interface représentant les propriétés à mettre à jour sur l'utilisateur fourni.
UpdateTenantRequest	Interface représentant les propriétés à mettre à jour sur le locataire fourni.
Options d'importation d'utilisateur	Interface représentant les options d'importation utilisateur nécessaires à la méthode BaseAuth.importUsers() . Ceci est utilisé pour fournir les informations sur l’algorithme de hachage du mot de passe.
UserImportRecord	Interface représentant un utilisateur à importer dans Firebase Auth via la méthode BaseAuth.importUsers() .
UserImportResult	Interface représentant la réponse de la méthode BaseAuth.importUsers() pour l'importation par lots d'utilisateurs vers Firebase Auth.
Demande de métadonnées utilisateur	Métadonnées utilisateur à inclure lors de l’importation d’un utilisateur.
Fournisseur d'utilisateurs	Représente un fournisseur d'identité utilisateur qui peut être associé à un utilisateur Firebase.
Demande de fournisseur d'utilisateur	Données du fournisseur d'utilisateurs à inclure lors de l'importation d'un utilisateur.

Tapez les alias

Tapez l'alias	Description
Type de facteur d'authentification	Identifie un deuxième type de facteur.
AuthProviderConfig	Type de configuration du fournisseur d'authentification. BaseAuth.createProviderConfig() .
CreateMultiFactorInfoRequest	Type représentant les propriétés d’un deuxième facteur inscrit par l’utilisateur pour un `CreateRequest` .
Créer une demande de locataire	Interface représentant les propriétés à définir sur un nouveau locataire.
Type d'algorithme de hachage
État de configuration multifacteur	Identifie un état de configuration multifacteur.
Mot de passePolicyEnforcementState	État d’application d’une stratégie de mot de passe.
RécaptchaAction	Les actions à entreprendre pour les requêtes protégées par reCAPTCHA. - 'BLOCK' : La requête protégée par reCAPTCHA sera bloquée.
RecaptchaKeyClientType	Le type de plate-forme de la clé.
RecaptchaProviderEnforcementState	État d’application de la protection reCAPTCHA. - 'OFF' : Non appliqué. - 'AUDIT' : crée une évaluation mais n'applique pas le résultat. - 'ENFORCE' : Créer une évaluation et appliquer le résultat.
SmsRegionConfig	L'interface de demande pour la mise à jour d'une configuration de région SMS. Configure les régions dans lesquelles les utilisateurs sont autorisés à envoyer des SMS de vérification. Ceci est basé sur l’indicatif d’appel du numéro de téléphone de destination.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	Type représentant les propriétés d’un deuxième facteur inscrit par l’utilisateur pour un `UpdateRequest` .
Identifiant utilisateur	Identifie un utilisateur à rechercher.

getAuth()

Obtient le service Auth pour l’application par défaut ou une application donnée.

getAuth() peut être appelé sans argument pour accéder au service Auth de l'application par défaut ou avec getAuth(app) pour accéder au service Auth associé à une application spécifique.

Signature:

export declare function getAuth(app?: App): Auth;

Paramètres

Paramètre	Taper	Description
application	Application

Retour:

Authentification

Exemple 1

// Get the Auth service for the default app
const defaultAuth = getAuth();

Exemple 2

// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);

Type de facteur d'authentification

Identifie un deuxième type de facteur.

Signature:

export type AuthFactorType = 'phone';

AuthProviderConfig

Type de configuration du fournisseur d'authentification. BaseAuth.createProviderConfig() .

Signature:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

Type représentant les propriétés d'un deuxième facteur inscrit par l'utilisateur pour un CreateRequest .

Signature:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

Créer une demande de locataire

Interface représentant les propriétés à définir sur un nouveau locataire.

Signature:

export type CreateTenantRequest = UpdateTenantRequest;

Type d'algorithme de hachage

Signature:

export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';

État de configuration multifacteur

Identifie un état de configuration multifacteur.

Signature:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

Mot de passePolicyEnforcementState

État d’application d’une stratégie de mot de passe.

Signature:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

RécaptchaAction

Les actions à entreprendre pour les requêtes protégées par reCAPTCHA. - 'BLOCK' : La requête protégée par reCAPTCHA sera bloquée.

Signature:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

Le type de plate-forme de la clé.

Signature:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

RecaptchaProviderEnforcementState

État d’application de la protection reCAPTCHA. - 'OFF' : Non appliqué. - 'AUDIT' : crée une évaluation mais n'applique pas le résultat. - 'ENFORCE' : Créer une évaluation et appliquer le résultat.

Signature:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

SmsRegionConfig

L'interface de demande pour la mise à jour d'une configuration de région SMS. Configure les régions dans lesquelles les utilisateurs sont autorisés à envoyer des SMS de vérification. Ceci est basé sur l’indicatif d’appel du numéro de téléphone de destination.

Signature:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

Signature:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

Type représentant les propriétés d'un deuxième facteur inscrit par l'utilisateur pour un UpdateRequest .

Signature:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Identifiant utilisateur

Identifie un utilisateur à rechercher.

Signature:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;