Authenticate with GitHub

Configure GitHub as an external identity provider for Ignis.Auth. See Authentication for the overall flow and provider-selection behaviour.

Prerequisites

• A running Ignis instance with auth enabled (AuthSettings:ConnectionString configured)
• A GitHub account with permission to create OAuth Apps

1. Create a GitHub OAuth App

Go to GitHub Developer Settings and click New OAuth App.

After creating the app, generate a client secret and note both the Client ID and Client Secret.

2. Configure credentials

Use user-secrets for local development:

dotnet user-secrets set "AuthSettings:ExternalProviders:0:Name" "GitHub" --project src/Ignis.Api
dotnet user-secrets set "AuthSettings:ExternalProviders:0:Type" "GitHub" --project src/Ignis.Api
dotnet user-secrets set "AuthSettings:ExternalProviders:0:ClientId" "<client-id>" --project src/Ignis.Api
dotnet user-secrets set "AuthSettings:ExternalProviders:0:ClientSecret" "<client-secret>" --project src/Ignis.Api

Or in appsettings.json (do not commit secrets):

"AuthSettings": {
  "ExternalProviders": [
    {
      "Name": "GitHub",
      "Type": "GitHub",
      "ClientId": "<client-id>",
      "ClientSecret": "<client-secret>"
    }
  ]
}

For production, use environment variables:

AuthSettings__ExternalProviders__0__Name=GitHub
AuthSettings__ExternalProviders__0__Type=GitHub
AuthSettings__ExternalProviders__0__ClientId=<client-id>
AuthSettings__ExternalProviders__0__ClientSecret=<client-secret>

3. Test the login flow

Start the application and navigate to:

https://localhost:5201/connect/login

With GitHub configured as the only external provider, the endpoint auto-selects it and redirects to GitHub for authentication. After authorizing, you are redirected back and a session cookie is issued. Pass ?provider=GitHub explicitly when multiple providers are configured.

Mapped claims

The following GitHub user fields are mapped to session claims: