Skip to content

[CF1] GitHub IdP guide revision #23216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2025
Merged

[CF1] GitHub IdP guide revision #23216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96fc4c9
[CF1] GitHub IdP guide revision
deadlypants1973 Jun 24, 2025
3cfbf11
edits
deadlypants1973 Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed src/assets/images/cloudflare-one/identity/github/github2.png
View file
Open in desktop
Binary file not shown.
Binary file removed src/assets/images/cloudflare-one/identity/github/github4.png
View file
Open in desktop
Binary file not shown.
34 changes: 16 additions & 18 deletions src/content/docs/cloudflare-one/identity/idp-integration/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,49 @@ pcx_content_type: how-to
title: GitHub
---

Cloudflare Zero Trust allows your team to connect to your applications using their GitHub login. Administrators can build rules for specific individuals or using GitHub organizations. You do not need to have a GitHub organization to use the integration.
Cloudflare Zero Trust allows your team to connect to your applications using their GitHub login. You do not need to have a GitHub organization to use the integration.

## Set up GitHub Access

To configure GitHub access in both GitHub and Cloudflare Zero Trust:

1. Log in to GitHub.
1. Log in to [GitHub](https://github.com/).

2. Go to your account **Settings** > **Developer Settings**, select **OAuth Apps** and select **Register a new application**. The **Register a new OAuth application** window displays.
2. Go to your account **Settings** > **Developer Settings**.

![GitHub Register a new OAuth application window without any form fields completed](~/assets/images/cloudflare-one/identity/github/github2.png)
3. In **Developer Settings**, select **OAuth Apps** and select **New OAuth app**.

3. Enter an **Application name**. Your users will see this name on the login page.
4. On the **Register a new OAuth application** page, enter an **Application name**. Your users will see this application name on the login page.

4. In the **Homepage URL** field, enter your team domain:
5. In the **Homepage URL** field, enter your team domain:

```txt
https://<your-team-name>.cloudflareaccess.com
```

You can find your team name in Zero Trust under **Settings** > **Custom Pages**.
You can find your team name in [Zero Trust](https://one.dash.cloudflare.com) by going to **Settings** > **Custom Pages**.

5. In the GitHub **Authorization callback URL** field, enter the following URL:
6. In the GitHub **Authorization callback URL** field, enter the following URL:

```txt
https://<your-team-name>.cloudflareaccess.com/cdn-cgi/access/callback
```

6. Select **Register application**.
7. Select **Register application**.

7. Copy the **Client ID** and **Client Secret**.
8. Find the **Client ID** and **Client Secret**.

![GitHub Cloudflare Access App showing Client ID and Client secret](~/assets/images/cloudflare-one/identity/github/github4.png)
9. In [Zero Trust](https://one.dash.cloudflare.com), go to **Settings** > **Authentication**.

8. In Zero Trust, go to **Settings** > **Authentication**.
10. Under **Login methods**, select **Add new**.

9. Under **Login methods**, select **Add new**.
11. Choose **GitHub** on the next page.

10. Choose **GitHub** on the next page.
12. In the **App ID** field, copy and paste the **Client ID** you found in step 8. In the **Client secret** field, copy and paste the **Client secret** you found in step 8. You will need to select **Generate a new client secret** if one is not already displayed.

11. Paste in the **Client ID** and **Client secret**.
13. Select **Save**.

12. Select **Save**.

To test that your connection is working, go to **Authentication** > **Login methods** and select **Test** next to GitHub.
To test that your connection is working, go to [Zero Trust](https://one.dash.cloudflare.com) > **Authentication** > **Login methods** and select **Test** next to your GitHub login method.
If you have GitHub two-factor authentication enabled, you will need to first login to GitHub directly and return to Access.

## Example API Configuration
Expand Down
Loading