Inicie sessão nos utilizadores com o GitHub

Este documento mostra como usar a Identity Platform para iniciar sessão de utilizadores com o GitHub.

Antes de começar

Este tutorial pressupõe que já ativou a Identity Platform e tem uma app Web básica escrita em HTML e JavaScript. Para saber como ativar o Identity Platform e iniciar sessão, consulte o Início rápido.

Configure o GitHub como um fornecedor

Para configurar o GitHub como um Fornecedor de identidade:

1. Aceda à página Fornecedores de identidade na Google Cloud consola.

   Aceda à página Fornecedores de identidade

2. Clique em Adicionar um fornecedor.
3. Selecione GitHub na lista.
4. Introduza o ID de cliente e o segredo do cliente do GitHub. Se ainda não tiver um ID e um segredo, pode obtê-los na página GitHub Applications.
5. Configure o URI indicado em Configurar GitHub como um URI de redirecionamento OAuth válido para a sua app GitHub. Se configurou um domínio personalizado na Identity Platform, atualize o URI de redirecionamento na configuração da app GitHub para usar o domínio personalizado em vez do domínio predefinido. Por exemplo, altere https://myproject.firebaseapp.com/__/auth/handler para https://auth.myownpersonaldomain.com/__/auth/handler.
6. No painel lateral Definições do projeto, clique em Adicionar domínio e adicione o domínio da sua app.

   Recomendamos que não inclua localhost nos seus projetos de produção.

   Nota: para projetos criados antes de 28 de abril de 2025, localhost está ativado por predefinição.
7. Na secção Configure a sua aplicação, clique em Detalhes da configuração. Copie o fragmento para o código da sua app para inicializar o SDK do cliente do Identity Platform.
8. Clique em Guardar.

Inicie sessão nos utilizadores com o SDK do cliente

1. Crie uma instância do objeto do fornecedor do GitHub:

   Versão Web 9

   import { GithubAuthProvider } from "firebase/auth";
   
   const provider = new GithubAuthProvider();
   auth_github_provider_create.js

   Versão Web 8

   var provider = new firebase.auth.GithubAuthProvider();
   github.js

2. Opcional: adicione âmbitos do OAuth. Os âmbitos especificam os dados que está a pedir ao GitHub. Os dados mais confidenciais podem exigir âmbitos específicos. Consulte a documentação do fornecedor para determinar os âmbitos de que a sua app precisa.

   Versão Web 9

   provider.addScope('repo');
   auth_github_provider_scopes.js

   Versão Web 8

   provider.addScope('repo');
   github.js

3. Opcional: localize o fluxo de autenticação. Pode especificar um idioma ou usar o idioma predefinido do dispositivo:

   Versão Web 9

   import { getAuth } from "firebase/auth";
   
   const auth = getAuth();
   auth.languageCode = 'it';
   // To apply the default browser preference instead of explicitly setting it.
   // auth.useDeviceLanguage();
   auth_set_language_code.js

   Versão Web 8

   firebase.auth().languageCode = 'it';
   // To apply the default browser preference instead of explicitly setting it.
   // firebase.auth().useDeviceLanguage();
   index.js

4. Opcional: especifique parâmetros de OAuth personalizados adicionais. Estas são específicas do GitHub e são normalmente usadas para personalizar a experiência de autenticação. Não pode transmitir parâmetros reservados pelo OAuth ou pela Identity Platform.

   Versão Web 9

   provider.setCustomParameters({
     'allow_signup': 'false'
   });
   auth_github_provider_params.js

   Versão Web 8

   provider.setCustomParameters({
     'allow_signup': 'false'
   });
   github.js

