Interface parent commune pour les API Auth et TenantAwareAuth .
Signature:
export declare abstract class BaseAuth
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| createCustomToken (uid, développeurClaims) | 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. | |
| créerProviderConfig(config) | 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. . | |
| créerSessionCookie(idToken, sessionCookieOptions) | 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. | |
| créer un utilisateur (propriétés) | Crée un nouvel utilisateur. Consultez Créer un utilisateur pour obtenir des exemples de code et une documentation détaillée. | |
| deleteProviderConfig(providerId) | 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. . | |
| supprimer l'utilisateur (uid) | Supprime un utilisateur existant. Consultez Supprimer un utilisateur pour obtenir des exemples de code et une documentation détaillée. | |
| supprimerUtilisateurs(uids) | 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. | |
| generateEmailVerificationLink (e-mail, actionCodeSettings) | 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. | |
| generatePasswordResetLink (e-mail, actionCodeSettings) | 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. | |
| generateSignInWithEmailLink (e-mail, actionCodeSettings) | 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. | |
| generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) | 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. | |
| getProviderConfig(providerId) | 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. . | |
| getUser (uid) | Obtient les données utilisateur pour 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. | |
| getUserByEmail(e-mail) | 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. | |
| getUserByPhoneNumber(numéro de téléphone) | 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. | |
| getUserByProviderUid(providerId, uid) | 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. | |
| getUsers (identifiants) | 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. | |
| importUsers(utilisateurs, options) | 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 l'unicité uid , email et d'autres identifiants, ce qui pourrait entraîner des duplications. | |
| listeProviderConfigs(options) | 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. . | |
| listeUtilisateurs (maxResults, pageToken) | 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. | |
| revokeRefreshTokens (uid) | 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. | |
| setCustomUserClaims (uid, customUserClaims) | Définit des revendications de développeur supplémentaires sur un utilisateur existant identifié par l' uid fourni, généralement utilisées pour définir les rôles d'utilisateur 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. | |
| updateProviderConfig (providerId, updateConfig) | 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. . | |
| updateUser (uid, propriétés) | Met à jour un utilisateur existant. Consultez Mettre à jour un utilisateur pour obtenir des exemples de code et une documentation détaillée. | |
| verifyIdToken(idToken, checkRevoked) | 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. | |
| verifySessionCookie(sessionCookie, checkRevoked) | 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 |
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
| Paramètre | Taper | Description |
|---|---|---|
| uide | chaîne | L' uid à utiliser comme sujet du jeton personnalisé. |
| développeurClaims | objet | Revendications supplémentaires facultatives à inclure dans la charge utile du jeton personnalisé. |
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
| Paramètre | Taper | Description |
|---|---|---|
| configuration | AuthProviderConfig | La configuration du fournisseur à créer. |
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
| Paramètre | Taper | Description |
|---|---|---|
| jeton d'identification | chaîne | Le jeton d'identification Firebase à échanger contre un cookie de session. |
| sessionCookieOptions | Options de cookie de session | Les options de cookie de session qui incluent une durée de session personnalisée. |
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
| Paramètre | Taper | Description |
|---|---|---|
| propriétés | Créer une demande | Les propriétés à définir sur le nouvel enregistrement utilisateur à créer. |
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
| Paramètre | Taper | Description |
|---|---|---|
| ID du fournisseur | chaîne | L'ID du fournisseur correspondant à la configuration du fournisseur à supprimer. |
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
| Paramètre | Taper | Description |
|---|---|---|
| uide | chaîne | L' uid correspondant à l'utilisateur à supprimer. |
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
| Paramètre | Taper | Description |
|---|---|---|
| uides | chaîne[] | Les uids correspondant aux utilisateurs à supprimer. |
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
| Paramètre | Taper | Description |
|---|---|---|
| chaîne | Le compte de messagerie à vérifier. | |
| actionCodeSettings | Paramètres de code d'action | Les paramètres du code d’action. Si elle est spécifiée, l'URL d'état/continue est définie comme paramètre « continueUrl » dans le lien de vérification de l'e-mail. La page de destination de vérification des e-mails par défaut l'utilisera pour afficher un lien permettant de revenir à l'application si elle est installée. Si actionCodeSettings n’est pas spécifié, aucune URL n’est ajoutée à l’URL de l’action. L'URL d'état fournie doit appartenir à un domaine ajouté à la liste blanche par le développeur dans la console. Sinon, une erreur est générée. Les redirections d'applications mobiles ne sont applicables que si le développeur configure et accepte les conditions de service de Firebase Dynamic Links. Le nom du package Android et l'ID du bundle iOS ne sont respectés que s'ils sont configurés dans le même projet Firebase Auth. |
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
| Paramètre | Taper | Description |
|---|---|---|
| chaîne | L'adresse e-mail de l'utilisateur dont le mot de passe doit être réinitialisé. | |
| actionCodeSettings | Paramètres de code d'action | Les paramètres du code d’action. Si elle est spécifiée, l'URL d'état/continue est définie comme paramètre « continueUrl » dans le lien de réinitialisation du mot de passe. La page de destination de réinitialisation du mot de passe par défaut l'utilisera pour afficher un lien permettant de revenir à l'application si elle est installée. Si actionCodeSettings n’est pas spécifié, aucune URL n’est ajoutée à l’URL de l’action. L'URL d'état fournie doit appartenir à un domaine ajouté à la liste blanche par le développeur dans la console. Sinon, une erreur est générée. Les redirections d'applications mobiles ne sont applicables que si le développeur configure et accepte les conditions de service de Firebase Dynamic Links. Le nom du package Android et l'ID du bundle iOS ne sont respectés que s'ils sont configurés dans le même projet Firebase Auth. |
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
| Paramètre | Taper | Description |
|---|---|---|
| chaîne | Le compte de messagerie à vérifier. | |
| actionCodeSettings | Paramètres de code d'action | Les paramètres du code d’action. Si elle est spécifiée, l'URL d'état/continue est définie comme paramètre « continueUrl » dans le lien de vérification de l'e-mail. La page de destination de vérification des e-mails par défaut l'utilisera pour afficher un lien permettant de revenir à l'application si elle est installée. Si actionCodeSettings n’est pas spécifié, aucune URL n’est ajoutée à l’URL de l’action. L'URL d'état fournie doit appartenir à un domaine ajouté à la liste blanche par le développeur dans la console. Sinon, une erreur est générée. Les redirections d'applications mobiles ne sont applicables que si le développeur configure et accepte les conditions de service de Firebase Dynamic Links. Le nom du package Android et l'ID du bundle iOS ne sont respectés que s'ils sont configurés dans le même projet Firebase Auth. |
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
| Paramètre | Taper | Description |
|---|---|---|
| chaîne | Le compte de messagerie actuel. | |
| nouveau courriel | chaîne | L'adresse e-mail vers laquelle le compte est mis à jour. |
| actionCodeSettings | Paramètres de code d'action | Les paramètres du code d’action. Si elle est spécifiée, l'URL d'état/continue est définie comme paramètre « continueUrl » dans le lien de vérification de l'e-mail. La page de destination de vérification des e-mails par défaut l'utilisera pour afficher un lien permettant de revenir à l'application si elle est installée. Si actionCodeSettings n’est pas spécifié, aucune URL n’est ajoutée à l’URL de l’action. L'URL d'état fournie doit appartenir à un domaine autorisé dans la console, sinon une erreur sera générée. Les redirections d'applications mobiles ne sont applicables que si le développeur configure et accepte les conditions de service de Firebase Dynamic Links. Le nom du package Android et l'ID du bundle iOS ne sont respectés que s'ils sont configurés dans le même projet Firebase Auth. |
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
| Paramètre | Taper | Description |
|---|---|---|
| ID du fournisseur | chaîne | L'ID du fournisseur correspondant à la configuration du fournisseur à renvoyer. |
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
| Paramètre | Taper | Description |
|---|---|---|
| uide | chaîne | L' uid correspondant à l'utilisateur dont les données doivent être récupérées. |
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
| Paramètre | Taper | Description |
|---|---|---|
| chaîne | L'email correspondant à l'utilisateur dont les données doivent être récupérées. |
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
| Paramètre | Taper | Description |
|---|---|---|
| numéro de téléphone | chaîne | Le numéro de téléphone correspondant à l'utilisateur dont les données doivent être récupérées. |
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
| Paramètre | Taper | Description |
|---|---|---|
| ID du fournisseur | chaîne | L'ID du fournisseur, par exemple "google.com" pour le fournisseur Google. |
| uide | chaîne | L'identifiant d'utilisateur pour le fournisseur donné. |
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
| Paramètre | Taper | Description |
|---|---|---|
| identifiants | Identifiant utilisateur [] | Les identifiants utilisés pour indiquer quels enregistrements utilisateur doivent être renvoyés. Ne doit pas contenir plus de 100 entrées. |
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
| Paramètre | Taper | Description |
|---|---|---|
| utilisateurs | UserImportRecord [] | La liste des enregistrements utilisateur à importer dans Firebase Auth. |
| choix | Options d'importation d'utilisateur | Les options d'importation d'utilisateurs, requises lorsque les utilisateurs fournis incluent des informations d'identification par mot de passe. |
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
| Paramètre | Taper | Description |
|---|---|---|
| choix | AuthProviderConfigFilter | Le filtre de configuration du fournisseur à appliquer. |
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
| Paramètre | Taper | Description |
|---|---|---|
| maxRésultats | nombre | La taille de la page, 1000 si non définie. C'est également la limite maximale autorisée. |
| jeton de page | chaîne | Le jeton de la page suivante. S'il n'est pas spécifié, renvoie les utilisateurs démarrant sans aucun décalage. |
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
| Paramètre | Taper | Description |
|---|---|---|
| uide | chaîne | L' uid correspondant à l'utilisateur dont les jetons de rafraîchissement doivent être révoqués. |
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
| Paramètre | Taper | Description |
|---|---|---|
| uide | chaîne | L’ uid de l’utilisateur à modifier. |
| réclamationsutilisateur personnalisées | objet | nul | Le développeur prétend définir. Si null est transmis, les revendications personnalisées existantes sont supprimées. La transmission d’une charge utile de revendications personnalisées supérieure à 1 000 octets générera une erreur. Les revendications personnalisées sont ajoutées au jeton d'identification de l'utilisateur qui est transmis à chaque demande authentifiée. Pour les attributs utilisateur de profil non liés à l'accès, utilisez une base de données ou d'autres systèmes de stockage distincts. |
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
| Paramètre | Taper | Description |
|---|---|---|
| ID du fournisseur | chaîne | L'ID du fournisseur correspondant à la configuration du fournisseur à mettre à jour. |
| mise à jourConfig | UpdateAuthProviderRequest | La configuration mise à jour. |
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
| Paramètre | Taper | Description |
|---|---|---|
| uide | chaîne | L' uid correspondant à l'utilisateur à mettre à jour. |
| propriétés | Demande de mise à jour | Les propriétés à mettre à jour sur l'utilisateur fourni. |
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
| Paramètre | Taper | Description |
|---|---|---|
| jeton d'identification | chaîne | Le jeton d’identification à vérifier. |
| checkRévoqué | booléen | S'il faut vérifier si le jeton d'identification a été révoqué. Cela nécessite une requête supplémentaire au backend Firebase Auth pour vérifier l'heure tokensValidAfterTime pour l'utilisateur correspondant. Lorsqu’elle n’est pas précisée, cette vérification supplémentaire n’est pas appliquée. |
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
| Paramètre | Taper | Description |
|---|---|---|
| sessionCookie | chaîne | Le cookie de session à vérifier. |
| checkRévoqué | booléen |
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.