Creating an OAuth app

You can create and register an OAuth app under your personal account or under any organization you have administrative access to. While creating your OAuth app, remember to protect your privacy by only using information you consider public.

Note

Consider building a GitHub App instead of an OAuth app.

Both OAuth apps and GitHub Apps use OAuth 2.0.

OAuth apps can only act on behalf of a user while GitHub Apps can either act on behalf of a user or independently of a user.

GitHub Apps use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens.

For more information, see "Differences between GitHub Apps and OAuth apps" and "About creating GitHub Apps."

  1. In the upper-right corner of any page on GitHub, click your profile photo, then click Settings.

  2. In the left sidebar, click Developer settings.

  3. In the left sidebar, click OAuth apps.

  4. Click New OAuth App.

    Note

    If you haven't created an app before, this button will say, Register a new application.

  5. In "Application name", type the name of your app.

    Warning

    Only use information in your OAuth app that you consider public. Avoid using sensitive data, such as internal URLs, when creating an OAuth app.

  6. In "Homepage URL", type the full URL to your app's website.

  7. Optionally, in "Application description", type a description of your app that users will see.

  8. In "Authorization callback URL", type the callback URL of your app.

    Note

    OAuth apps cannot have multiple callback URLs, unlike GitHub Apps.

  9. If your OAuth app will use the device flow to identify and authorize users, click Enable Device Flow. For more information about the device flow, see "Authorizing OAuth apps."

  10. Click Register application.

Further reading