mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
Wim Van LaerandGitHub
699ed17918
# Which Problems Are Solved naming inconsistencies: Configuration <-> Settings # How the Problems Are Solved # Additional Changes # Additional Context - Closes #11282
91 lines
3.6 KiB
Plaintext
91 lines
3.6 KiB
Plaintext
---
|
|
title: Configure GitHub as an Identity Provider in ZITADEL
|
|
sidebar_label: GitHub
|
|
---
|
|
|
|
import GeneralConfigDescription from './_general_config_description.mdx';
|
|
import Intro from './_intro.mdx';
|
|
import CustomLoginPolicy from './_custom_login_policy.mdx';
|
|
import IDPsOverview from './_idps_overview.mdx';
|
|
import Activate from './_activate.mdx';
|
|
import TestSetup from './_test_setup.mdx';
|
|
import UnlinkedOAuth from './_unlinked_oauth.mdx';
|
|
import PrefillAction from './_prefill_action.mdx';
|
|
|
|
<Intro components={props.components} provider="GitHub"/>
|
|
|
|
## Open the GitHub Identity Provider Template
|
|
|
|
<IDPsOverview components={props.components} templates="GitHub or GitHub Enterprise Server"/>
|
|
|
|
Click on the ZITADEL Callback URL to copy it to your clipboard.
|
|
You will have to paste it to the GitHub OAuth application later.
|
|
|
|
|
|
|
|
## GitHub Configuration
|
|
|
|
### Register a new application
|
|
|
|
1. Create a new OAuth application
|
|
- For **GitHub** browse to the [Register a new OAuth application](https://github.com/settings/applications/new). You can find this link withing [Settings](https://github.com/settings/profile) - [Developer Settings](https://github.com/settings/apps) - - [OAuth Apps](https://github.com/settings/developers).
|
|
- For **GitHub Enterprise** go to your GitHub Enterprise home page and then to Settings - Developer Settings - OAuth Apps - Register a new application/New OAuth App
|
|
2. Fill in the application name and homepage URL.
|
|
3. [Paste the ZITADEL Callback URL you copied before](#open-the-github-identity-provider-template) to the Authorization callback URL field.
|
|
4. Click "Register application".
|
|
|
|
|
|
|
|
### Client ID and secret
|
|
|
|
After clicking "Register application", you see the detail page of the application you have just created.
|
|
Copy the client ID directly from the detail page.
|
|
Generate a new secret by clicking "Generate new client secret".
|
|
Make sure to save the secret, as you will not be able to show it again.
|
|
|
|
|
|
|
|
## ZITADEL Setup
|
|
|
|
Go back [to the GitHub provider template you opened before in ZITADEL](#open-the-github-identity-provider-template).
|
|
Add the [client ID and secret you created before when you registered your GitHub OAuth application](#client-id-and-secret).
|
|
|
|
You can optionally configure the following settings.
|
|
A useful default will be filled if you don't change anything.
|
|
|
|
**Scopes**: The scopes define which scopes will be sent to the provider, `openid`, `profile`, and `email` are prefilled.
|
|
This information is used to create and/or update the user within ZITADEL.
|
|
ZITADEL ensures that at least the `openid`-scope is always sent.
|
|
|
|
<GeneralConfigDescription components={props.components} provider_account="GitHub account" />
|
|
|
|
### Activate IdP
|
|
|
|
<Activate components={props.components} />
|
|
|
|
|
|
|
|
### Ensure your Login Policy allows External IDPs
|
|
|
|
<CustomLoginPolicy components={props.components} />
|
|
|
|
## Test the setup
|
|
|
|
<TestSetup components={props.components} loginscreen="your GitHub login"/>
|
|
|
|
|
|
|
|
|
|
|
|
<UnlinkedOAuth components={props.components} provider="GitHub"/>
|
|
|
|
|
|
|
|
## Optional: Add ZITADEL action to autofill userdata
|
|
|
|
<PrefillAction components={props.components} fields="firstname and lastname" provider="GitHub"/>
|
|
|
|
```js reference
|
|
https://github.com/zitadel/actions/blob/main/examples/github_identity_provider.js
|
|
```
|