creating-an-oauth-app.md

title	Creating an OAuth app
intro	{% data reusables.shortdesc.creating_oauth_apps %}
redirect_from	/apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps /apps/building-oauth-apps/creating-an-oauth-app /developers/apps/creating-an-oauth-app /developers/apps/building-oauth-apps/creating-an-oauth-app
versions	fpt ghes ghec * * *
category	Build and manage OAuth apps

Note

Consider building a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}.

Both {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %} use OAuth 2.0.

{% data variables.product.prodname_oauth_apps %} can only act on behalf of a user while {% data variables.product.prodname_github_apps %} can either act on behalf of a user or independently of a user.

{% data variables.product.prodname_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 AUTOTITLE and AUTOTITLE.

{% ifversion fpt or ghec %}

Note

{% data reusables.apps.maximum-oauth-apps-allowed %}

{% endif %}

{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %}

1. Click New OAuth App.

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

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

   [!WARNING] Only use information in your {% data variables.product.prodname_oauth_app %} that you consider public. Avoid using sensitive data, such as internal URLs, when creating an {% data variables.product.prodname_oauth_app %}.

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

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

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

   {% ifversion fpt or ghec or ghes > 3.23 %}

   You can enter up to 10 callback URLs. To add additional callback URLs, click Add callback URL.

   {% else %}

   [!NOTE] {% data variables.product.prodname_oauth_apps %} cannot have multiple callback URLs, unlike {% data variables.product.prodname_github_apps %}.{% endif %}

6. If your {% data variables.product.prodname_oauth_app %} will use the device flow to identify and authorize users, click Enable Device Flow. For more information about the device flow, see AUTOTITLE.{% ifversion oauth-token-expiration %}

7. Expire user access tokens is enabled by default. If your app's authentication code hasn't been updated to support short-lived tokens, uncheck the box until support is added. For more information about expiring tokens, see AUTOTITLE.{% endif %}

8. Click Register application.

Further reading

• AUTOTITLE