Skip to content

Enhance content on installation access tokens for GitHub Apps #44116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mcummings128 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −1
Open

Enhance content on installation access tokens for GitHub Apps #44116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion ...g-with-a-github-app/generating-an-installation-access-token-for-a-github-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,13 @@

## About installation access tokens

In order to authenticate as an app installation, you must generate an installation access token. For more information about authenticating as an app installation, see [Authenticating as a GitHub App installation](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation).
In order to authenticate as an app installation, you must generate an installation access token. Installation access tokens are short-lived tokens whose scope is inherited from their associated Github App. These permissions can be further pared down per use case.

When you use an installation access token, it acts on behalf of the associated Github App. In other words, it is not tied to a user (as is the case with [personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#about-personal-access-tokens)).

Check failure on line 17 in content/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app.md

View workflow job for this annotation

GitHub Actions / lint-content

Custom rule 

docs-domain: Catch occurrences of docs.github.com domain.

Check failure on line 17 in content/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app.md

View workflow job for this annotation

GitHub Actions / lint-content

Strings that contain "personal access token" should use the product variable instead 

The string personal access tokens can be replaced with a variable. You should use one of the variables from data/variables/product.yml instead of the literal phrase(s).

For more information regarding installation access tokens and about authenticating as an app installation, see [Authenticating as a GitHub App installation](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation).

Installation access tokens are short-lived tokens whose scope is inherited from their associated Github App. These permissions can be further pared down per use case.

> [!NOTE]
> Instead of generating an installation access token, you can use {% data variables.product.company_short %}'s Octokit SDKs to authenticate as an app. The SDK will take care of generating an installation access token for you and will regenerate the token once it expires. For more information about authenticating as an app installation, see [Authenticating as a GitHub App installation](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation).
Expand Down
Loading