Вы можете разрешить пользователям аутентифицироваться в Firebase с помощью поставщиков OAuth, таких как Microsoft Azure Active Directory, интегрировав в свое приложение универсальный вход через OAuth с использованием SDK Firebase для реализации сквозного процесса авторизации.
Прежде чем начать
Для авторизации пользователей с использованием учетных записей Microsoft (Azure Active Directory и личных учетных записей Microsoft) необходимо сначала включить Microsoft в качестве поставщика авторизации для вашего проекта Firebase:
- Добавьте Firebase в свой JavaScript-проект .
- В консоли Firebase перейдите в раздел Безопасность > Аутентификация .
- На вкладке «Способ входа» включите поставщик входа Microsoft .
- Добавьте идентификатор клиента (Client ID) и секретный ключ клиента (Client Secret) из консоли разработчика соответствующего поставщика в конфигурацию поставщика:
- Для регистрации клиента Microsoft OAuth следуйте инструкциям в разделе «Быстрый старт: Регистрация приложения в конечной точке Azure Active Directory v2.0» . Обратите внимание, что эта конечная точка поддерживает вход в систему с использованием как личных учетных записей Microsoft, так и учетных записей Azure Active Directory. Подробнее об Azure Active Directory v2.0 можно узнать здесь.
- При регистрации приложений у этих провайдеров обязательно зарегистрируйте домен
*.firebaseapp.comдля вашего проекта в качестве домена перенаправления для вашего приложения.
- Нажмите « Сохранить ».
Обрабатывайте процесс авторизации с помощью Firebase SDK.
Если вы разрабатываете веб-приложение, самый простой способ аутентифицировать пользователей в Firebase с помощью их учетных записей Microsoft — это обработать весь процесс входа в систему с помощью Firebase JavaScript SDK.
Для обработки процесса авторизации с помощью Firebase JavaScript SDK выполните следующие действия:
Создайте экземпляр OAuthProvider , используя идентификатор поставщика microsoft.com .
Web
import { OAuthProvider } from "firebase/auth"; const provider = new OAuthProvider('microsoft.com');
Web
var provider = new firebase.auth.OAuthProvider('microsoft.com');
Необязательно : укажите дополнительные пользовательские параметры OAuth, которые вы хотите отправить вместе с запросом OAuth.
Web
provider.setCustomParameters({ // Force re-consent. prompt: 'consent', // Target specific email with login hint. login_hint: 'user@firstadd.onmicrosoft.com' });
Web
provider.setCustomParameters({ // Force re-consent. prompt: 'consent', // Target specific email with login hint. login_hint: 'user@firstadd.onmicrosoft.com' });
Информацию о параметрах, поддерживаемых Microsoft, см. в документации Microsoft OAuth . Обратите внимание, что вы не можете передавать параметры, необходимые для Firebase, с помощью
setCustomParameters(). К таким параметрам относятся client_id , response_type , redirect_uri , state , scope и response_mode .Чтобы разрешить вход в приложение только пользователям из определенного клиента Azure AD, можно использовать либо понятное доменное имя клиента Azure AD, либо GUID-идентификатор клиента. Это можно сделать, указав поле "tenant" в объекте пользовательских параметров.
Web
provider.setCustomParameters({ // Optional "tenant" parameter in case you are using an Azure AD tenant. // eg. '8eaef023-2b34-4da1-9baa-8bc8c9d6a490' or 'contoso.onmicrosoft.com' // or "common" for tenant-independent tokens. // The default value is "common". tenant: 'TENANT_ID' });
Web
provider.setCustomParameters({ // Optional "tenant" parameter in case you are using an Azure AD tenant. // eg. '8eaef023-2b34-4da1-9baa-8bc8c9d6a490' or 'contoso.onmicrosoft.com' // or "common" for tenant-independent tokens. // The default value is "common". tenant: 'TENANT_ID' });
Необязательно : укажите дополнительные области действия OAuth 2.0, помимо базового профиля, которые вы хотите запросить у поставщика аутентификации.
provider.addScope('mail.read'); provider.addScope('calendars.read');Для получения более подробной информации обратитесь к документации Microsoft по разрешениям и согласиям .
Аутентификация в Firebase осуществляется с помощью объекта поставщика OAuth. Вы можете предложить пользователям войти в систему с помощью своих учетных записей Microsoft, открыв всплывающее окно или перенаправив их на страницу входа. На мобильных устройствах предпочтительнее использовать метод перенаправления.
- Для входа в систему через всплывающее окно вызовите функцию
signInWithPopup:
Web
import { getAuth, signInWithPopup, OAuthProvider } from "firebase/auth"; const auth = getAuth(); signInWithPopup(auth, provider) .then((result) => { // User is signed in. // IdP data available in result.additionalUserInfo.profile. // Get the OAuth access token and ID Token const credential = OAuthProvider.credentialFromResult(result); const accessToken = credential.accessToken; const idToken = credential.idToken; }) .catch((error) => { // Handle error. });
Web
firebase.auth().signInWithPopup(provider) .then((result) => { // IdP data available in result.additionalUserInfo.profile. // ... /** @type {firebase.auth.OAuthCredential} */ var credential = result.credential; // OAuth access and id tokens can also be retrieved: var accessToken = credential.accessToken; var idToken = credential.idToken; }) .catch((error) => { // Handle error. });
- Для входа в систему с перенаправлением на страницу авторизации вызовите
signInWithRedirect:
При использовании
signInWithRedirect,linkWithRedirectилиreauthenticateWithRedirectследует придерживаться лучших практик .Web
import { getAuth, signInWithRedirect } from "firebase/auth"; const auth = getAuth(); signInWithRedirect(auth, provider);
Web
firebase.auth().signInWithRedirect(provider);
После того, как пользователь завершит вход в систему и вернется на страницу, вы можете получить результат входа в систему, вызвав
getRedirectResult.Web
import { getAuth, getRedirectResult, OAuthProvider } from "firebase/auth"; const auth = getAuth(); getRedirectResult(auth) .then((result) => { // User is signed in. // IdP data available in result.additionalUserInfo.profile. // Get the OAuth access token and ID Token const credential = OAuthProvider.credentialFromResult(result); const accessToken = credential.accessToken; const idToken = credential.idToken; }) .catch((error) => { // Handle error. });
Web
firebase.auth().getRedirectResult() .then((result) => { // IdP data available in result.additionalUserInfo.profile. // ... /** @type {firebase.auth.OAuthCredential} */ var credential = result.credential; // OAuth access and id tokens can also be retrieved: var accessToken = credential.accessToken; var idToken = credential.idToken; }) .catch((error) => { // Handle error. });
После успешного завершения процесса токен доступа OAuth, связанный с поставщиком услуг, можно получить из возвращаемого объекта
firebase.auth.UserCredential.Используя токен доступа OAuth, вы можете вызвать API Microsoft Graph .
Например, для получения основной информации профиля можно вызвать следующий REST API:
curl -i -H "Authorization: Bearer ACCESS_TOKEN" https://graph.microsoft.com/v1.0/me
В отличие от других поставщиков, поддерживаемых Firebase Auth, Microsoft не предоставляет URL-адрес фотографии, и вместо этого двоичные данные для фотографии профиля необходимо запрашивать через Microsoft Graph API .
В дополнение к токену доступа OAuth, токен идентификатора OAuth пользователя также можно получить из объекта
firebase.auth.UserCredential.subв токене идентификатора является специфичным для приложения и не будет совпадать с федеративным идентификатором пользователя, используемым Firebase Auth и доступным черезuser.providerData[0].uid. Вместо него следует использовать поле утвержденияoid. При использовании клиента Azure AD для входа в систему утверждениеoidбудет точно совпадать. Однако в случае, когда клиент не использует клиент, полеoidдополняется. Для федеративного идентификатора4b2eabcdefghijkl,oidбудет иметь форму00000000-0000-0000-4b2e-abcdefghijkl.- Для входа в систему через всплывающее окно вызовите функцию
Хотя приведенные выше примеры сосредоточены на процессах входа в систему, у вас также есть возможность связать поставщика услуг Microsoft с существующим пользователем, используя
linkWithPopup/linkWithRedirect. Например, вы можете связать несколько поставщиков услуг с одним и тем же пользователем, позволяя ему входить в систему с помощью любого из них.Web
import { getAuth, linkWithPopup, OAuthProvider } from "firebase/auth"; const provider = new OAuthProvider('microsoft.com'); const auth = getAuth(); linkWithPopup(auth.currentUser, provider) .then((result) => { // Microsoft credential is linked to the current user. // IdP data available in result.additionalUserInfo.profile. // Get the OAuth access token and ID Token const credential = OAuthProvider.credentialFromResult(result); const accessToken = credential.accessToken; const idToken = credential.idToken; }) .catch((error) => { // Handle error. });
Web
var provider = new firebase.auth.OAuthProvider('microsoft.com'); firebase.auth().currentUser.linkWithPopup(provider) .then((result) => { // Microsoft credential is linked to the current user. // IdP data available in result.additionalUserInfo.profile. // OAuth access token can also be retrieved: // result.credential.accessToken // OAuth ID token can also be retrieved: // result.credential.idToken }) .catch((error) => { // Handle error. });
Аналогичный подход можно использовать с
reauthenticateWithPopup/reauthenticateWithRedirect, которые позволяют получить актуальные учетные данные для выполнения конфиденциальных операций, требующих недавнего входа в систему.Web
import { getAuth, reauthenticateWithPopup, OAuthProvider } from "firebase/auth"; const provider = new OAuthProvider('microsoft.com'); const auth = getAuth(); reauthenticateWithPopup(auth.currentUser, provider) .then((result) => { // User is re-authenticated with fresh tokens minted and // should be able to perform sensitive operations like account // deletion and email or password update. // IdP data available in result.additionalUserInfo.profile. // Get the OAuth access token and ID Token const credential = OAuthProvider.credentialFromResult(result); const accessToken = credential.accessToken; const idToken = credential.idToken; }) .catch((error) => { // Handle error. });
Web
var provider = new firebase.auth.OAuthProvider('microsoft.com'); firebase.auth().currentUser.reauthenticateWithPopup(provider) .then((result) => { // User is re-authenticated with fresh tokens minted and // should be able to perform sensitive operations like account // deletion and email or password update. // IdP data available in result.additionalUserInfo.profile. // OAuth access token can also be retrieved: // result.credential.accessToken // OAuth ID token can also be retrieved: // result.credential.idToken }) .catch((error) => { // Handle error. });
Аутентификация с помощью Firebase в расширении Chrome
Если вы разрабатываете расширение для Chrome, ознакомьтесь с руководством по работе с документами, отображаемыми вне экрана .
Следующие шаги
После первого входа пользователя в систему создается новая учетная запись, которая связывается с учетными данными — то есть именем пользователя и паролем, номером телефона или информацией о поставщике аутентификации, — которые пользователь использовал для входа. Эта новая учетная запись хранится как часть вашего проекта Firebase и может использоваться для идентификации пользователя во всех приложениях вашего проекта, независимо от способа входа пользователя.
В ваших приложениях рекомендуемый способ узнать статус авторизации пользователя — установить наблюдателя для объекта
Auth. Затем вы можете получить основную информацию профиля пользователя из объектаUser. См. раздел «Управление пользователями» .В правилах безопасности Firebase Realtime Database и Cloud Storage вы можете получить уникальный идентификатор пользователя, вошедшего в систему, из переменной
authи использовать его для управления доступом пользователя к данным.
Вы можете разрешить пользователям входить в ваше приложение, используя несколько поставщиков аутентификации, связав учетные данные поставщика аутентификации с существующей учетной записью пользователя.
Для выхода из системы пользователя вызовите signOut :
Web
import { getAuth, signOut } from "firebase/auth"; const auth = getAuth(); signOut(auth).then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });
Web
firebase.auth().signOut().then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });