-
Notifications
You must be signed in to change notification settings - Fork 60.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #24340 from github/repo-sync
repo sync
- Loading branch information
Showing
25 changed files
with
66 additions
and
265 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
...apps/authenticating-with-a-github-app/about-authentication-with-a-github-app.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: About authentication with a GitHub App | ||
intro: 'Your {% data variables.product.prodname_github_app %} can authenticate as itself, as an app installation, or on behalf of a user.' | ||
versions: | ||
fpt: '*' | ||
ghes: '*' | ||
ghae: '*' | ||
ghec: '*' | ||
topics: | ||
- GitHub Apps | ||
shortTitle: Authentication overview | ||
redirect_from: | ||
- /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps | ||
- /apps/building-github-apps/authentication-options-for-github-apps | ||
- /apps/building-github-apps/authenticating-with-github-apps | ||
- /developers/apps/authenticating-with-github-apps | ||
- /developers/apps/building-github-apps/authenticating-with-github-apps | ||
- /apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-github-apps | ||
--- | ||
|
||
## Authentication as a {% data variables.product.prodname_github_app %} | ||
|
||
Your app should authenticate as itself when it needs to generate an installation access token. An installation access token is required to authenticate as an app installation. Your app should also authenticate as itself when it needs to make API requests to manage resources related to the app. For example, when it needs to list the accounts where it is installed. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app)". | ||
|
||
## Authentication as an app installation | ||
|
||
Your app should authenticate as an app installation when you want to attribute app activity to the app. Authenticating as an app installation lets your app access resources that are owned by the user or organization that installed the app. Authenticating as an app installation is ideal for automation workflows that don't involve user input. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation)." | ||
|
||
## Authentication on behalf of a user | ||
|
||
Your app should authenticate on behalf of a user when you want to attribute app activity to a user. Similar to authenticating as an app installation, your app can access resources that are owned by the user or organization that installed the app. Authenticating on behalf of a user is ideal when you want to ensure that your app only takes actions that could be performed by a specific user. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/identifying-and-authorizing-users-for-github-apps)." |
231 changes: 0 additions & 231 deletions
231
...github-apps/authenticating-with-a-github-app/authenticating-with-github-apps.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.