Authenticate Using GitHub on iOS

You can let your users authenticate with Firebase using their GitHub accounts by integrating GitHub authentication into your app.

Authenticated users can access user-restricted data in Firebase Realtime Database and Cloud Storage.

Before you begin

  1. Add Firebase to your iOS project. Include the following pods in your Podfile:
    pod 'Firebase/Auth'
    
  2. Register your app as a developer application on GitHub and get your app's OAuth 2.0 Client ID and Client Secret.
  3. Enable GitHub authentication:
    1. In the Firebase console, open the Auth section.
    2. On the Sign in method tab, enable the GitHub sign-in method and specify the OAuth 2.0 Client ID and Client Secret you got from GitHub.
    3. Then, make sure your Firebase OAuth redirect URI (e.g. my-app-12345.firebaseapp.com/__/auth/handler) is set as your Authorization callback URL in your app's settings page on your GitHub app's config.

Authenticate with Firebase

  1. Integrate GitHub authentication into your app by following the developer's documentation. Use the web application flow, and set up a custom URL scheme in your app to handle the OAuth 2.0 callback from GitHub. At the end of the GitHub sign-in flow, you will receive an OAuth 2.0 access token.
  2. Import the Firebase module in your UIApplicationDelegate subclass:

    Swift

    import Firebase
    

    Objective-C

    @import Firebase;
    
  3. Configure a FIRApp shared instance, typically in your application's application:didFinishLaunchingWithOptions: method:

    Swift

    // Use Firebase library to configure APIs
    FirebaseApp.configure()
    

    Objective-C

    // Use Firebase library to configure APIs
    [FIRApp configure];
    
  4. After a user successfully signs in with GitHub, in your implementation of didCompleteWithResult:error:, exchange the OAuth 2.0 access token from GitHub for a Firebase credential:

    Objective-C

    FIRAuthCredential *credential =
        [FIRGitHubAuthProvider credentialWithToken:accessToken];
    

    Swift

    let credential =
        GitHubAuthProvider.credential(withToken: accessToken)
    
  5. Finally, authenticate with Firebase using the Firebase credential:

    Objective-C

    [[FIRAuth auth] signInWithCredential:credential
                              completion:^(FIRUser *user, NSError *error) {
      if (error) {
        // ...
        return;
      }
      // User successfully signed in. Get user data from the FIRUser object
      // ...
    }];
    

    Swift

    Auth.auth().signIn(with: credential) { (user, error) in
      if let error = error {
        // ...
        return
      }
      // User is signed in
      // ...
    }
    }
    

Next steps

After a user signs in for the first time, a new user account is created and linked to the credentials—that is, the user name and password, phone number, or auth provider information—the user signed in with. This new account is stored as part of your Firebase project, and can be used to identify a user across every app in your project, regardless of how the user signs in.

  • In your apps, you can get the user's basic profile information from the FIRUser object. See Manage Users.

  • In your Firebase Realtime Database and Cloud Storage Security Rules, you can get the signed-in user's unique user ID from the auth variable, and use it to control what data a user can access.

You can allow users to sign in to your app using multiple authentication providers by linking auth provider credentials to an existing user account.

To sign out a user, call signOut:.

Swift

    let firebaseAuth = Auth.auth()
do {
  try firebaseAuth.signOut()
} catch let signOutError as NSError {
  print ("Error signing out: %@", signOutError)
}
  

Objective-C

    NSError *signOutError;
BOOL status = [[FIRAuth auth] signOut:&signOutError];
if (!status) {
  NSLog(@"Error signing out: %@", signOutError);
  return;
}

You may also want to add error handling code for the full range of authentication errors. See Handle Errors.

Send feedback about...

Need help? Visit our support page.