---
title: "GitHubAuthProfile"
source: "https://github.com/remix-run/remix/blob/8905f3943706e1f53696ab83e70a84873cabfc90/packages/auth/src/lib/providers/github.ts#L34"
---

# GitHubAuthProfile

## Summary

Profile fields returned by the built-in GitHub auth provider.

## Signature

```ts
interface GitHubAuthProfile {
  avatar_url?: string
  email?: string | null
  html_url?: string
  id: number
  login: string
  name?: string | null
}

```

## Properties

### `avatar_url`

Avatar image URL returned by GitHub, when available.

### `email`

Email returned in the GitHub profile, or a verified fallback address when available.

### `html_url`

Public GitHub profile URL, when available.

### `id`

Stable GitHub user identifier.

### `login`

GitHub login handle.

### `name`

Display name returned by GitHub, when available.