mirrors/n8n-docs
2
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
ce604d8ea4
n8n-docs/docs/integrations/builtin/credentials/github.md
freakwriter 9faddee8ad Update GitHub credential to template
2024-05-07 15:29:02 -04:00

2.8 KiB
Raw Blame History

title description contentType
GitHub credentials Documentation for GitHub credentials. Use these credentials to authenticate GitHub in n8n, a workflow automation platform. integration

GitHub credentials

You can use these credentials to authenticate the following nodes with GitHub.

Prerequisites

Create a GitHub{:target=_blank .external-link} account.

Supported authentication methods

  • API access token
  • OAuth2

Related resources

Refer to GitHub's API documentation{:target=_blank .external-link} for more information about the service.

Using API access token

To configure this credential, you'll need:

  • The URL for a GitHub server:
    • If you are not using GitHub Enterprise Server, keep the URL that n8n has prepopulated.
    • If you're using GitHub Enterprise Server{:target=_blank .external-link}, update this field to match the URL for your server.
  • A User name: Your username as it appears in your GitHub profile
  • An Access Token: n8n recommends using a personal access token (classic), since GitHub's fine-grained personal access tokens are still in beta and cannot access all endpoints. Refer to Creating a personal access token (classic){:target=_blank .external-link} and Creating a fine-grained personal access token{:target=_blank .external-link} for detailed steps on generating a new access token.

Using OAuth2

/// note | Note for n8n Cloud users You'll only need to enter the Credentials Name and select the Connect my account button in the OAuth credential to connect your Name account to n8n. ///

Should you need to configure OAuth2 from scratch or need more detail on what's happening in the OAuth web flow, you'll need to register a new OAuth app{:target=_blank .external-link}. Refer to that documentation for detailed instructions on creating a new app, and refer to the GitHub Authorizing OAuth apps documentation{:target=_blank .external-link} for more information on the authorization process.