GitHub でユーザーのログインを行う

このドキュメントでは、Identity Platform を使用して GitHub でユーザーのログインを行う方法について説明します。

始める前に

このチュートリアルは、すでに Identity Platform が有効であり、HTML と JavaScript を使用して作成された基本的なウェブアプリがあることを前提としています。Identity Platform を有効にしてログインする方法については、クイックスタートをご覧ください。

GitHub をプロバイダとして構成する

GitHub を ID プロバイダとして構成するには:

1. Google Cloud コンソールで [ID プロバイダ] ページに移動します。

   [ID プロバイダ] ページに移動

2. [プロバイダを追加] をクリックします。
3. リストから [GitHub] を選択します。
4. GitHub の [クライアント ID] と [クライアント シークレット] を入力します。ID とシークレットをまだ持っていない場合は、 GitHub アプリケーション ページから入手できます。
5. [GitHub を構成する] に表示されている URI を、GitHub アプリの有効な OAuth リダイレクト URI として構成します。Identity Platform でカスタム ドメインを構成した場合は、デフォルト ドメインではなくカスタム ドメインを使用するように、GitHub アプリの構成でリダイレクト URI を更新します。たとえば、https://myproject.firebaseapp.com/__/auth/handler を https://auth.myownpersonaldomain.com/__/auth/handler に変更します。
6. [プロジェクト設定] サイドペインで、[ドメインを追加] をクリックして、アプリのドメインを追加します。

   本番環境プロジェクトに localhost を含めないことをおすすめします。

   注: 2025 年 4 月 28 日より前に作成されたプロジェクトでは、localhost がデフォルトで有効になっています。
7. [アプリケーションの構成] セクションで、[詳細を設定] をクリックします。このスニペットをアプリのコードにコピーして、Identity Platform Client SDK を初期化します。
8. [保存] をクリックします。

クライアント SDK を使用してユーザーをログインさせる

1. GitHub プロバイダ オブジェクトのインスタンスを作成します。

   Web バージョン 9

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

   Web バージョン 8

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

2. 省略可: OAuth スコープを追加します。スコープでは、GitHub からリクエストするデータを指定します。より機密性の高いデータには、特定のスコープが必要になる場合があります。アプリが必要とするスコープを判断するには、プロバイダのドキュメントをご覧ください。

   Web バージョン 9

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

   Web バージョン 8

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

3. 省略可: 認証フローをローカライズします。言語を指定するか、デバイスのデフォルトの言語を使用できます。

   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

   Web バージョン 8

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

4. 省略可: その他のカスタム OAuth パラメータを指定します。これは GitHub 特有であり、通常は認証エクスペリエンスのカスタマイズに使用されます。OAuth または Identity Platform で予約されているパラメータを渡すことはできません。

   Web バージョン 9

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

   Web バージョン 8

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

5. GitHub プロバイダ オブジェクトを使用して、ユーザーのログインを行います。ポップアップ ウィンドウを開く、または現在のページをリダイレクトできます。モバイル デバイスでは、リダイレクトの方がユーザーにとってより簡単な方法です。

   ポップアップを表示するには、signInWithPopup() を呼び出します。

   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

   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

   ページをリダイレクトするには、まず signInWithRedirect() を呼び出します。

   signInWithRedirect、linkWithRedirect、reauthenticateWithRedirect を使用する場合は、ベスト プラクティスに従ってください。

   Web バージョン 9

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

   Web バージョン 8

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

   次に、ページが読み込まれるときに getRedirectResult() を呼び出すことによって、GitHub トークンを取得します。

   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

   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

アクセス トークンを取得したら、そのトークンを使用して GitHub API を呼び出すことができます。次に例を示します。

REST

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

ユーザーを手動でログインさせる

クライアント SDK を使用しない場合は、次の手順でログイン フローを手動で処理することもできます。

1. デベロッパー向けドキュメントの手順に沿って、GitHub 認証をアプリに統合します。
2. 前の手順で実装したフローを使用して、GitHub でユーザーのログインを行います。
3. GitHub から受け取ったトークンを Identity Platform の認証情報と交換します。

   Web バージョン 9

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

   Web バージョン 8

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

4. 認証情報を使用して、Identity Platform でユーザーのログインを行います。

   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

   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

次のステップ

• Identity Platform ユーザーの詳細を確認する。
• 他の ID プロバイダでユーザーのログインを行う。