Permitir que los usuarios accedan con GitHub

En este documento se muestra cómo usar Identity Platform para que los usuarios accedan con GitHub.

Antes de comenzar

En este instructivo, se supone que ya habilitaste Identity Platform y que tienes una aplicación web básica escrita con HTML y JavaScript. Consulta la Guía de inicio rápido para aprender a hacer esto.

Configura GitHub como proveedor

Para configurar GitHub como proveedor de identidad, haz lo siguiente:

Ve a la página Proveedores de identidad en la consola de Google Cloud.

Ir a la página Proveedores de identidad
Haz clic en Agregar un proveedor.
Selecciona GitHub de la lista.
Ingresa el ID de cliente de GitHub y el secreto de cliente. Si aún no tienes un ID y un secreto, puedes obtener uno de la página Aplicaciones de GitHub.
Configura el URI que se enumera en Configura GitHub como un URI de redireccionamiento de OAuth válido para tu app de GitHub.
Para registrar los dominios de tu app, haz clic en Agregar dominio en Dominios autorizados. Para fines de desarrollo, localhost ya está habilitado de forma predeterminada.
En Configura tu aplicación, haz clic en Detalles de la configuración. Copia el fragmento en el código de tu app para inicializar el SDK de cliente de Identity Platform.
Haz clic en Guardar.

Acceso de los usuarios con el SDK de cliente

Crea una instancia del objeto del proveedor de GitHub:
Versión web 9

Obtén más información sobre la API modular web que admite la eliminación de código no utilizado y realiza la actualización desde la API con espacio de nombres.
```
import { GithubAuthProvider } from "firebase/auth";

const provider = new GithubAuthProvider();auth_github_provider_create.js
```
Versión web 8
```
var provider = new firebase.auth.GithubAuthProvider();github.js
```

Opcional: Agrega permisos de OAuth. Los permisos especifican qué datos solicitas de GitHub. Los datos más sensibles pueden requerir permisos específicos. Consulta la documentación del proveedor para determinar los permisos que necesita tu app.
Versión web 9

Obtén más información sobre la API modular web que admite la eliminación de código no utilizado y realiza la actualización desde la API con espacio de nombres.
```
provider.addScope('repo');auth_github_provider_scopes.js
```
Versión web 8
```
provider.addScope('repo');github.js
```

Opcional: Localiza el flujo de autenticación. Puedes especificar un lenguaje o usar el lenguaje predeterminado del dispositivo:

Versión 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

Versión web 8

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

Opcional: Especifica parámetros personalizados de OAuth adicionales. Estos son específicos de GitHub y, por lo general, se usan para personalizar la experiencia de autenticación. No puedes pasar parámetros reservados por OAuth o Identity Platform.

Versión web 9

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

Versión web 8

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

Usa el objeto del proveedor de GitHub para permitir que el usuario acceda. Puedes abrir una ventana emergente o redireccionar la página actual. El redireccionamiento es más sencillo para los usuarios de dispositivos móviles.

Para mostrar una ventana emergente, llama a signInWithPopup():

Versión 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

Versión 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 redireccionar la página, primero llama a signInWithRedirect().

Sigue las prácticas recomendadas cuando uses signInWithRedirect, linkWithRedirect o reauthenticateWithRedirect.

Versión web 9

import { getAuth, signInWithRedirect } from "firebase/auth";

const auth = getAuth();
signInWithRedirect(auth, provider);auth_signin_redirect.js

Versión web 8

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

Luego, llama a getRedirectResult() cuando tu página cargue para recuperar el token de GitHub:

Versión 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

Versión 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

Una vez que tengas un token de acceso, puedes usarlo para llamar a la API de GitHub. Por ejemplo:

REST

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

Permite que los usuarios accedan de forma manual

Si no deseas usar el SDK de cliente, también puedes manejar el flujo de acceso manualmente:

Para integrar la autenticación de GitHub en tu app, sigue los pasos de su documentación para desarrolladores.
Permite que el usuario acceda a GitHub mediante el flujo que implementaste en el paso anterior.
Intercambia el token que recibes de GitHub por una credencial de Identity Platform:
Versión web 9

Obtén más información sobre la API modular web que admite la eliminación de código no utilizado y realiza la actualización desde la API con espacio de nombres.
```
import { GithubAuthProvider } from "firebase/auth";

const credential = GithubAuthProvider.credential(token);auth_github_provider_credential.js
```
Versión web 8
```
var credential = firebase.auth.GithubAuthProvider.credential(token);github.js
```

Usa la credencial para que el usuario acceda con Identity Platform:

Versión 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

Versión 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

¿Qué sigue?

Obtén más información sobre los usuarios de Identity Platform.
Permite que los usuarios accedan con otros proveedores de identidad.