Home > @firebase/auth > GithubAuthProvider

GithubAuthProvider class

Provider for generating an OAuthCredential for ProviderId.GITHUB.

Signature:

export declare class GithubAuthProvider extends BaseOAuthProvider 

Extends: BaseOAuthProvider

Description

GitHub requires an OAuth 2.0 redirect, so you can either handle the redirect directly, or use the signInWithPopup() handler:

Example 1

// Sign in using a redirect.
const provider = new GithubAuthProvider();
// Start a sign in process for an unauthenticated user.
provider.addScope('repo');
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Github Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}

Example 2

// Sign in using a popup.
const provider = new GithubAuthProvider();
provider.addScope('repo');
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Github Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;

Constructors

Constructor	Modifiers	Description
(constructor)()		Constructs a new instance of the GithubAuthProvider class

Properties

Property	Modifiers	Type	Description
GITHUB_SIGN_IN_METHOD	static	(not declared)	Always set to SignInMethod.GITHUB.
PROVIDER_ID	static	(not declared)	Always set to ProviderId.GITHUB.

Methods

Method	Modifiers	Description
credential(accessToken)	static	Creates a credential for Github.
credentialFromError(error)	static	Used to extract the underlying OAuthCredential from a AuthError which was thrown during a sign-in, link, or reauthenticate operation.
credentialFromResult(userCredential)	static	Used to extract the underlying OAuthCredential from a UserCredential.