How to create a GitHub Enterprise OAuth application for Swimm
To authorize GitHub Enterprise for your organization, we will need you to create an OAuth application on your GitHub instance. Please follow these steps:
Create GitHub OAuth App
Create Application (3 steps)
- Create OAuth App
- Application Form
- Info for Swimm
- Navigate to your Organization's Account settings page and click
Developer Settings > OAuth Apps - Click
Register an applicationorNew OAuth App(if you already have existing apps).
Fill out the form with the details below:
- Application name: Swimm
- Homepage URL: https://app.swimm.io/
- Application description: Swimm OAuth Application
- Authorization callback URL:
| Network restrictions | Communicate with GitHub | Callback URL |
|---|---|---|
| No | - | https://app.swimm.io/githubAuth |
| Yes (a) | Whitelist Swimm's static IP address (Instructions) | https://app.swimm.io/githubAuth |
| Yes (b) | Swimm OAuth Local Server with a dedicated Docker container (Instructions) | https://app.swimm.io/localGitProviderAuth |
Lastly, click Register application.
After registering the application, you will be redirected to the Swimm OAuth application page. Here you will find the Client ID and Client Secret that you will need to send to Swimm.
- Upload the Swimm logo to the application: transparent or blue background.
- Click
Generate a new client secret Copy the Client ID, Client Secret, and GitHub Enterprise Server URL.
Reference: GitHub Docs - Creating an OAuth app