BaseAuth class

Interface parent commune pour les API Auth et TenantAwareAuth .

Signature:

export declare abstract class BaseAuth 

Méthodes

BaseAuth.createCustomToken()

Crée un nouveau jeton personnalisé Firebase (JWT) qui peut être renvoyé à un appareil client pour l'utiliser pour se connecter avec les méthodes signInWithCustomToken() des SDK clients. (Les instances compatibles avec les locataires intégreront également l'ID du locataire dans le jeton.)

Consultez Créer des jetons personnalisés pour obtenir des exemples de code et une documentation détaillée.

Signature:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

Paramètres

Retour:

Promesse<string>

Une promesse tenue avec un jeton personnalisé pour l' uid et la charge utile fournis.

BaseAuth.createProviderConfig()

Renvoie une promesse qui se résout avec le AuthProviderConfig nouvellement créé lorsque la nouvelle configuration du fournisseur est créée.

La prise en charge des fournisseurs SAML et OIDC 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. .

Signature:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

Paramètres

Retour:

Promesse < AuthProviderConfig >

Une promesse qui se résout avec la configuration du fournisseur créé.

BaseAuth.createSessionCookie()

Crée un nouveau cookie de session Firebase avec les options spécifiées. La chaîne JWT créée peut être définie comme cookie de session côté serveur avec une politique de cookie personnalisée et être utilisée pour la gestion de session. Le cookie de session JWT aura les mêmes revendications de charge utile que le jeton d'identification fourni.

Voir Gérer les cookies de session pour des exemples de code et une documentation détaillée.

Signature:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

Paramètres

Retour:

Promesse<string>

Une promesse qui se résout en cas de succès avec le cookie de session créé.

BaseAuth.createUser()

Crée un nouvel utilisateur.

Consultez Créer un utilisateur pour obtenir des exemples de code et une documentation détaillée.

Signature:

createUser(properties: CreateRequest): Promise<UserRecord>;

Paramètres

Retour:

Promesse < UserRecord >

Une promesse tenue avec les données utilisateur correspondant à l'utilisateur nouvellement créé.

BaseAuth.deleteProviderConfig()

Supprime la configuration du fournisseur correspondant à l'ID du fournisseur transmis. Si l’ID spécifié n’existe pas, une erreur auth/configuration-not-found est générée.

La prise en charge des fournisseurs SAML et OIDC 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. .

Signature:

deleteProviderConfig(providerId: string): Promise<void>;

Paramètres

Retour:

Promesse<vide>

Une promesse qui se résout une fois terminée.

BaseAuth.deleteUser()

Supprime un utilisateur existant.

Consultez Supprimer un utilisateur pour obtenir des exemples de code et une documentation détaillée.

Signature:

deleteUser(uid: string): Promise<void>;

Paramètres

Retour:

Promesse<vide>

Une promesse vide de sens remplie une fois l'utilisateur supprimé.

BaseAuth.deleteUsers()

Supprime les utilisateurs spécifiés par les uid donnés.

