GithubProvider

Use this provider to authenticate with Github.

import { GithubProvider } from "@openauthjs/openauth/provider/github"

export default issuer({
  providers: {
    github: GithubProvider({
      clientID: "1234567890",
      clientSecret: "0987654321"
    })
  }
})

---

Methods

GithubProvider

GithubProvider(config)

Parameters

• config GithubConfig

  The config for the provider.

Returns Provider

Create a Github OAuth2 provider.

GithubProvider({
  clientID: "1234567890",
  clientSecret: "0987654321"
})

GithubConfig

• clientID string

• clientSecret string

• pkce? boolean

• query? Record<string, string>

• scopes string[]

GithubConfig.clientID

Type string

The client ID.

This is just a string to identify your app.

{
  clientID: "my-client"
}

GithubConfig.clientSecret

Type string

The client secret.

This is a private key that’s used to authenticate your app. It should be kept secret.

{
  clientSecret: "0987654321"
}

GithubConfig.pkce?

Type boolean

Default false

Whether to use PKCE (Proof Key for Code Exchange) for the authorization code flow. Some providers like x.com require this.

GithubConfig.query?

Type Record<string, string>

Any additional parameters that you want to pass to the authorization endpoint.

{
  query: {
    access_type: "offline",
    prompt: "consent"
  }
}

GithubConfig.scopes

Type string[]

A list of OAuth scopes that you want to request.

{
  scopes: ["email", "profile"]
}