5. Use o objeto do fornecedor GitHub para iniciar sessão no utilizador. Pode abrir uma janela de pop-up ou redirecionar a página atual. O redirecionamento é mais fácil para os utilizadores em dispositivos móveis.

   Para mostrar um pop-up, chame signInWithPopup():

   Versão Web 9

   import { getAuth, signInWithPopup, GithubAuthProvider } from "firebase/auth";
   
   const auth = getAuth();
   signInWithPopup(auth, provider)
     .then((result) => {
       // This gives you a GitHub Access Token. You can use it to access the GitHub API.
       const credential = GithubAuthProvider.credentialFromResult(result);
       const token = credential.accessToken;
   
       // The signed-in user info.
       const user = result.user;
       // IdP data available using getAdditionalUserInfo(result)
       // ...
     }).catch((error) => {
       // Handle Errors here.
       const errorCode = error.code;
       const errorMessage = error.message;
       // The email of the user's account used.
       const email = error.customData.email;
       // The AuthCredential type that was used.
       const credential = GithubAuthProvider.credentialFromError(error);
       // ...
     });
   auth_github_signin_popup.js

   Versão Web 8

   firebase
     .auth()
     .signInWithPopup(provider)
     .then((result) => {
       /** @type {firebase.auth.OAuthCredential} */
       var credential = result.credential;
   
       // This gives you a GitHub Access Token. You can use it to access the GitHub API.
       var token = credential.accessToken;
   
       // The signed-in user info.
       var user = result.user;
       // IdP data available in result.additionalUserInfo.profile.
         // ...
     }).catch((error) => {
       // Handle Errors here.
       var errorCode = error.code;
       var errorMessage = error.message;
       // The email of the user's account used.
       var email = error.email;
       // The firebase.auth.AuthCredential type that was used.
       var credential = error.credential;
       // ...
     });
   github.js

   Para redirecionar a página, chame primeiro signInWithRedirect().

   Siga as práticas recomendadas quando usar signInWithRedirect, linkWithRedirect ou reauthenticateWithRedirect.

   Versão Web 9

   import { getAuth, signInWithRedirect } from "firebase/auth";
   
   const auth = getAuth();
   signInWithRedirect(auth, provider);
   auth_signin_redirect.js

   Versão Web 8

   firebase.auth().signInWithRedirect(provider);
   index.js

   Em seguida, obtenha o token do GitHub chamando getRedirectResult() quando a página for carregada:

   Versão Web 9

   import { getAuth, getRedirectResult, GithubAuthProvider } from "firebase/auth";
   
   const auth = getAuth();
   getRedirectResult(auth)
     .then((result) => {
       const credential = GithubAuthProvider.credentialFromResult(result);
       if (credential) {
         // This gives you a GitHub Access Token. You can use it to access the GitHub API.
         const token = credential.accessToken;
         // ...
       }
   
       // The signed-in user info.
       const user = result.user;
       // IdP data available using getAdditionalUserInfo(result)
       // ...
     }).catch((error) => {
       // Handle Errors here.
       const errorCode = error.code;
       const errorMessage = error.message;
       // The email of the user's account used.
       const email = error.customData.email;
       // The AuthCredential type that was used.
       const credential = GithubAuthProvider.credentialFromError(error);
       // ...
     });
   auth_github_signin_redirect_result.js

   Versão Web 8

   firebase.auth()
     .getRedirectResult()
     .then((result) => {
       if (result.credential) {
         /** @type {firebase.auth.OAuthCredential} */
         var credential = result.credential;
   
         // This gives you a GitHub Access Token. You can use it to access the GitHub API.
         var token = credential.accessToken;
         // ...
       }
   
       // The signed-in user info.
       var user = result.user;
       // IdP data available in result.additionalUserInfo.profile.
         // ...
     }).catch((error) => {
       // Handle Errors here.
       var errorCode = error.code;
       var errorMessage = error.message;
       // The email of the user's account used.
       var email = error.email;
       // The firebase.auth.AuthCredential type that was used.
       var credential = error.credential;
       // ...
     });
   github.js

Depois de ter um token de acesso, pode usá-lo para chamar a API GitHub. Por exemplo:

REST

curl -H "Authorization: Bearer [TOKEN]" https://api.github.com/gists/starred

Inicie sessão dos utilizadores manualmente

Se não quiser usar o SDK do cliente, também pode processar o fluxo de início de sessão manualmente:

1. Integre a autenticação do GitHub na sua app seguindo os passos na respetiva documentação para programadores.
2. Inicie sessão no utilizador com o GitHub através do fluxo que implementou no passo anterior.
3. Troque o token que recebe do GitHub por uma credencial do Identity Platform:

   Versão Web 9

   import { GithubAuthProvider } from "firebase/auth";
   
   const credential = GithubAuthProvider.credential(token);
   auth_github_provider_credential.js

   Versão Web 8

   var credential = firebase.auth.GithubAuthProvider.credential(token);
   github.js

4. Use a credencial para iniciar sessão no utilizador com a Identity Platform:

   Versão Web 9

   import { getAuth, signInWithCredential } from "firebase/auth";
   
   // Sign in with the credential from the user.
   const auth = getAuth();
   signInWithCredential(auth, credential)
     .then((result) => {
       // Signed in 
       // ...
     })
     .catch((error) => {
       // Handle Errors here.
       const errorCode = error.code;
       const errorMessage = error.message;
       // The email of the user's account used.
       const email = error.customData.email;
       // ...
     });
   auth_signin_credential.js

   Versão Web 8

   // Sign in with the credential from the user.
   firebase.auth()
     .signInWithCredential(credential)
     .then((result) => {
       // Signed in 
       // ...
     })
     .catch((error) => {
       // Handle Errors here.
       const errorCode = error.code;
       const errorMessage = error.message;
       // The email of the user's account used.
       const email = error.email;
       // ...
     });
   index.js

O que se segue?

• Saiba mais acerca dos utilizadores da Identity Platform.
• Inicie sessão com utilizadores com outros fornecedores de identidade.