La suppression d'un utilisateur non existant ne générera pas d'erreur (c'est-à-dire que cette méthode est idempotente). Les utilisateurs non existants sont considérés comme ayant été supprimés avec succès et sont donc comptés dans la valeur DeleteUsersResult.successCount .

Seuls un maximum de 1000 identifiants peuvent être fournis. Si plus de 1 000 identifiants sont fournis, cette méthode renvoie une FirebaseAuthError.

Cette API est actuellement limitée au niveau du serveur à 1 QPS. Si vous dépassez ce seuil, vous risquez d'obtenir une erreur de dépassement de quota. Par conséquent, si vous souhaitez supprimer plus de 1 000 utilisateurs, vous devrez peut-être ajouter un délai pour vous assurer de ne pas dépasser cette limite.

Signature:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

Paramètres

Retour:

Promesse< DeleteUsersResult >

Une promesse qui correspond au nombre total de suppressions réussies/échouées, ainsi qu'au tableau d'erreurs qui correspond aux suppressions ayant échoué.

BaseAuth.generateEmailVerificationLink()

Génère le lien d'action de courrier électronique hors bande pour vérifier la propriété de l'utilisateur sur le courrier électronique spécifié. L'objet ActionCodeSettings fourni comme argument à cette méthode définit si le lien doit être géré par une application mobile ou un navigateur ainsi que des informations d'état supplémentaires à transmettre dans le lien profond, etc.

Signature:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Paramètres

Retour:

Promesse<string>

Une promesse qui se résout avec le lien généré.

Exemple

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generatePasswordResetLink()

Génère le lien d'action par e-mail hors bande pour réinitialiser le mot de passe d'un utilisateur. Le lien est généré pour l'utilisateur avec l'adresse e-mail spécifiée. L'objet facultatif ActionCodeSettings définit si le lien doit être géré par une application mobile ou un navigateur et les informations d'état supplémentaires à transmettre dans le lien profond, etc.

Signature:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Paramètres

Retour:

Promesse<string>

Une promesse qui se résout avec le lien généré.

Exemple

var actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generatePasswordResetLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateSignInWithEmailLink()

Génère le lien d'action de courrier électronique hors bande pour vérifier la propriété de l'utilisateur sur le courrier électronique spécifié. L'objet ActionCodeSettings fourni comme argument à cette méthode définit si le lien doit être géré par une application mobile ou un navigateur ainsi que des informations d'état supplémentaires à transmettre dans le lien profond, etc.

Signature:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

Paramètres

Retour:

Promesse<string>

Une promesse qui se résout avec le lien généré.

Exemple

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateVerifyAndChangeEmailLink()

Génère un lien d'action de courrier électronique hors bande pour vérifier la propriété de l'utilisateur sur le courrier électronique spécifié. L'objet ActionCodeSettings fourni comme argument à cette méthode définit si le lien doit être géré par une application mobile ou un navigateur ainsi que des informations d'état supplémentaires à transmettre dans le lien profond, etc.

Signature:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Paramètres

Retour:

Promesse<string>

Une promesse qui se résout avec le lien généré.

BaseAuth.getProviderConfig()

Recherche une configuration de fournisseur d'authentification par l'ID fourni. Renvoie une promesse qui se résout avec la configuration du fournisseur correspondant à l'ID de fournisseur spécifié. Si l’ID spécifié n’existe pas, une erreur auth/configuration-not-found est générée.

La prise en charge des fournisseurs SAML et OIDC 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. .

Signature:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

Paramètres

Retour:

Promesse < AuthProviderConfig >

Une promesse qui se résout avec la configuration correspondant à l'ID fourni.

BaseAuth.getUser()

Récupère les données utilisateur de l'utilisateur correspondant à un uid donné .

Consultez Récupérer les données utilisateur pour obtenir des exemples de code et une documentation détaillée.

Signature:

getUser(uid: string): Promise<UserRecord>;

Paramètres

Retour:

Promesse < UserRecord >

Une promesse tenue avec les données utilisateur correspondant à l' uid fourni .

BaseAuth.getUserByEmail()

Obtient les données utilisateur de l'utilisateur correspondant à un e-mail donné.

Consultez Récupérer les données utilisateur pour obtenir des exemples de code et une documentation détaillée.

Signature:

getUserByEmail(email: string): Promise<UserRecord>;

Paramètres

Retour:

Promesse < UserRecord >

Une promesse tenue avec les données utilisateur correspondant à l'email fourni.

BaseAuth.getUserByPhoneNumber()

Obtient les données utilisateur de l'utilisateur correspondant à un numéro de téléphone donné. Le numéro de téléphone doit être conforme à la spécification E.164.

Consultez Récupérer les données utilisateur pour obtenir des exemples de code et une documentation détaillée.

Signature:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

Paramètres

Retour:

Promesse < UserRecord >

Une promesse tenue avec les données utilisateur correspondant au numéro de téléphone fourni.

BaseAuth.getUserByProviderUid()

Obtient les données utilisateur de l'utilisateur correspondant à un identifiant de fournisseur donné.

Consultez Récupérer les données utilisateur pour obtenir des exemples de code et une documentation détaillée.

Signature:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

Paramètres

Retour:

Promesse < UserRecord >

Une promesse remplie avec les données utilisateur correspondant à l'identifiant du fournisseur donné.

BaseAuth.getUsers()

Obtient les données utilisateur correspondant aux identifiants spécifiés.

Il n'y a aucune garantie de commande ; en particulier, il n'est pas garanti que la nième entrée de la liste de résultats corresponde à la nième entrée de la liste des paramètres d'entrée.

Seuls un maximum de 100 identifiants peuvent être fournis. Si plus de 100 identifiants sont fournis, cette méthode renvoie une FirebaseAuthError.

Signature:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

Paramètres

Retour:

Promesse< GetUsersResult >

Une promesse qui résout les enregistrements utilisateur correspondants.

Des exceptions

FirebaseAuthError Si l'un des identifiants n'est pas valide ou si plus de 100 identifiants sont spécifiés.

BaseAuth.importUsers()

Importe la liste d'utilisateurs fournie dans Firebase Auth. Un maximum de 1 000 utilisateurs peuvent être importés un par un. Lors de l’importation d’utilisateurs avec des mots de passe, UserImportOptions doit être spécifié. Cette opération est optimisée pour les importations groupées et ignorera les contrôles sur uid , email et autres identifiants uniques, ce qui pourrait entraîner des duplications.

Signature:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

Paramètres

Retour:

Promesse< UserImportResult >

Promesse qui se résout lorsque l'opération se termine avec le résultat de l'importation. Cela inclut le nombre d'importations réussies, le nombre d'importations ayant échoué et les erreurs correspondantes.

BaseAuth.listProviderConfigs()

Renvoie la liste des configurations de fournisseur existantes correspondant au filtre fourni. Au maximum, 100 configurations de fournisseur peuvent être répertoriées à la fois.

La prise en charge des fournisseurs SAML et OIDC 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. .

Signature:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

Paramètres

Retour:

Promesse < ListProviderConfigResults >

Une promesse qui se résout avec la liste des configurations de fournisseur répondant aux exigences de filtre.

BaseAuth.listUsers()

Récupère une liste d'utilisateurs (un seul lot uniquement) avec une taille de maxResults à partir du décalage spécifié par pageToken . Ceci est utilisé pour récupérer tous les utilisateurs d'un projet spécifié par lots.

Consultez Répertorier tous les utilisateurs pour obtenir des exemples de code et une documentation détaillée.

Signature:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

Paramètres

Retour:

Promesse< ListUsersResult >

Une promesse qui se résout avec le lot actuel d'utilisateurs téléchargés et le jeton de page suivante.

BaseAuth.revokeRefreshTokens()

Révoque tous les jetons d'actualisation pour un utilisateur existant.

Cette API mettra à jour le UserRecord.tokensValidAfterTime de l'utilisateur avec l'UTC actuel. Il est important que l'horloge du serveur sur lequel cela est appelé soit correctement réglée et synchronisée.

Bien que cela révoque toutes les sessions d'un utilisateur spécifié et empêche la création de nouveaux jetons d'identification pour les sessions existantes, les jetons d'identification existants peuvent rester actifs jusqu'à leur expiration naturelle (une heure). Pour vérifier que les jetons d'identification sont révoqués, utilisez BaseAuth.verifyIdToken() où checkRevoked est défini sur true.

Signature:

revokeRefreshTokens(uid: string): Promise<void>;

Paramètres

Retour:

Promesse<vide>

Une promesse vide remplie une fois les jetons d'actualisation de l'utilisateur révoqués.

BaseAuth.setCustomUserClaims()

Définit des revendications de développeur supplémentaires sur un utilisateur existant identifié par l' uid fourni , généralement utilisé pour définir les rôles des utilisateurs et les niveaux d'accès. Ces revendications doivent se propager à tous les appareils sur lesquels l'utilisateur est déjà connecté (après l'expiration du jeton ou lorsque l'actualisation du jeton est forcée) et la prochaine fois que l'utilisateur se connecte. Si un nom de revendication OIDC réservé est utilisé (sub, iat, iss, etc. ), une erreur est générée. Ils sont définis sur le jeton d'identification JWT de l'utilisateur authentifié.

Voir Définition des rôles utilisateur et des niveaux d'accès pour obtenir des exemples de code et une documentation détaillée.

Signature:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

Paramètres

Retour:

Promesse<vide>

Une promesse qui se résout lorsque l’opération se termine avec succès.

BaseAuth.updateProviderConfig()

Renvoie une promesse qui se résout avec l' AuthProviderConfig mis à jour correspondant à l'ID de fournisseur spécifié. Si l’ID spécifié n’existe pas, une erreur auth/configuration-not-found est générée.

La prise en charge des fournisseurs SAML et OIDC 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. .

Signature:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

Paramètres

Retour:

Promesse < AuthProviderConfig >

Une promesse qui se résout avec la configuration du fournisseur mise à jour.

BaseAuth.updateUser()

Met à jour un utilisateur existant.

Consultez Mettre à jour un utilisateur pour obtenir des exemples de code et une documentation détaillée.

Signature:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

Paramètres

Retour:

Promesse < UserRecord >

Une promesse tenue avec les données utilisateur mises à jour.

BaseAuth.verifyIdToken()

Vérifie un jeton d'identification Firebase (JWT). Si le jeton est valide, la promesse est remplie avec les revendications décodées du jeton ; sinon, la promesse est rejetée.

Si checkRevoked est défini sur true, vérifie d'abord si l'utilisateur correspondant est désactivé. Si oui, une erreur auth/user-disabled est générée. Si non, vérifie si la session correspondant au jeton d'identification a été révoquée. Si la session de l'utilisateur correspondant a été invalidée, une erreur auth/id-token-revoked est générée. S’il n’est pas spécifié, le contrôle n’est pas appliqué.

Consultez Vérifier les jetons d’identification pour obtenir des exemples de code et une documentation détaillée.

Signature:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Paramètres

Retour:

Promesse< DecodedIdToken >

Une promesse remplie avec les revendications décodées du jeton si le jeton d'identification est valide ; sinon, une promesse rejetée.

BaseAuth.verifySessionCookie()

Vérifie un cookie de session Firebase. Renvoie une promesse avec les revendications des cookies. Rejette la promesse si le cookie n'a pas pu être vérifié.

Si checkRevoked est défini sur true, vérifie d'abord si l'utilisateur correspondant est désactivé : si oui, une erreur auth/user-disabled est générée. Si non, vérifie si la session correspondant au cookie de session a été révoquée. Si la session de l'utilisateur correspondant a été invalidée, une erreur auth/session-cookie-revoked est générée. Si cela n’est pas spécifié, le contrôle n’est pas effectué.

Voir Vérifier les cookies de session pour des exemples de code et une documentation détaillée

Signature:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Paramètres

Retour:

Promesse< DecodedIdToken >

Une promesse remplie avec les revendications décodées du cookie de session si le cookie de session est valide ; sinon, une promesse rejetée.