From 247d27cb354ce932072fc2f552595f5feb4a2cae Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Tue, 11 Jul 2023 08:31:44 -0700 Subject: [PATCH] Use plural app variables (#38856) --- .../about-creating-github-apps.md | 8 +-- ...est-practices-for-creating-a-github-app.md | 2 +- .../deciding-when-to-build-a-github-app.md | 38 ++++++------- .../migrating-oauth-apps-to-github-apps.md | 16 +++--- .../choosing-permissions-for-a-github-app.md | 6 +- ...ting-a-custom-badge-for-your-github-app.md | 2 +- .../making-a-github-app-public-or-private.md | 2 +- .../quickstart.md | 2 +- .../deleting-a-github-app.md | 4 +- .../transferring-ownership-of-a-github-app.md | 2 +- .../authorizing-oauth-apps.md | 4 +- ...est-practices-for-creating-an-oauth-app.md | 6 +- .../creating-an-oauth-app.md | 6 +- ...nces-between-github-apps-and-oauth-apps.md | 56 +++++++++---------- .../oauth-apps/building-oauth-apps/index.md | 2 +- .../rate-limits-for-oauth-apps.md | 2 +- .../scopes-for-oauth-apps.md | 2 +- .../apps/oauth-apps/using-oauth-apps/index.md | 2 +- content/apps/overview.md | 14 ++--- ...-available-for-github-enterprise-server.md | 4 +- ...ering-a-github-app-using-url-parameters.md | 2 +- .../about-using-github-apps.md | 18 +++--- .../authorizing-github-apps.md | 6 +- ...talling-a-github-app-from-a-third-party.md | 18 +++--- ...thub-marketplace-for-your-organizations.md | 12 ++-- ...b-marketplace-for-your-personal-account.md | 8 +-- ...ing-and-modifying-installed-github-apps.md | 16 +++--- ...d-revoking-authorization-of-github-apps.md | 2 +- .../using-github-apps/saml-and-github-apps.md | 6 +- .../about-authentication-to-github.md | 2 +- .../about-building-integrations.md | 4 +- .../about-using-integrations.md | 2 +- .../guides/forming-calls-with-graphql.md | 2 +- .../using-the-graphql-api-for-discussions.md | 2 +- ...ing-the-audit-log-for-your-organization.md | 2 +- ...cess-restrictions-for-your-organization.md | 2 +- ...cess-restrictions-for-your-organization.md | 2 +- ...rogrammatic-access-in-your-organization.md | 18 +++--- ...hub-apps-installed-in-your-organization.md | 6 +- content/rest/codespaces/organizations.md | 2 +- content/rest/oauth-authorizations/index.md | 2 +- .../oauth-authorizations.md | 4 +- content/rest/orgs/webhooks.md | 4 +- .../authenticating-to-the-rest-api.md | 4 +- .../permissions-required-for-github-apps.md | 2 +- content/rest/overview/troubleshooting.md | 2 +- .../webhooks/about-webhooks.md | 2 +- .../webhooks/replacing-github-services.md | 4 +- data/glossaries/external.yml | 4 +- .../apps/maximum-github-apps-allowed.md | 2 +- .../apps/maximum-oauth-apps-allowed.md | 2 +- .../apps/user-to-server-rate-limits.md | 2 +- .../audit_log/audit-log-action-categories.md | 6 +- data/reusables/getting-started/marketplace.md | 2 +- .../marketplace-apps-not-actions.md | 2 +- .../shortdesc/deleting_oauth_apps.md | 2 +- data/reusables/user-settings/github_apps.md | 2 +- data/reusables/webhooks/webhooks_intro.md | 2 +- 58 files changed, 181 insertions(+), 181 deletions(-) diff --git a/content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md b/content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md index 3a327c5d0e..3fa1906d5b 100644 --- a/content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md +++ b/content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md @@ -1,7 +1,7 @@ --- title: About creating GitHub Apps shortTitle: About creating apps -intro: '{% data variables.product.prodname_github_app %}s let you build integrations to automate processes and extend {% data variables.product.company_short %}''s functionality.' +intro: '{% data variables.product.prodname_github_apps %} let you build integrations to automate processes and extend {% data variables.product.company_short %}''s functionality.' versions: fpt: '*' ghes: '*' @@ -30,7 +30,7 @@ Common use cases for {% data variables.product.prodname_github_apps %} include: - As a developer tool, allowing users to work with {% data variables.product.prodname_dotcom %} by signing into your {% data variables.product.prodname_github_app %}, which can then act on their behalf - Integrating your tool or external service with {% data variables.product.company_short %} -Like {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_app %}s use OAuth 2.0 and can act on behalf of a user. Unlike {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_app %}s can also act independently of a user. +Like {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_apps %} use OAuth 2.0 and can act on behalf of a user. Unlike {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_apps %} can also act independently of a user. {% data variables.product.prodname_github_apps %} can be installed directly on organizations and personal accounts and granted access to specific repositories. They come with built-in webhooks and narrow, specific permissions. @@ -67,10 +67,10 @@ Some examples of automations you could create with a {% data variables.product.p - A {% data variables.product.prodname_github_app %} that helps repository contributors. For example, the app could post helpful resources after a contributor creates a pull request or makes a comment. - A {% data variables.product.prodname_github_app %} that generates short-lived tokens to give to other CI/CD tools, or to pull information from a repository. -### {% data variables.product.prodname_github_app %}s that respond to webhooks +### {% data variables.product.prodname_github_apps %} that respond to webhooks If you want your app to respond to events on {% data variables.product.prodname_dotcom %}, your app should subscribe to webhooks. For example, you may want your app to leave a comment when a pull request is opened. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/using-webhooks-with-github-apps)." -### {% data variables.product.prodname_github_app %}s that can take certain actions +### {% data variables.product.prodname_github_apps %} that can take certain actions When you set up your {% data variables.product.prodname_github_app %}, you can select specific permissions for the app. These permissions determine what the app can do via the {% data variables.product.prodname_dotcom %} API, what they can do on behalf of a signed in user, and what webhooks the app can receive. For more information, see "[AUTOTITLE](/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app)." diff --git a/content/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app.md b/content/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app.md index 593721325d..40a1cc68dc 100644 --- a/content/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app.md +++ b/content/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app.md @@ -69,7 +69,7 @@ If your app is a native client, client-side app, or runs on a user device (as op ## Use the appropriate token type -{% data variables.product.prodname_github_app %}s can generate installation access tokens or user access tokens in order to make authenticated API requests. +{% data variables.product.prodname_github_apps %} can generate installation access tokens or user access tokens in order to make authenticated API requests. Installation access tokens will attribute activity to your app. These are useful for automations that act independently of users. diff --git a/content/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app.md b/content/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app.md index fc5db99e9e..cfb347be58 100644 --- a/content/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app.md +++ b/content/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app.md @@ -13,51 +13,51 @@ topics: ## Using a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %} -In general, {% data variables.product.prodname_github_app %}s are preferred over {% data variables.product.prodname_oauth_app %}s. +In general, {% data variables.product.prodname_github_apps %} are preferred over {% data variables.product.prodname_oauth_apps %}. -Both {% data variables.product.prodname_oauth_app %}s and {% data variables.product.prodname_github_app %}s use OAuth 2.0. +Both {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %} use OAuth 2.0. -{% data variables.product.prodname_oauth_app %}s can only act on behalf of a user while {% data variables.product.prodname_github_app %}s can either act on behalf of a user or independently of a user. +{% 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. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)." For information on how to migrate an existing {% data variables.product.prodname_oauth_app %} to a {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/guides/migrating-oauth-apps-to-github-apps)." -### {% data variables.product.prodname_github_app %}s offer enhanced security +### {% data variables.product.prodname_github_apps %} offer enhanced security -{% data variables.product.prodname_github_app %}s provide more control over what the app can do. Instead of the broad scopes that {% data variables.product.prodname_oauth_app %}s use, {% data variables.product.prodname_github_app %}s use fine-grained permissions. For example, if your app needs to read the contents of a repository, an {% data variables.product.prodname_oauth_app %} would require the `repo` scope, which would also let the app edit the repository contents and settings. A {% data variables.product.prodname_github_app %} can request read-only access to repository contents, which will not let the app take more privileged actions like editing the repository contents or settings. +{% data variables.product.prodname_github_apps %} provide more control over what the app can do. Instead of the broad scopes that {% data variables.product.prodname_oauth_apps %} use, {% data variables.product.prodname_github_apps %} use fine-grained permissions. For example, if your app needs to read the contents of a repository, an {% data variables.product.prodname_oauth_app %} would require the `repo` scope, which would also let the app edit the repository contents and settings. A {% data variables.product.prodname_github_app %} can request read-only access to repository contents, which will not let the app take more privileged actions like editing the repository contents or settings. -{% data variables.product.prodname_github_app %}s also offer more control over repository access. With a {% data variables.product.prodname_github_app %}, the user or organization owner who installed the app can decide what repositories the app can access. Conversely, an {% data variables.product.prodname_oauth_app %} can access every repository that the user who authorized the app can access. +{% data variables.product.prodname_github_apps %} also offer more control over repository access. With a {% data variables.product.prodname_github_app %}, the user or organization owner who installed the app can decide what repositories the app can access. Conversely, an {% data variables.product.prodname_oauth_app %} can access every repository that the user who authorized the app can access. -{% data variables.product.prodname_github_app %}s use short lived tokens. If the token is leaked, the token will be valid for a shorter amount of time, which reduces the damage that can be done. Conversely, {% data variables.product.prodname_oauth_app %} tokens do not expire until the person who authorized the {% data variables.product.prodname_oauth_app %} revokes the token. +{% data variables.product.prodname_github_apps %} use short lived tokens. If the token is leaked, the token will be valid for a shorter amount of time, which reduces the damage that can be done. Conversely, {% data variables.product.prodname_oauth_app %} tokens do not expire until the person who authorized the {% data variables.product.prodname_oauth_app %} revokes the token. These security features help harden your {% data variables.product.prodname_github_app %}'s security by limiting the damage that could be done if your app's credentials were leaked. Additionally, this lets organizations with stricter security policies use your app. -### {% data variables.product.prodname_github_app %}s can act independently of or on behalf of a user +### {% data variables.product.prodname_github_apps %} can act independently of or on behalf of a user -{% data variables.product.prodname_github_app %}s can act independently of a user. This is beneficial for automations that do not require user input. +{% data variables.product.prodname_github_apps %} can act independently of a user. This is beneficial for automations that do not require user input. -Similar to {% data variables.product.prodname_oauth_app %}s, {% data variables.product.prodname_github_app %}s can still take actions on behalf of a user. Unlike {% data variables.product.prodname_oauth_app %}s, which don't indicate that the action was performed by the app, {% data variables.product.prodname_github_app %}s indicate that the action was performed by the app on behalf of the user. +Similar to {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_apps %} can still take actions on behalf of a user. Unlike {% data variables.product.prodname_oauth_apps %}, which don't indicate that the action was performed by the app, {% data variables.product.prodname_github_apps %} indicate that the action was performed by the app on behalf of the user. -{% data variables.product.prodname_github_app %}s are not tied to a user account and do not consume a seat on {% data variables.product.product_name %}. {% data variables.product.prodname_github_app %}s remain installed even when the person who initially installed the app leaves the organization. This lets your integrations continue to work even if people leave your team. +{% data variables.product.prodname_github_apps %} are not tied to a user account and do not consume a seat on {% data variables.product.product_name %}. {% data variables.product.prodname_github_apps %} remain installed even when the person who initially installed the app leaves the organization. This lets your integrations continue to work even if people leave your team. -### {% data variables.product.prodname_github_app %}s have scalable rate limits +### {% data variables.product.prodname_github_apps %} have scalable rate limits -The rate limit for {% data variables.product.prodname_github_app %}s using an installation access token scales with the number of repositories and number of organization users. Conversely, {% data variables.product.prodname_oauth_apps %} have lower rate limits and do not scale. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/rate-limits-for-github-apps)." +The rate limit for {% data variables.product.prodname_github_apps %} using an installation access token scales with the number of repositories and number of organization users. Conversely, {% data variables.product.prodname_oauth_apps %} have lower rate limits and do not scale. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/rate-limits-for-github-apps)." -### {% data variables.product.prodname_github_app %}s have built in webhooks +### {% data variables.product.prodname_github_apps %} have built in webhooks -{% data variables.product.prodname_github_app %}s have built-in, centralized webhooks. {% data variables.product.prodname_github_app %}s can receive webhook events for all repositories and organizations the app can access. Conversely, {% data variables.product.prodname_oauth_app %}s must configure webhooks individually for each repository and organization. +{% data variables.product.prodname_github_apps %} have built-in, centralized webhooks. {% data variables.product.prodname_github_apps %} can receive webhook events for all repositories and organizations the app can access. Conversely, {% data variables.product.prodname_oauth_apps %} must configure webhooks individually for each repository and organization. ### API access differs slightly -In general, {% data variables.product.prodname_github_app %}s and {% data variables.product.prodname_oauth_app %}s can make the same API requests. However, there are some differences: +In general, {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} can make the same API requests. However, there are some differences: -- The REST API to manage check runs and check suites is only available to {% data variables.product.prodname_github_app %}s. -- Enterprise-level resources such as the enterprise object itself are not available to {% data variables.product.prodname_github_app %}s. This means that {% data variables.product.prodname_github_app %}s cannot call endpoints like `GET /enterprise/settings/license`. However, enterprise-owned organization and repository resources are available. +- The REST API to manage check runs and check suites is only available to {% data variables.product.prodname_github_apps %}. +- Enterprise-level resources such as the enterprise object itself are not available to {% data variables.product.prodname_github_apps %}. This means that {% data variables.product.prodname_github_apps %} cannot call endpoints like `GET /enterprise/settings/license`. However, enterprise-owned organization and repository resources are available. - Some requests may return incomplete data depending on the permissions and repository access that was granted to an {% data variables.product.prodname_github_app %}. For example, if your app makes a request to get all repositories that a user can access, the response will only include the repositories that the app was also granted access to. -For more information about the REST API endpoints that are available to {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/rest/overview/endpoints-available-for-github-apps)." +For more information about the REST API endpoints that are available to {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/rest/overview/endpoints-available-for-github-apps)." ## Choosing between a {% data variables.product.prodname_github_app %} or a {% data variables.product.pat_generic %} diff --git a/content/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md b/content/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md index 87525608b7..5fc3b2cc60 100644 --- a/content/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md +++ b/content/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md @@ -14,12 +14,12 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: 'Migrate from {% data variables.product.prodname_oauth_app %}s' +shortTitle: 'Migrate from {% data variables.product.prodname_oauth_apps %}' --- -## Benefits of migrating from {% data variables.product.prodname_oauth_app %}s to {% data variables.product.prodname_github_app %}s +## Benefits of migrating from {% data variables.product.prodname_oauth_apps %} to {% data variables.product.prodname_github_apps %} -{% data variables.product.prodname_github_app %}s are the recommended way to integrate with {% data variables.product.company_short %}. {% data variables.product.prodname_github_app %}s offer many advantages over {% data variables.product.prodname_oauth_app %}s, including: +{% data variables.product.prodname_github_apps %} are the recommended way to integrate with {% data variables.product.company_short %}. {% data variables.product.prodname_github_apps %} offer many advantages over {% data variables.product.prodname_oauth_apps %}, including: - enhanced security features, like fine-grained permissions, choice over repository access, and short lived tokens - the ability to act independently of or on behalf of a user @@ -36,7 +36,7 @@ The following steps provide an overview of how to migrate from an {% data variab Re-familiarize yourself with the code for your {% data variables.product.prodname_oauth_app %}. The API requests that your {% data variables.product.prodname_oauth_app %} makes will help you decide what permissions to select for your {% data variables.product.prodname_github_app %}. -Additionally, there are a few REST API endpoints that are not available for {% data variables.product.prodname_oauth_app %}s. Verify that any REST endpoints that you use are available for {% data variables.product.prodname_github_app %}s by reviewing "[AUTOTITLE](/rest/overview/endpoints-available-for-github-apps)." +Additionally, there are a few REST API endpoints that are not available for {% data variables.product.prodname_oauth_apps %}. Verify that any REST endpoints that you use are available for {% data variables.product.prodname_github_apps %} by reviewing "[AUTOTITLE](/rest/overview/endpoints-available-for-github-apps)." ### 2. Register a {% data variables.product.prodname_github_app %} @@ -46,7 +46,7 @@ Compared to an {% data variables.product.prodname_oauth_app %}, you have more co - Unlike an {% data variables.product.prodname_oauth_app %}, which always acts on behalf of a user, you can make your {% data variables.product.prodname_github_app %} take actions as itself or on behalf of a user. If you do not want your new {% data variables.product.prodname_github_app %} to take actions on behalf of a user, you can skip the "Identifying and authorizing users" settings. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)." -- You can use webhooks to notify your {% data variables.product.prodname_github_app %} when specific events occur. Unlike webhooks for {% data variables.product.prodname_oauth_app %}s, which you must configure via the API for each repository or organization, webhooks are built into {% data variables.product.prodname_github_app %}s. When you register your {% data variables.product.prodname_github_app %}, you can select the webhook events that you want to receive. Additionally, if your {% data variables.product.prodname_oauth_app %} currently uses polling to determine if an event had occurred, consider subscribing to webhooks instead to help your {% data variables.product.prodname_github_app %} stay within the rate limit. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps)." +- You can use webhooks to notify your {% data variables.product.prodname_github_app %} when specific events occur. Unlike webhooks for {% data variables.product.prodname_oauth_apps %}, which you must configure via the API for each repository or organization, webhooks are built into {% data variables.product.prodname_github_apps %}. When you register your {% data variables.product.prodname_github_app %}, you can select the webhook events that you want to receive. Additionally, if your {% data variables.product.prodname_oauth_app %} currently uses polling to determine if an event had occurred, consider subscribing to webhooks instead to help your {% data variables.product.prodname_github_app %} stay within the rate limit. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps)." - With an {% data variables.product.prodname_oauth_app %}, you request scopes when a user authorizes your app. With a {% data variables.product.prodname_github_app %}, you specify permissions in the app settings. These permissions are more granular than scopes and enable you to only select the permissions that your app needs. Additionally, these permissions are mapped to REST API endpoints and webhook events, so you can easily determine what permissions your {% data variables.product.prodname_github_app %} needs in order to access a specific REST API endpoint or subscribe to a specific webhook. Permissions are not currently documented for GraphQL requests. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/choosing-permissions-for-a-github-app)." @@ -66,7 +66,7 @@ If you are using {% data variables.product.company_short %}'s official Octokit.j #### Review rate limits -Review the differences in rate limits between {% data variables.product.prodname_oauth_app %}s and {% data variables.product.prodname_github_app %}s. {% data variables.product.prodname_github_app %}s use sliding rules for rate limits, which can increase based on the number of repositories and number of users in the organization. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/rate-limits-for-github-apps)." +Review the differences in rate limits between {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %}. {% data variables.product.prodname_github_apps %} use sliding rules for rate limits, which can increase based on the number of repositories and number of users in the organization. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/rate-limits-for-github-apps)." If possible, consider using conditional requests and subscribing to webhooks instead of polling to help you stay within rate limits. For more information about conditional requests, see "[AUTOTITLE](/rest/overview/resources-in-the-rest-api#conditional-requests)." For more information about using webhooks with your {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps)" and "[AUTOTITLE](/apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events)." @@ -97,7 +97,7 @@ To pre-select any repositories your {% data variables.product.prodname_oauth_app For example: `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/YOUR_APP_NAME/installations/new/permissions?suggested_target_id=ID_OF_USER_OR_ORG&repository_ids[]=REPO_A_ID&repository_ids[]=REPO_B_ID`. -For more information about installing {% data variables.product.prodname_github_app %}s, see {% ifversion ghec or fpt %}"[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account)," "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations),"{% endif %} "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)" and "[AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app)." +For more information about installing {% data variables.product.prodname_github_apps %}, see {% ifversion ghec or fpt %}"[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account)," "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations),"{% endif %} "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)" and "[AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app)." #### Prompt users to authorize your app @@ -105,7 +105,7 @@ If you want your {% data variables.product.prodname_github_app %} to make API re To prompt users to authorize your app, you will lead them through the web application flow or device flow. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)." -For more information about authorizing {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." +For more information about authorizing {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." #### Encourage your users to revoke {% data variables.product.prodname_oauth_app %} access diff --git a/content/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app.md b/content/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app.md index 07e4007056..6a09bca992 100644 --- a/content/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app.md +++ b/content/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app.md @@ -22,9 +22,9 @@ topics: ## About {% data variables.product.prodname_github_app %} permissions -{% data variables.product.prodname_github_app %}s don't have any permissions by default. When you register a {% data variables.product.prodname_github_app %}, you can select permissions for the app. The permissions that you select determine what the app can do with {% data variables.product.company_short %}'s APIs and what webhooks the app can subscribe to. You should select the minimum permissions required for the app. +{% data variables.product.prodname_github_apps %} don't have any permissions by default. When you register a {% data variables.product.prodname_github_app %}, you can select permissions for the app. The permissions that you select determine what the app can do with {% data variables.product.company_short %}'s APIs and what webhooks the app can subscribe to. You should select the minimum permissions required for the app. -Although {% data variables.product.prodname_github_app %}s don't have any permissions by default, they do have implicit permissions to read public resources when acting on behalf of a user. When a user authorizes the app to act on their behalf, the {% data variables.product.prodname_github_app %} can use the resulting user access token to make requests to the REST API{% ifversion graphQL-for-fgpats-and-apps %} and the GraphQL API{% endif %} to read public resources. To learn more about acting on behalf of a user, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." +Although {% data variables.product.prodname_github_apps %} don't have any permissions by default, they do have implicit permissions to read public resources when acting on behalf of a user. When a user authorizes the app to act on their behalf, the {% data variables.product.prodname_github_app %} can use the resulting user access token to make requests to the REST API{% ifversion graphQL-for-fgpats-and-apps %} and the GraphQL API{% endif %} to read public resources. To learn more about acting on behalf of a user, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." App permissions are classified as repository, organization, or account permissions. Repository permissions allow your app to access resources related to repositories that are owned by the account where the app is installed. Organization permissions allow your app to access resources related to the organization where the app is installed, if it is installed on an organization account. Account permissions allow your app to access resources related to a user if the user has also authorized your app. For more information about user authorization of apps, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." @@ -40,7 +40,7 @@ For more information about specifying permissions during {% data variables.produ ## Choosing permissions for webhook access -The webhook documentation indicates whether each webhook is available to {% data variables.product.prodname_github_app %}s. For each webhook that you want to subscribe to, refer to the webhook documentation to see what permissions a {% data variables.product.prodname_github_app %} needs to subscribe to that webhook. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads)." +The webhook documentation indicates whether each webhook is available to {% data variables.product.prodname_github_apps %}. For each webhook that you want to subscribe to, refer to the webhook documentation to see what permissions a {% data variables.product.prodname_github_app %} needs to subscribe to that webhook. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads)." For example, if you want your app to subscribe to `team` events, your app must have the "Members" organization permission. diff --git a/content/apps/creating-github-apps/registering-a-github-app/creating-a-custom-badge-for-your-github-app.md b/content/apps/creating-github-apps/registering-a-github-app/creating-a-custom-badge-for-your-github-app.md index 66a25a26b3..1e897aa669 100644 --- a/content/apps/creating-github-apps/registering-a-github-app/creating-a-custom-badge-for-your-github-app.md +++ b/content/apps/creating-github-apps/registering-a-github-app/creating-a-custom-badge-for-your-github-app.md @@ -29,7 +29,7 @@ After you register a GitHub App, you can customize your app's badge by uploading {% ifversion fpt or ghec %} -For more information about badges for {% data variables.product.prodname_github_app %}s in {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app#guidelines-for-logos)." You can change a custom badge for a GitHub App that already has an approved Marketplace listing by navigating to https://github.com/marketplace/manage. +For more information about badges for {% data variables.product.prodname_github_apps %} in {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app#guidelines-for-logos)." You can change a custom badge for a GitHub App that already has an approved Marketplace listing by navigating to https://github.com/marketplace/manage. {% endif %} diff --git a/content/apps/creating-github-apps/registering-a-github-app/making-a-github-app-public-or-private.md b/content/apps/creating-github-apps/registering-a-github-app/making-a-github-app-public-or-private.md index ec40fe1b03..c5db98fe98 100644 --- a/content/apps/creating-github-apps/registering-a-github-app/making-a-github-app-public-or-private.md +++ b/content/apps/creating-github-apps/registering-a-github-app/making-a-github-app-public-or-private.md @@ -21,7 +21,7 @@ topics: shortTitle: Visibility --- -## About visibility for {% data variables.product.prodname_github_app %}s +## About visibility for {% data variables.product.prodname_github_apps %} You can make your {% data variables.product.prodname_github_app %} registration public or private. {% ifversion fpt %}If you set your {% data variables.product.prodname_github_app %} registration to public, any user on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_ghe_cloud %} can install it. If you set your {% data variables.product.prodname_github_app %} registration to private, it can only be installed on the account that owns the app. diff --git a/content/apps/creating-github-apps/writing-code-for-a-github-app/quickstart.md b/content/apps/creating-github-apps/writing-code-for-a-github-app/quickstart.md index 4507dc1c60..0e515cb4df 100644 --- a/content/apps/creating-github-apps/writing-code-for-a-github-app/quickstart.md +++ b/content/apps/creating-github-apps/writing-code-for-a-github-app/quickstart.md @@ -16,7 +16,7 @@ redirect_from: ## Introduction -{% data variables.product.prodname_github_app %}s let you automate processes or integrate other platforms with {% data variables.product.company_short %}. For more info, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/about-apps)." +{% data variables.product.prodname_github_apps %} let you automate processes or integrate other platforms with {% data variables.product.company_short %}. For more info, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/about-apps)." This quickstart describes how to quickly create a {% data variables.product.prodname_github_app %}. When a pull request is opened in a repository that the app was granted access to, the app will add a comment to the pull request. diff --git a/content/apps/maintaining-github-apps/deleting-a-github-app.md b/content/apps/maintaining-github-apps/deleting-a-github-app.md index 226afe3f66..e7a7d1954d 100644 --- a/content/apps/maintaining-github-apps/deleting-a-github-app.md +++ b/content/apps/maintaining-github-apps/deleting-a-github-app.md @@ -1,7 +1,7 @@ --- title: Deleting a GitHub App shortTitle: Delete your app -intro: 'You can delete {% data variables.product.prodname_github_app %}s that you own if you no longer want to use or maintain the app.' +intro: 'You can delete {% data variables.product.prodname_github_apps %} that you own if you no longer want to use or maintain the app.' redirect_from: - /apps/building-integrations/managing-github-apps/deleting-a-github-app - /apps/managing-github-apps/deleting-a-github-app @@ -22,7 +22,7 @@ topics: {% endnote %} -## About deleting {% data variables.product.prodname_github_app %}s +## About deleting {% data variables.product.prodname_github_apps %} If you own a {% data variables.product.prodname_github_app %} or are an app manager for a {% data variables.product.prodname_github_app %}, you can delete the {% data variables.product.prodname_github_app %} registration. For more information about {% data variables.product.prodname_github_app %} managers, see "[AUTOTITLE](/apps/maintaining-github-apps/about-github-app-managers)." diff --git a/content/apps/maintaining-github-apps/transferring-ownership-of-a-github-app.md b/content/apps/maintaining-github-apps/transferring-ownership-of-a-github-app.md index bf6668ee7d..689842e3a1 100644 --- a/content/apps/maintaining-github-apps/transferring-ownership-of-a-github-app.md +++ b/content/apps/maintaining-github-apps/transferring-ownership-of-a-github-app.md @@ -16,7 +16,7 @@ topics: shortTitle: Transfer ownership --- -## About transferring {% data variables.product.prodname_github_app %}s +## About transferring {% data variables.product.prodname_github_apps %} The owner of a {% data variables.product.prodname_github_app %} registration can transfer ownership of the {% data variables.product.prodname_github_app %} registration to another user or organization. If an organization has designated any app managers for an app owned by the organization, the app managers can also transfer ownership of the {% data variables.product.prodname_github_app %} registration. For more information about app managers, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization)." diff --git a/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md index f57126e585..3bc2122ad1 100644 --- a/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md @@ -23,9 +23,9 @@ topics: **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_app %}s and {% data variables.product.prodname_github_app %}s use OAuth 2.0. +Both {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %} use OAuth 2.0. -{% data variables.product.prodname_github_app %}s can act on behalf of a user, similar to an {% data variables.product.prodname_oauth_app %}, or as themselves, which is beneficial for automations that do not require user input. Additionally, {% data variables.product.prodname_github_app %}s 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](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." +{% data variables.product.prodname_github_apps %} can act on behalf of a user, similar to an {% data variables.product.prodname_oauth_app %}, or as themselves, which is beneficial for automations that do not require user input. Additionally, {% 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](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." {% endnote %} diff --git a/content/apps/oauth-apps/building-oauth-apps/best-practices-for-creating-an-oauth-app.md b/content/apps/oauth-apps/building-oauth-apps/best-practices-for-creating-an-oauth-app.md index 412f7c3064..48e45f8229 100644 --- a/content/apps/oauth-apps/building-oauth-apps/best-practices-for-creating-an-oauth-app.md +++ b/content/apps/oauth-apps/building-oauth-apps/best-practices-for-creating-an-oauth-app.md @@ -13,11 +13,11 @@ topics: ## Use a {% data variables.product.prodname_github_app %} instead -If possible, consider using a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}. In general, {% data variables.product.prodname_github_app %}s are preferred over {% data variables.product.prodname_oauth_apps %}. {% data variables.product.prodname_github_app %}s use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. These properties can harden the security of your app by limiting the damage that could be done if your app's credentials are leaked. +If possible, consider using a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}. In general, {% data variables.product.prodname_github_apps %} are preferred over {% data variables.product.prodname_oauth_apps %}. {% 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. These properties can harden the security of your app by limiting the damage that could be done if your app's credentials are leaked. -Similar to {% data variables.product.prodname_oauth_app %}s, {% data variables.product.prodname_github_app %}s can still use OAuth 2.0 and generate a type of OAuth token (called a user access token) and take actions on behalf of a user. However, {% data variables.product.prodname_github_app %}s can also act independently of a user. +Similar to {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_apps %} can still use OAuth 2.0 and generate a type of OAuth token (called a user access token) and take actions on behalf of a user. However, {% data variables.product.prodname_github_apps %} can also act independently of a user. -For more information about {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." +For more information about {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." For more information about migrating an existing {% data variables.product.prodname_oauth_app %} to a {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/guides/migrating-oauth-apps-to-github-apps)." diff --git a/content/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md b/content/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md index 495a3b2eac..fa516ab23c 100644 --- a/content/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md +++ b/content/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app.md @@ -19,11 +19,11 @@ topics: **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_app %}s and {% data variables.product.prodname_github_app %}s use OAuth 2.0. +Both {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %} use OAuth 2.0. -{% data variables.product.prodname_oauth_app %}s can only act on behalf of a user while {% data variables.product.prodname_github_app %}s can either act on behalf of a user or independently of a user. +{% 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_app %}s use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. +{% 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](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." diff --git a/content/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md index 78b43a036c..2aef5971aa 100644 --- a/content/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps.md @@ -1,6 +1,6 @@ --- title: Differences between GitHub Apps and OAuth apps -intro: 'In general, {% data variables.product.prodname_github_app %}s are preferred to {% data variables.product.prodname_oauth_app %}s because they use fine-grained permissions, give more control over which repositories the app can access, and use short-lived tokens.' +intro: 'In general, {% data variables.product.prodname_github_apps %} are preferred to {% data variables.product.prodname_oauth_apps %} because they use fine-grained permissions, give more control over which repositories the app can access, and use short-lived tokens.' redirect_from: - /early-access/integrations/integrations-vs-oauth-applications - /apps/building-integrations/setting-up-a-new-integration/about-choosing-an-integration-type @@ -17,59 +17,59 @@ versions: topics: - GitHub Apps - OAuth apps -shortTitle: GitHub Apps & {% data variables.product.prodname_oauth_app %}s +shortTitle: GitHub Apps & {% data variables.product.prodname_oauth_apps %} --- -## About {% data variables.product.prodname_github_app %}s and {% data variables.product.prodname_oauth_app %}s +## About {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} -In general, {% data variables.product.prodname_github_app %}s are preferred over {% data variables.product.prodname_oauth_app %}s. {% data variables.product.prodname_github_app %}s use fine grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. These properties can harden the security of your app by limiting the damage that could be done if your app's credentials were leaked. +In general, {% data variables.product.prodname_github_apps %} are preferred over {% data variables.product.prodname_oauth_apps %}. {% 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. These properties can harden the security of your app by limiting the damage that could be done if your app's credentials were leaked. -Similar to {% data variables.product.prodname_oauth_app %}s, {% data variables.product.prodname_github_app %}s can still use OAuth 2.0 and generate a type of OAuth token (called a user access token) and take actions on behalf of a user. However, {% data variables.product.prodname_github_app %}s can also act independently of a user. This is beneficial for automations that do not require user input. The app will continue to work even if the person who installed the app on an organization leaves the organization. +Similar to {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_github_apps %} can still use OAuth 2.0 and generate a type of OAuth token (called a user access token) and take actions on behalf of a user. However, {% data variables.product.prodname_github_apps %} can also act independently of a user. This is beneficial for automations that do not require user input. The app will continue to work even if the person who installed the app on an organization leaves the organization. -{% data variables.product.prodname_github_app %}s have built-in, centralized webhooks. {% data variables.product.prodname_github_app %}s can receive webhook events for all repositories and organizations the app can access. Conversely, {% data variables.product.prodname_oauth_app %}s must configure webhooks individually for each repository and organization. +{% data variables.product.prodname_github_apps %} have built-in, centralized webhooks. {% data variables.product.prodname_github_apps %} can receive webhook events for all repositories and organizations the app can access. Conversely, {% data variables.product.prodname_oauth_apps %} must configure webhooks individually for each repository and organization. -The rate limit for {% data variables.product.prodname_github_app %}s using an installation access token scales with the number of repositories and number of organization users. Conversely, {% data variables.product.prodname_oauth_app %}s have lower rate limits and do not scale. +The rate limit for {% data variables.product.prodname_github_apps %} using an installation access token scales with the number of repositories and number of organization users. Conversely, {% data variables.product.prodname_oauth_apps %} have lower rate limits and do not scale. -There is one case where an {% data variables.product.prodname_oauth_app %} is preferred over a {% data variables.product.prodname_github_app %}. If your app needs to access enterprise-level resources such as the enterprise object itself, you should use an {% data variables.product.prodname_oauth_app %} because a {% data variables.product.prodname_github_app %} cannot yet be given permissions against an enterprise. {% data variables.product.prodname_github_app %}s can still access enterprise-owned organization and repository resources. +There is one case where an {% data variables.product.prodname_oauth_app %} is preferred over a {% data variables.product.prodname_github_app %}. If your app needs to access enterprise-level resources such as the enterprise object itself, you should use an {% data variables.product.prodname_oauth_app %} because a {% data variables.product.prodname_github_app %} cannot yet be given permissions against an enterprise. {% data variables.product.prodname_github_apps %} can still access enterprise-owned organization and repository resources. -For more information about {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." +For more information about {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." For more information about migrating an existing {% data variables.product.prodname_oauth_app %} to a {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/guides/migrating-oauth-apps-to-github-apps)." -## Who can install GitHub Apps and authorize {% data variables.product.prodname_oauth_app %}s? +## Who can install GitHub Apps and authorize {% data variables.product.prodname_oauth_apps %}? You can install GitHub Apps in your personal account or organizations you own. If you have admin permissions in a repository, you can install GitHub Apps on organization accounts. If a GitHub App is installed in a repository and requires organization permissions, the organization owner must approve the application. {% data reusables.apps.app_manager_role %} -By contrast, users authorize {% data variables.product.prodname_oauth_app %}s, which gives the app the ability to act as the authenticated user. For example, you can authorize an {% data variables.product.prodname_oauth_app %} that finds all notifications for the authenticated user. You can always revoke permissions from an {% data variables.product.prodname_oauth_app %}. +By contrast, users authorize {% data variables.product.prodname_oauth_apps %}, which gives the app the ability to act as the authenticated user. For example, you can authorize an {% data variables.product.prodname_oauth_app %} that finds all notifications for the authenticated user. You can always revoke permissions from an {% data variables.product.prodname_oauth_app %}. {% ifversion limit-app-access-requests %} {% data reusables.organizations.restricted-app-access-requests %}{% endif %} {% data reusables.apps.deletes_ssh_keys %} -| GitHub Apps | {% data variables.product.prodname_oauth_app %}s | +| GitHub Apps | {% data variables.product.prodname_oauth_apps %} | | ----- | ------ | | You must be an organization owner or have admin permissions in a repository to install a GitHub App on an organization. If a GitHub App is installed in a repository and requires organization permissions, the organization owner must approve the application. | You can authorize an {% data variables.product.prodname_oauth_app %} to have access to resources. | | You can install a GitHub App on your personal repository. | You can authorize an {% data variables.product.prodname_oauth_app %} to have access to resources.| | You must be an organization owner, personal repository owner, or have admin permissions in a repository to uninstall a GitHub App and remove its access. | You can delete an OAuth access token to remove access. | | You must be an organization owner or have admin permissions in a repository to request a GitHub App installation. | If an organization application policy is active, any organization member can request to install an {% data variables.product.prodname_oauth_app %} on an organization. An organization owner must approve or deny the request. | -## What can GitHub Apps and {% data variables.product.prodname_oauth_app %}s access? +## What can GitHub Apps and {% data variables.product.prodname_oauth_apps %} access? Account owners can use a {% data variables.product.prodname_github_app %} in one account without granting access to another. For example, you can install a third-party build service on your employer's organization, but decide not to grant that build service access to repositories in your personal account. A GitHub App remains installed if the person who set it up leaves the organization. An _authorized_ {% data variables.product.prodname_oauth_app %} has access to all of the user's or organization owner's accessible resources. -| GitHub Apps | {% data variables.product.prodname_oauth_app %}s | +| GitHub Apps | {% data variables.product.prodname_oauth_apps %} | | ----- | ------ | | Installing a GitHub App grants the app access to a user or organization account's chosen repositories. | Authorizing an {% data variables.product.prodname_oauth_app %} grants the app access to the user's accessible resources. For example, repositories they can access. | | The installation token from a GitHub App loses access to resources if an admin removes repositories from the installation. | An OAuth access token loses access to resources when the user loses access, such as when they lose write access to a repository. | | Installation access tokens are limited to specified repositories with the permissions chosen by the creator of the app. | An OAuth access token is limited via scopes. | -| GitHub Apps can request separate access to issues and pull requests without accessing the actual contents of the repository. | {% data variables.product.prodname_oauth_app %}s need to request the `repo` scope to get access to issues, pull requests, or anything owned by the repository. | +| GitHub Apps can request separate access to issues and pull requests without accessing the actual contents of the repository. | {% data variables.product.prodname_oauth_apps %} need to request the `repo` scope to get access to issues, pull requests, or anything owned by the repository. | | GitHub Apps aren't subject to organization application policies. A GitHub App only has access to the repositories an organization owner has granted. | If an organization application policy is active, only an organization owner can authorize the installation of an {% data variables.product.prodname_oauth_app %}. If installed, the {% data variables.product.prodname_oauth_app %} gains access to anything visible to the token the organization owner has within the approved organization. | -| A GitHub App receives a webhook event when an installation is changed or removed. This tells the app creator when they've received more or less access to an organization's resources. | {% data variables.product.prodname_oauth_app %}s can lose access to an organization or repository at any time based on the granting user's changing access. The {% data variables.product.prodname_oauth_app %} will not inform you when it loses access to a resource. | +| A GitHub App receives a webhook event when an installation is changed or removed. This tells the app creator when they've received more or less access to an organization's resources. | {% data variables.product.prodname_oauth_apps %} can lose access to an organization or repository at any time based on the granting user's changing access. The {% data variables.product.prodname_oauth_app %} will not inform you when it loses access to a resource. | ## Token-based identification @@ -79,7 +79,7 @@ An _authorized_ {% data variables.product.prodname_oauth_app %} has access to al {% endnote %} -| GitHub Apps | {% data variables.product.prodname_oauth_app %}s | +| GitHub Apps | {% data variables.product.prodname_oauth_apps %} | | ----- | ----------- | | A GitHub App can request an installation access token by using a private key with a JSON web token format out-of-band. | An {% data variables.product.prodname_oauth_app %} can exchange a request token for an access token after a redirect via a web request. | | An installation token identifies the app as the GitHub Apps bot, such as @jenkins-bot. | An access token identifies the app as the user who granted the token to the app, such as @octocat. | @@ -90,11 +90,11 @@ An _authorized_ {% data variables.product.prodname_oauth_app %} has access to al ## Requesting permission levels for resources -Unlike {% data variables.product.prodname_oauth_app %}s, GitHub Apps have targeted permissions that allow them to request access only to what they need. For example, a Continuous Integration (CI) GitHub App can request read access to repository content and write access to the status API. Another GitHub App can have no read or write access to code but still have the ability to manage issues, labels, and milestones. {% data variables.product.prodname_oauth_app %}s can't use granular permissions. +Unlike {% data variables.product.prodname_oauth_apps %}, GitHub Apps have targeted permissions that allow them to request access only to what they need. For example, a Continuous Integration (CI) GitHub App can request read access to repository content and write access to the status API. Another GitHub App can have no read or write access to code but still have the ability to manage issues, labels, and milestones. {% data variables.product.prodname_oauth_apps %} can't use granular permissions. {% rowheaders %} -| Access | GitHub Apps (`read` or `write` permissions) | {% data variables.product.prodname_oauth_app %}s | +| Access | GitHub Apps (`read` or `write` permissions) | {% data variables.product.prodname_oauth_apps %} | | ------ | ----- | ----------- | | **For access to public repositories** | Public repository needs to be chosen during installation. | `public_repo` scope. | | **For access to repository code/contents** | Repository contents | `repo` scope. | @@ -108,24 +108,24 @@ Unlike {% data variables.product.prodname_oauth_app %}s, GitHub Apps have target ## Repository discovery -| GitHub Apps | {% data variables.product.prodname_oauth_app %}s | +| GitHub Apps | {% data variables.product.prodname_oauth_apps %} | | ----- | ----------- | -| GitHub Apps can look at `/installation/repositories` to see repositories the installation can access. | {% data variables.product.prodname_oauth_app %}s can look at `/user/repos` for a user view or `/orgs/:org/repos` for an organization view of accessible repositories. | -| GitHub Apps receive webhooks when repositories are added or removed from the installation. | {% data variables.product.prodname_oauth_app %}s create organization webhooks for notifications when a new repository is created within an organization. | +| GitHub Apps can look at `/installation/repositories` to see repositories the installation can access. | {% data variables.product.prodname_oauth_apps %} can look at `/user/repos` for a user view or `/orgs/:org/repos` for an organization view of accessible repositories. | +| GitHub Apps receive webhooks when repositories are added or removed from the installation. | {% data variables.product.prodname_oauth_apps %} create organization webhooks for notifications when a new repository is created within an organization. | ## Webhooks -| GitHub Apps | {% data variables.product.prodname_oauth_app %}s | +| GitHub Apps | {% data variables.product.prodname_oauth_apps %} | | ----- | ----------- | -| By default, GitHub Apps have a single webhook that receives the events they are configured to receive for every repository they have access to. | {% data variables.product.prodname_oauth_app %}s request the webhook scope to create a repository webhook for each repository they need to receive events from. | -| GitHub Apps receive certain organization-level events with the organization member's permission. | {% data variables.product.prodname_oauth_app %}s request the organization webhook scope to create an organization webhook for each organization they need to receive organization-level events from. | +| By default, GitHub Apps have a single webhook that receives the events they are configured to receive for every repository they have access to. | {% data variables.product.prodname_oauth_apps %} request the webhook scope to create a repository webhook for each repository they need to receive events from. | +| GitHub Apps receive certain organization-level events with the organization member's permission. | {% data variables.product.prodname_oauth_apps %} request the organization webhook scope to create an organization webhook for each organization they need to receive organization-level events from. | | Webhooks are automatically disabled when the GitHub App is uninstalled. | Webhooks are not automatically disabled if an {% data variables.product.prodname_oauth_app %}'s access token is deleted, and there is no way to clean them up automatically. You will have to ask users to do this manually.| ## Git access -| GitHub Apps | {% data variables.product.prodname_oauth_app %}s | +| GitHub Apps | {% data variables.product.prodname_oauth_apps %} | | ----- | ----------- | -| GitHub Apps ask for repository contents permission and use your installation access token to authenticate via HTTP-based Git. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app)"| {% data variables.product.prodname_oauth_app %}s ask for `write:public_key` scope and [Create a deploy key](/rest/deployments#create-a-deploy-key) via the API. You can then use that key to perform Git commands. | +| GitHub Apps ask for repository contents permission and use your installation access token to authenticate via HTTP-based Git. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app)"| {% data variables.product.prodname_oauth_apps %} ask for `write:public_key` scope and [Create a deploy key](/rest/deployments#create-a-deploy-key) via the API. You can then use that key to perform Git commands. | | The token is used as the HTTP password. | The token is used as the HTTP username. | ## Machine vs. bot accounts @@ -134,7 +134,7 @@ Machine user accounts are OAuth-based personal accounts that segregate automated Bot accounts are specific to GitHub Apps and are built into every GitHub App. -| GitHub Apps | {% data variables.product.prodname_oauth_app %}s | +| GitHub Apps | {% data variables.product.prodname_oauth_apps %} | | ----- | ----------- | | GitHub App bots do not consume a {% data variables.product.prodname_enterprise %} seat. | A machine user account consumes a {% data variables.product.prodname_enterprise %} seat. | | Because a GitHub App bot is never granted a password, a customer can't sign into it directly. | A machine user account is granted a username and password to be managed and secured by the customer. | diff --git a/content/apps/oauth-apps/building-oauth-apps/index.md b/content/apps/oauth-apps/building-oauth-apps/index.md index 6864f87f47..364ca7b2b6 100644 --- a/content/apps/oauth-apps/building-oauth-apps/index.md +++ b/content/apps/oauth-apps/building-oauth-apps/index.md @@ -1,6 +1,6 @@ --- title: Building OAuth apps -intro: You can build {% data variables.product.prodname_oauth_app %}s for yourself or others to use. Learn how to register and set up permissions and authorization options for {% data variables.product.prodname_oauth_app %}s. +intro: You can build {% data variables.product.prodname_oauth_apps %} for yourself or others to use. Learn how to register and set up permissions and authorization options for {% data variables.product.prodname_oauth_apps %}. redirect_from: - /apps/building-integrations/setting-up-and-registering-oauth-apps - /apps/building-oauth-apps diff --git a/content/apps/oauth-apps/building-oauth-apps/rate-limits-for-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/rate-limits-for-oauth-apps.md index 4f68eb1ab2..0781b65029 100644 --- a/content/apps/oauth-apps/building-oauth-apps/rate-limits-for-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/rate-limits-for-oauth-apps.md @@ -13,7 +13,7 @@ shortTitle: Rate limits {% note %} -**Note**: Consider building a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}. The rate limit for {% data variables.product.prodname_github_app %}s using an installation access token scales with the number of repositories and number of organization users. Conversely, {% data variables.product.prodname_oauth_app %}s have lower rate limits and do not scale. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." +**Note**: Consider building a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}. The rate limit for {% data variables.product.prodname_github_apps %} using an installation access token scales with the number of repositories and number of organization users. Conversely, {% data variables.product.prodname_oauth_apps %} have lower rate limits and do not scale. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." {% endnote %} diff --git a/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md index b0a4e03d97..a7e4053b38 100644 --- a/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -18,7 +18,7 @@ topics: {% note %} -**Note**: Consider building a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}. {% data variables.product.prodname_github_app %}s use fine-grained permissions instead of scopes, which give you more control over what your app can do. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." +**Note**: Consider building a {% data variables.product.prodname_github_app %} instead of an {% data variables.product.prodname_oauth_app %}. {% data variables.product.prodname_github_apps %} use fine-grained permissions instead of scopes, which give you more control over what your app can do. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." {% endnote %} diff --git a/content/apps/oauth-apps/using-oauth-apps/index.md b/content/apps/oauth-apps/using-oauth-apps/index.md index eb15b40c3d..36c72e78d0 100644 --- a/content/apps/oauth-apps/using-oauth-apps/index.md +++ b/content/apps/oauth-apps/using-oauth-apps/index.md @@ -1,6 +1,6 @@ --- title: Using OAuth apps -intro: 'You can authorize third-party {% data variables.product.prodname_oauth_app %}s, and review the {% data variables.product.prodname_oauth_app %}s you authorized.' +intro: 'You can authorize third-party {% data variables.product.prodname_oauth_apps %}, and review the {% data variables.product.prodname_oauth_apps %} you authorized.' versions: fpt: '*' ghes: '*' diff --git a/content/apps/overview.md b/content/apps/overview.md index b9f002be3f..75dbdd4888 100644 --- a/content/apps/overview.md +++ b/content/apps/overview.md @@ -1,7 +1,7 @@ --- title: GitHub Apps overview shortTitle: Overview -intro: 'You can use {% data variables.product.prodname_github_app %}s to extend the functionality of {% data variables.product.company_short %}.' +intro: 'You can use {% data variables.product.prodname_github_apps %} to extend the functionality of {% data variables.product.company_short %}.' allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -13,14 +13,14 @@ topics: - GitHub Apps --- -## About {% data variables.product.prodname_github_app %}s +## About {% data variables.product.prodname_github_apps %} -{% data variables.product.prodname_github_app %}s are tools that extend {% data variables.product.company_short %}'s functionality. {% data variables.product.prodname_github_app %}s can do things on {% data variables.product.company_short %} like open issues, comment on pull requests, and manage projects. They can also do things outside of {% data variables.product.company_short %} based on events that happen on {% data variables.product.company_short %}. For example, a {% data variables.product.prodname_github_app %} can post on Slack when an issue is opened on {% data variables.product.company_short %}. +{% data variables.product.prodname_github_apps %} are tools that extend {% data variables.product.company_short %}'s functionality. {% data variables.product.prodname_github_apps %} can do things on {% data variables.product.company_short %} like open issues, comment on pull requests, and manage projects. They can also do things outside of {% data variables.product.company_short %} based on events that happen on {% data variables.product.company_short %}. For example, a {% data variables.product.prodname_github_app %} can post on Slack when an issue is opened on {% data variables.product.company_short %}. -For more information about using {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/using-github-apps/about-using-github-apps)." +For more information about using {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/apps/using-github-apps/about-using-github-apps)." -For more information about building {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." +For more information about building {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." -## {% data variables.product.prodname_github_app %}s and {% data variables.product.prodname_oauth_apps %} +## {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} -{% data variables.product.company_short %} also supports {% data variables.product.prodname_oauth_apps %}. In general, {% data variables.product.prodname_github_app %}s are preferred over {% data variables.product.prodname_oauth_apps %}. {% data variables.product.prodname_github_app %}s use fine-grained permissions, give the user more control over which repositories the app can access, and use short-lived tokens. These properties can harden the security of the app by limiting the damage that could be done if the app's credentials were leaked. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)." +{% data variables.product.company_short %} also supports {% data variables.product.prodname_oauth_apps %}. In general, {% data variables.product.prodname_github_apps %} are preferred over {% data variables.product.prodname_oauth_apps %}. {% 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. These properties can harden the security of the app by limiting the damage that could be done if the app's credentials were leaked. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)." diff --git a/content/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md b/content/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md index 360c59ebc0..487fa8a60b 100644 --- a/content/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md +++ b/content/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server.md @@ -13,7 +13,7 @@ redirect_from: - /apps/creating-github-apps/setting-up-a-github-app/making-your-github-app-available-for-github-enterprise-server --- -## About developing {% data variables.product.prodname_github_app %}s for {% data variables.product.prodname_ghe_server %} +## About developing {% data variables.product.prodname_github_apps %} for {% data variables.product.prodname_ghe_server %} If you want your {% data variables.product.prodname_github_app %} to be available to organizations in a {% data variables.product.prodname_ghe_server %} instance that you are not part of, you must take the following steps. @@ -25,7 +25,7 @@ If {% data variables.product.prodname_ghe_server %} access is important, conside ## Each {% data variables.product.prodname_ghe_server %} instance must register their own {% data variables.product.prodname_github_app %} -Organizations owned by a {% data variables.product.prodname_ghe_server %} instance cannot install {% data variables.product.prodname_github_app %}s registered on {% data variables.product.prodname_dotcom_the_website %} or on another {% data variables.product.prodname_ghe_server %} instance. Instead, they must register and install their own {% data variables.product.prodname_github_app %} for use on that instance. +Organizations owned by a {% data variables.product.prodname_ghe_server %} instance cannot install {% data variables.product.prodname_github_apps %} registered on {% data variables.product.prodname_dotcom_the_website %} or on another {% data variables.product.prodname_ghe_server %} instance. Instead, they must register and install their own {% data variables.product.prodname_github_app %} for use on that instance. 1. The app developer creates a manifest or URL parameters. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-using-url-parameters)." 1. The app developer shares the manifest or URL parameters with the {% data variables.product.prodname_ghe_server %} instance that wants to use the app. The same manifest or URL parameters can be shared with multiple {% data variables.product.prodname_ghe_server %} instances. diff --git a/content/apps/sharing-github-apps/registering-a-github-app-using-url-parameters.md b/content/apps/sharing-github-apps/registering-a-github-app-using-url-parameters.md index 5ad4fed55a..0b45fb51ad 100644 --- a/content/apps/sharing-github-apps/registering-a-github-app-using-url-parameters.md +++ b/content/apps/sharing-github-apps/registering-a-github-app-using-url-parameters.md @@ -17,7 +17,7 @@ topics: - GitHub Apps shortTitle: App query parameters --- -## About URL parameters for registering {% data variables.product.prodname_github_app %}s +## About URL parameters for registering {% data variables.product.prodname_github_apps %} You can use URL parameters to preselect the configuration settings of a new {% data variables.product.prodname_github_app %} registration and share a custom link with other people. The link will take people to a {% data variables.product.prodname_github_app %} registration page, where the app settings will be pre-filled according to the URL parameters you included in the URL. diff --git a/content/apps/using-github-apps/about-using-github-apps.md b/content/apps/using-github-apps/about-using-github-apps.md index 6666af8c1d..b4accc16ca 100644 --- a/content/apps/using-github-apps/about-using-github-apps.md +++ b/content/apps/using-github-apps/about-using-github-apps.md @@ -11,18 +11,18 @@ topics: - GitHub Apps --- -## About {% data variables.product.prodname_github_app %}s +## About {% data variables.product.prodname_github_apps %} -{% data variables.product.prodname_github_app %}s are tools that extend {% data variables.product.company_short %}'s functionality. {% data variables.product.prodname_github_app %}s can do things on {% data variables.product.company_short %} like open issues, comment on pull requests, and manage projects. They can also do things outside of {% data variables.product.company_short %} based on events that happen on {% data variables.product.company_short %}. For example, a {% data variables.product.prodname_github_app %} can post on Slack when an issue is opened on {% data variables.product.company_short %}. +{% data variables.product.prodname_github_apps %} are tools that extend {% data variables.product.company_short %}'s functionality. {% data variables.product.prodname_github_apps %} can do things on {% data variables.product.company_short %} like open issues, comment on pull requests, and manage projects. They can also do things outside of {% data variables.product.company_short %} based on events that happen on {% data variables.product.company_short %}. For example, a {% data variables.product.prodname_github_app %} can post on Slack when an issue is opened on {% data variables.product.company_short %}. -## Finding {% data variables.product.prodname_github_app %}s +## Finding {% data variables.product.prodname_github_apps %} {% ifversion fpt or ghec %} -You can discover {% data variables.product.prodname_github_app %}s on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). {% else %}You cannot install third-party applications on your enterprise. If you want to use the functionality of a third-party app, you can contact the app developer about creating an app from a manifest or from URL parameters. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-using-url-parameters)."{% endif %} +You can discover {% data variables.product.prodname_github_apps %} on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). {% else %}You cannot install third-party applications on your enterprise. If you want to use the functionality of a third-party app, you can contact the app developer about creating an app from a manifest or from URL parameters. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-using-url-parameters)."{% endif %} You can also build your own {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." -## Using {% data variables.product.prodname_github_app %}s +## Using {% data variables.product.prodname_github_apps %} In order to use a {% data variables.product.prodname_github_app %}, you must install the app on your user or organization account. When you install the app, you grant the app permission to read or modify your repository and organization data. The specific permissions depends on the app, and {% data variables.product.company_short %} will tell you what permissions the app requested before you install the app. When you install the app, you will also specify what repositories the app can access. If the app requires any additional configuration, the app will direct you to do so. For more information, see {% ifversion ghec or fpt %}"[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account)," "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations),"{% endif %} "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)" and "[AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app)." @@ -32,12 +32,12 @@ Occasionally, the {% data variables.product.prodname_github_app %} will request Before you install or authorize a {% data variables.product.prodname_github_app %}, you should make sure that you trust the app developer. If you no longer use the app, you should suspend or uninstall the app and/or revoke your authorization of the app. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access)" and "[AUTOTITLE](/apps/using-github-apps/reviewing-your-authorized-integrations)." -## {% data variables.product.prodname_github_app %}s and {% data variables.product.prodname_oauth_app %}s +## {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} -{% data variables.product.company_short %} also supports {% data variables.product.prodname_oauth_app %}s. Unlike {% data variables.product.prodname_github_app %}s, you do not install an {% data variables.product.prodname_oauth_app %} or control what repositories it can access. +{% data variables.product.company_short %} also supports {% data variables.product.prodname_oauth_apps %}. Unlike {% data variables.product.prodname_github_apps %}, you do not install an {% data variables.product.prodname_oauth_app %} or control what repositories it can access. -Both {% data variables.product.prodname_oauth_app %}s and {% data variables.product.prodname_github_app %}s use OAuth 2.0. +Both {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %} use OAuth 2.0. -{% data variables.product.prodname_oauth_app %}s can only act on behalf of a user, while {% data variables.product.prodname_github_app %}s can either act on behalf of a user or independently of a user. +{% 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. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)." diff --git a/content/apps/using-github-apps/authorizing-github-apps.md b/content/apps/using-github-apps/authorizing-github-apps.md index c9242b3a01..6e48571140 100644 --- a/content/apps/using-github-apps/authorizing-github-apps.md +++ b/content/apps/using-github-apps/authorizing-github-apps.md @@ -16,7 +16,7 @@ redirect_from: - /authentication/keeping-your-account-and-data-secure/authorizing-github-apps --- -## About authorizing {% data variables.product.prodname_github_app %}s +## About authorizing {% data variables.product.prodname_github_apps %} Third-party applications that need to verify your {% data variables.product.company_short %} identity or interact with {% data variables.product.company_short %} on your behalf can ask you to authorize a {% data variables.product.prodname_github_app %} to do so. If a third-party application wants you to authorize a {% data variables.product.prodname_github_app %}, the application will bring you to a {% data variables.product.company_short %} page that prompts you to authorize the app. @@ -24,7 +24,7 @@ When authorizing the {% data variables.product.prodname_github_app %}, you shoul - Verify your {% data variables.product.company_short %} identity: When authorized, the {% data variables.product.prodname_github_app %} will be able to retrieve your public GitHub profile. The app may also be able to retrieve some private account information. During the authorization process, {% data variables.product.company_short %} will tell you which account information the {% data variables.product.prodname_github_app %} will be able to access. - Know which resources you can access: When authorized, the {% data variables.product.prodname_github_app %} will be able to determine which resources you can access that the app can also access. The app may use this, for example, so that it can show you an appropriate list of repositories. -- Act on your behalf: When authorized, the application may perform tasks on {% data variables.product.company_short %} on your behalf. This might include creating an issue or commenting on a pull request. For more information, see "[About {% data variables.product.prodname_github_app %}s acting on your behalf](#about-github-apps-acting-on-your-behalf)." +- Act on your behalf: When authorized, the application may perform tasks on {% data variables.product.company_short %} on your behalf. This might include creating an issue or commenting on a pull request. For more information, see "[About {% data variables.product.prodname_github_apps %} acting on your behalf](#about-github-apps-acting-on-your-behalf)." You can review and revoke your authorization at any time. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-your-authorized-integrations)." @@ -36,7 +36,7 @@ You can review and revoke your authorization at any time. For more information, {% endnote %} {% endif %} -## About {% data variables.product.prodname_github_app %}s acting on your behalf +## About {% data variables.product.prodname_github_apps %} acting on your behalf Once you authorize a {% data variables.product.prodname_github_app %}, the app can act on your behalf. The situations in which a {% data variables.product.prodname_github_app %} acts on your behalf vary according to the purpose of the {% data variables.product.prodname_github_app %} and the context in which it is being used. For example, an integrated development environment (IDE) may use a {% data variables.product.prodname_github_app %} to interact on your behalf in order to push changes you have authored through the IDE back to repositories on {% data variables.product.company_short %}. diff --git a/content/apps/using-github-apps/installing-a-github-app-from-a-third-party.md b/content/apps/using-github-apps/installing-a-github-app-from-a-third-party.md index b551ca2596..179125a37b 100644 --- a/content/apps/using-github-apps/installing-a-github-app-from-a-third-party.md +++ b/content/apps/using-github-apps/installing-a-github-app-from-a-third-party.md @@ -1,6 +1,6 @@ --- title: Installing a GitHub App from a third party -intro: 'You can install {% data variables.product.prodname_github_app %}s directly from the app owner to use on your personal account or organizations.' +intro: 'You can install {% data variables.product.prodname_github_apps %} directly from the app owner to use on your personal account or organizations.' versions: fpt: '*' ghec: '*' @@ -11,15 +11,15 @@ shortTitle: Install from third party {% ifversion ghes or ghae %} -You cannot install third-party {% data variables.product.prodname_github_app %}s on organizations owned by your instance.{% ifversion ghes %} If you want to use the functionality of a third-party {% data variables.product.prodname_github_app %}, you can contact the app developer about making the {% data variables.product.prodname_github_app %} available for {% data variables.product.prodname_ghe_server %}. For more information, see "[AUTOTITLE](/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server)."{% endif %} +You cannot install third-party {% data variables.product.prodname_github_apps %} on organizations owned by your instance.{% ifversion ghes %} If you want to use the functionality of a third-party {% data variables.product.prodname_github_app %}, you can contact the app developer about making the {% data variables.product.prodname_github_app %} available for {% data variables.product.prodname_ghe_server %}. For more information, see "[AUTOTITLE](/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server)."{% endif %} -For more information about installing {% data variables.product.prodname_github_app %}s that you own, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app)." +For more information about installing {% data variables.product.prodname_github_apps %} that you own, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app)." {% else %} -## About installing {% data variables.product.prodname_github_app %}s +## About installing {% data variables.product.prodname_github_apps %} -This article describes how to install a {% data variables.product.prodname_github_app %} directly from the app owner instead of from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-personal-account)" and "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-organization)." For more information about installing {% data variables.product.prodname_github_app %}s that you own, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app)." +This article describes how to install a {% data variables.product.prodname_github_app %} directly from the app owner instead of from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_apps %} from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-personal-account)" and "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-organization)." For more information about installing {% data variables.product.prodname_github_apps %} that you own, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app)." {% data reusables.apps.about-installation %} @@ -29,15 +29,15 @@ After you install a {% data variables.product.prodname_github_app %}, you may al {% data reusables.apps.install-vs-authorize %} -For more information about authorizing {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." +For more information about authorizing {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." ## Requirements to install a {% data variables.product.prodname_github_app %} -Anyone can install {% data variables.product.prodname_github_app %}s on their personal account. +Anyone can install {% data variables.product.prodname_github_apps %} on their personal account. -Organization owners can install {% data variables.product.prodname_github_app %}s on their organization. +Organization owners can install {% data variables.product.prodname_github_apps %} on their organization. -Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_app %}s on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization resources. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_app %}s. +Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_apps %} on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization resources. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_apps %}. Organization members who are not organization owners or repository admins can still select the organization during the install process. Instead of installing the app, {% data variables.product.company_short %} will send a notification to the organization owner to request the organization owner to install the app. diff --git a/content/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations.md b/content/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations.md index e77a1fd241..c76f1be4ea 100644 --- a/content/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations.md +++ b/content/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations.md @@ -1,7 +1,7 @@ --- title: Installing a GitHub App from GitHub Marketplace for your organizations intro: >- - You can install {% data variables.product.prodname_github_app %}s from {% data + You can install {% data variables.product.prodname_github_apps %} from {% data variables.product.prodname_marketplace %} to use on your organizations. redirect_from: - /articles/installing-an-app-in-your-organization @@ -18,7 +18,7 @@ shortTitle: Install from Marketplace for org ## About {% data variables.product.prodname_marketplace %} -This article applies to installing and purchasing {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_app %}s from a source other than {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)." +This article applies to installing and purchasing {% data variables.product.prodname_github_apps %} from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_apps %} from a source other than {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)." If you install a {% data variables.product.prodname_github_app %} on your organization account and you choose a paid plan, you will pay for your app subscription on your organization's current billing date using your organization's existing payment method. @@ -26,7 +26,7 @@ If you install a {% data variables.product.prodname_github_app %} on your organi For more information about installing an {% data variables.product.prodname_oauth_app %} instead of a {% data variables.product.prodname_github_app %} from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization)." -## About installing {% data variables.product.prodname_github_app %}s +## About installing {% data variables.product.prodname_github_apps %} {% data reusables.apps.about-installation %} @@ -36,13 +36,13 @@ After you install a {% data variables.product.prodname_github_app %}, you may al {% data reusables.apps.install-vs-authorize %} -For more information about authorizing {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." +For more information about authorizing {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." ## Requirements to install a {% data variables.product.prodname_github_app %} on an organization -Organization owners can install {% data variables.product.prodname_github_app %}s on their organization. +Organization owners can install {% data variables.product.prodname_github_apps %} on their organization. -Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_app %}s on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization resources. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_app %}s. +Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_apps %} on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization resources. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_apps %}. The "app manager" role in an organization does not give a person the ability to install a {% data variables.product.prodname_github_app %} in the organization. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/about-github-app-managers)." diff --git a/content/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account.md b/content/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account.md index d67785c836..5fb8f15f40 100644 --- a/content/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account.md +++ b/content/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account.md @@ -1,6 +1,6 @@ --- title: Installing a GitHub App from GitHub Marketplace for your personal account -intro: 'You can install {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %} to use on your personal account.' +intro: 'You can install {% data variables.product.prodname_github_apps %} from {% data variables.product.prodname_marketplace %} to use on your personal account.' redirect_from: - /articles/installing-an-app-in-your-personal-account - /github/customizing-your-github-workflow/installing-an-app-in-your-personal-account @@ -16,7 +16,7 @@ shortTitle: Install from Marketplace for user ## About {% data variables.product.prodname_marketplace %} -This article applies to installing and purchasing {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_app %}s from a source other than {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)." +This article applies to installing and purchasing {% data variables.product.prodname_github_apps %} from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_apps %} from a source other than {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)." If you install a {% data variables.product.prodname_github_app %} on your personal account and you choose a paid plan, you will pay for your app subscription on your personal account's current billing date using your existing payment method. @@ -24,7 +24,7 @@ If you install a {% data variables.product.prodname_github_app %} on your person For more information about installing an {% data variables.product.prodname_oauth_app %} instead of a {% data variables.product.prodname_github_app %} from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account)." -## About installing {% data variables.product.prodname_github_app %}s +## About installing {% data variables.product.prodname_github_apps %} {% data reusables.apps.about-installation %} @@ -34,7 +34,7 @@ After you install a {% data variables.product.prodname_github_app %}, you may al {% data reusables.apps.install-vs-authorize %} -For more information about authorizing {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." +For more information about authorizing {% data variables.product.prodname_github_apps %}, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." ## Installing a {% data variables.product.prodname_github_app %} in your personal account diff --git a/content/apps/using-github-apps/reviewing-and-modifying-installed-github-apps.md b/content/apps/using-github-apps/reviewing-and-modifying-installed-github-apps.md index f0a02f1565..3b83f67418 100644 --- a/content/apps/using-github-apps/reviewing-and-modifying-installed-github-apps.md +++ b/content/apps/using-github-apps/reviewing-and-modifying-installed-github-apps.md @@ -1,7 +1,7 @@ --- title: Reviewing and modifying installed GitHub Apps shortTitle: Review installations -intro: "You can review the permissions and change the repository access for {% data variables.product.prodname_github_app %}s that you have installed. You can also temporarily or permanently prevent a {% data variables.product.prodname_github_app %} from accessing resources owned by your account or organization." +intro: "You can review the permissions and change the repository access for {% data variables.product.prodname_github_apps %} that you have installed. You can also temporarily or permanently prevent a {% data variables.product.prodname_github_app %} from accessing resources owned by your account or organization." versions: fpt: '*' ghes: '*' @@ -11,26 +11,26 @@ topics: - GitHub Apps --- -## About installed {% data variables.product.prodname_github_app %}s +## About installed {% data variables.product.prodname_github_apps %} -{% data variables.product.company_short %} users can install {% data variables.product.prodname_github_app %}s on their personal account or organizations. When you install a {% data variables.product.prodname_github_app %}, you grant the app the organization-level and repository-level permissions that it requested. You also specify which repositories the {% data variables.product.prodname_github_app %} can access. +{% data variables.product.company_short %} users can install {% data variables.product.prodname_github_apps %} on their personal account or organizations. When you install a {% data variables.product.prodname_github_app %}, you grant the app the organization-level and repository-level permissions that it requested. You also specify which repositories the {% data variables.product.prodname_github_app %} can access. -You should periodically review the {% data variables.product.prodname_github_app %}s that you have installed. You can review the permissions that you granted and change the repositories that the {% data variables.product.prodname_github_app %} can access. If you no longer use an app, consider suspending or deleting the {% data variables.product.prodname_github_app %} to block its access to resources owned by the account where it is installed. +You should periodically review the {% data variables.product.prodname_github_apps %} that you have installed. You can review the permissions that you granted and change the repositories that the {% data variables.product.prodname_github_app %} can access. If you no longer use an app, consider suspending or deleting the {% data variables.product.prodname_github_app %} to block its access to resources owned by the account where it is installed. -In addition to reviewing {% data variables.product.prodname_github_app %}s that you have installed, you can review {% data variables.product.prodname_github_app %}s that you have authorized to act on your behalf. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps)." +In addition to reviewing {% data variables.product.prodname_github_apps %} that you have installed, you can review {% data variables.product.prodname_github_apps %} that you have authorized to act on your behalf. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps)." ## Navigating to the {% data variables.product.prodname_github_app %} you want to review or modify - For a {% data variables.product.prodname_github_app %} installed on an organization: 1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your organizations**. 1. Next to your organization name, click **Settings**. - 1. In the side bar, under "Third-party Access," click **GitHub Apps**. A list of the {% data variables.product.prodname_github_app %}s installed on your organization will be displayed. + 1. In the side bar, under "Third-party Access," click **GitHub Apps**. A list of the {% data variables.product.prodname_github_apps %} installed on your organization will be displayed. 1. Next to the {% data variables.product.prodname_github_app %} you want to review or modify, click **Configure**. - For a {% data variables.product.prodname_github_app %} installed on your personal account: 1. In the upper-right corner of any page, click your profile photo, then click **Settings**. 1. Under "Integrations," click **Applications**. - 1. Click **Installed GitHub Apps**. A list of the {% data variables.product.prodname_github_app %}s installed on your personal account will be displayed. + 1. Click **Installed GitHub Apps**. A list of the {% data variables.product.prodname_github_apps %} installed on your personal account will be displayed. 1. Next to the {% data variables.product.prodname_github_app %} you want to review or modify, click **Configure**. - For a repository where a {% data variables.product.prodname_github_app %} was granted access: @@ -43,7 +43,7 @@ In addition to reviewing {% data variables.product.prodname_github_app %}s that 1. Navigate to the main page of the organization or repository. 1. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. - 1. Under "Integrations," click **GitHub Apps**. A list of the {% data variables.product.prodname_github_app %}s that have been granted access to your repository will be displayed. + 1. Under "Integrations," click **GitHub Apps**. A list of the {% data variables.product.prodname_github_apps %} that have been granted access to your repository will be displayed. 1. Next to the {% data variables.product.prodname_github_app %} you want to review or modify, click **Configure**. diff --git a/content/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps.md b/content/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps.md index 3510a2d423..eea89f8478 100644 --- a/content/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps.md +++ b/content/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps.md @@ -22,7 +22,7 @@ shortTitle: Review your authorizations You may authorize a {% data variables.product.prodname_github_app %} to give the app permission to access information on your {% data variables.product.company_short %} account and to act on your behalf. For more information, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." -You should periodically review the {% data variables.product.prodname_github_app %}s that you have authorized. If you no longer use an app, consider revoking your authorization for that app. +You should periodically review the {% data variables.product.prodname_github_apps %} that you have authorized. If you no longer use an app, consider revoking your authorization for that app. The authorization can only be revoked by the person who authorized the {% data variables.product.prodname_github_app %}. Organization owners cannot revoke {% data variables.product.prodname_github_app %} authorizations for their organization members. However, organization owners can uninstall the {% data variables.product.prodname_github_app %} from their organization, which will prevent the app from accessing organization-owned resources. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps)." diff --git a/content/apps/using-github-apps/saml-and-github-apps.md b/content/apps/using-github-apps/saml-and-github-apps.md index 9a4f9b1642..57fc48da51 100644 --- a/content/apps/using-github-apps/saml-and-github-apps.md +++ b/content/apps/using-github-apps/saml-and-github-apps.md @@ -9,15 +9,15 @@ topics: - SSO --- -## Authorizing {% data variables.product.prodname_github_app %}s for SAML users +## Authorizing {% data variables.product.prodname_github_apps %} for SAML users If your organization uses SAML SSO, you may not be able to see your organization's resources after you authorize a {% data variables.product.prodname_github_app %}. For example, if the app displays a list of repositories, you may not see repositories owned by your organization. To resolve this issue, follow these steps: 1. Go to `https://github.com/orgs/ORGANIZATION-NAME/sso` to start an active SAML session for your organization. Replace `ORGANIZATION-NAME` with the name of your organization. 1. Revoke your authorization of the {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps)." -1. Reauthorize the {% data variables.product.prodname_github_app %}. {% data variables.product.prodname_github_app %} authorization is initiated by the app and varies based on the app. For example, some {% data variables.product.prodname_github_app %}s may have you click on a link or enter a command in your terminal. For more information, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." +1. Reauthorize the {% data variables.product.prodname_github_app %}. {% data variables.product.prodname_github_app %} authorization is initiated by the app and varies based on the app. For example, some {% data variables.product.prodname_github_apps %} may have you click on a link or enter a command in your terminal. For more information, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." -## Installing or requesting {% data variables.product.prodname_github_app %}s for SAML users +## Installing or requesting {% data variables.product.prodname_github_apps %} for SAML users If your organization uses SAML, you may not see your organzation listed when you try to install or request an {% data variables.product.prodname_github_app %} for your organization. To resolve this issue, follow these steps: diff --git a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md index 22c40f6f91..5c525f9bd9 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md @@ -91,7 +91,7 @@ If you want to use the {% data variables.product.company_short %} REST API for p If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)." -You can also create an OAuth token with an {% data variables.product.prodname_oauth_app %} to access the REST API. However, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %} instead. {% data variables.product.prodname_github_app %}s allow more control over the access and permission that the app has. +You can also create an OAuth token with an {% data variables.product.prodname_oauth_app %} to access the REST API. However, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %} instead. {% data variables.product.prodname_github_apps %} allow more control over the access and permission that the app has. ### Authenticating to the API in a {% data variables.product.prodname_actions %} workflow diff --git a/content/get-started/exploring-integrations/about-building-integrations.md b/content/get-started/exploring-integrations/about-building-integrations.md index e7a5d5140b..8d0d74de53 100644 --- a/content/get-started/exploring-integrations/about-building-integrations.md +++ b/content/get-started/exploring-integrations/about-building-integrations.md @@ -10,9 +10,9 @@ versions: Integrations are tools that extend {% data variables.product.company_short %}'s functionality. Integrations can do things on {% data variables.product.company_short %} like open issues, comment on pull requests, and manage projects. They can also do things outside of {% data variables.product.company_short %} based on events that happen on {% data variables.product.company_short %}. For example, an integration can post on Slack when an issue is opened on {% data variables.product.company_short %}. -Many integrations are {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_actions %} workflows, or custom actions for {% data variables.product.prodname_actions %} workflows. +Many integrations are {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_actions %} workflows, or custom actions for {% data variables.product.prodname_actions %} workflows. -- {% data variables.product.prodname_github_app %}s are integrations that run on the app owner's server or on a user device. For more information, see "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps)." +- {% data variables.product.prodname_github_apps %} are integrations that run on the app owner's server or on a user device. For more information, see "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps)." - {% data variables.product.prodname_actions %} workflows are workflows that run when specific events occur on {% data variables.product.company_short %}. For more information, see "[AUTOTITLE](/actions/learn-github-actions/understanding-github-actions)." - Custom actions are code that can be executed by a {% data variables.product.prodname_actions %} workflow. For more information, see "[AUTOTITLE](/actions/creating-actions/about-custom-actions)." diff --git a/content/get-started/exploring-integrations/about-using-integrations.md b/content/get-started/exploring-integrations/about-using-integrations.md index eb7f9724f0..57732cbda8 100644 --- a/content/get-started/exploring-integrations/about-using-integrations.md +++ b/content/get-started/exploring-integrations/about-using-integrations.md @@ -21,7 +21,7 @@ versions: Integrations are tools that extend {% data variables.product.company_short %}'s functionality. Integrations can do things on {% data variables.product.company_short %} like open issues, comment on pull requests, and manage projects. They can also do things outside of {% data variables.product.company_short %} based on events that happen on {% data variables.product.company_short %}. For example, an integration can post on Slack when an issue is opened on {% data variables.product.company_short %}. -You can discover many integrations in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). {% data variables.product.prodname_marketplace %} includes {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and custom actions that you can use in {% data variables.product.prodname_actions %} workflows. You can also get integrations directly from the integration creator. +You can discover many integrations in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). {% data variables.product.prodname_marketplace %} includes {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and custom actions that you can use in {% data variables.product.prodname_actions %} workflows. You can also get integrations directly from the integration creator. {% ifversion fpt or ghec or ghes > 3.7 %} For a list of featured {% data variables.product.company_short %} integrations, see "[AUTOTITLE](/get-started/exploring-integrations/github-extensions-and-integrations)."{% endif %} diff --git a/content/graphql/guides/forming-calls-with-graphql.md b/content/graphql/guides/forming-calls-with-graphql.md index 2808dff8b5..6607ea0544 100644 --- a/content/graphql/guides/forming-calls-with-graphql.md +++ b/content/graphql/guides/forming-calls-with-graphql.md @@ -32,7 +32,7 @@ If you want to use the API on behalf of an organization or another user, {% data ### Authenticating with a {% data variables.product.prodname_oauth_app %} -To authenticate with an OAuth token from an {% data variables.product.prodname_oauth_app %}, you must first authorize your {% data variables.product.prodname_oauth_app %} using either a web application flow or device flow. Then, you can use the access token that you received to access the API. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)" and " [Authorizing OAuth Apps](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps)." +To authenticate with an OAuth token from an {% data variables.product.prodname_oauth_app %}, you must first authorize your {% data variables.product.prodname_oauth_app %} using either a web application flow or device flow. Then, you can use the access token that you received to access the API. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)" and " [AUTOTITLE](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps)." ## The GraphQL endpoint diff --git a/content/graphql/guides/using-the-graphql-api-for-discussions.md b/content/graphql/guides/using-the-graphql-api-for-discussions.md index 7b41c66c49..090fe2c43e 100644 --- a/content/graphql/guides/using-the-graphql-api-for-discussions.md +++ b/content/graphql/guides/using-the-graphql-api-for-discussions.md @@ -8,7 +8,7 @@ shortTitle: Use GraphQL for Discussions The {% data variables.product.prodname_discussions %} GraphQL API allows you to get, create, edit, and delete discussion posts. For more information about {% data variables.product.prodname_discussions %}, see "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." -This API is available for authenticated users, {% data variables.product.prodname_oauth_app %}s, and GitHub Apps. Access tokens require the `repo` scope for private repositories and the `public_repo` scope for public repositories. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)." +This API is available for authenticated users, {% data variables.product.prodname_oauth_apps %}, and GitHub Apps. Access tokens require the `repo` scope for private repositories and the `public_repo` scope for public repositories. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)." ## Fields diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index c28526ae45..b9bddb47e4 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -64,7 +64,7 @@ To search for specific events, use the `action` qualifier in your query. Actions | `org_credential_authorization` | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %} | `org_secret_scanning_custom_pattern` | Contains organization-level activities related to {% data variables.product.prodname_secret_scanning %} custom patterns. For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." {% endif %} | `organization_default_label` | Contains all activities related to default labels for repositories in your organization. -| `oauth_application` | Contains all activities related to {% data variables.product.prodname_oauth_app %}s. +| `oauth_application` | Contains all activities related to {% data variables.product.prodname_oauth_apps %}. | `packages` | Contains all activities related to {% data variables.product.prodname_registry %}.{% ifversion fpt or ghec %} | `payment_method` | Contains all activities related to how your organization pays for GitHub.{% endif %}{% ifversion pat-v2%} | `personal_access_token` | Contains activities related to {% data variables.product.pat_v2 %}s in your organization. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."{% endif %} diff --git a/content/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md b/content/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md index bbccc8c419..c641197a7b 100644 --- a/content/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md +++ b/content/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md @@ -12,7 +12,7 @@ versions: topics: - Organizations - Teams -shortTitle: Unrestrict {% data variables.product.prodname_oauth_app %}s +shortTitle: Unrestrict {% data variables.product.prodname_oauth_apps %} --- {% danger %} diff --git a/content/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md b/content/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md index 0763b8ffe7..0484b8f5eb 100644 --- a/content/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md +++ b/content/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md @@ -12,7 +12,7 @@ versions: topics: - Organizations - Teams -shortTitle: Restrict {% data variables.product.prodname_oauth_app %}s +shortTitle: Restrict {% data variables.product.prodname_oauth_apps %} --- {% data reusables.organizations.oauth_app_restrictions_default %} diff --git a/content/organizations/managing-programmatic-access-to-your-organization/about-programmatic-access-in-your-organization.md b/content/organizations/managing-programmatic-access-to-your-organization/about-programmatic-access-in-your-organization.md index 6df98bfa3e..15876f6132 100644 --- a/content/organizations/managing-programmatic-access-to-your-organization/about-programmatic-access-in-your-organization.md +++ b/content/organizations/managing-programmatic-access-to-your-organization/about-programmatic-access-in-your-organization.md @@ -1,6 +1,6 @@ --- title: About programmatic access in your organization -intro: 'As an organization owner, you can control access to your organization by {% ifversion pat-v2%}{% data variables.product.pat_generic %}s, {% data variables.product.prodname_github_app %}s, and {% data variables.product.prodname_oauth_app %}s{% else %} {% data variables.product.prodname_github_app %}s and {% data variables.product.prodname_oauth_app %}s{% endif %}.' +intro: 'As an organization owner, you can control access to your organization by {% ifversion pat-v2%}{% data variables.product.pat_generic %}s, {% data variables.product.prodname_github_apps %}, and {% data variables.product.prodname_oauth_apps %}{% else %} {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}{% endif %}.' permissions: Organization owners can control programmatic access in their organization. topics: - Organizations @@ -17,23 +17,23 @@ versions: ## About programmatic access -{% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.pat_generic %}s can be used to make API requests that read or write resources owned by an organization. As an organization owner, you can control access to your organization by {% data variables.product.prodname_github_app %}s{% ifversion fpt or ghec %}, {% data variables.product.prodname_oauth_app %}s,{% endif %} and {% data variables.product.pat_generic %}s. +{% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.pat_generic %}s can be used to make API requests that read or write resources owned by an organization. As an organization owner, you can control access to your organization by {% data variables.product.prodname_github_apps %}{% ifversion fpt or ghec %}, {% data variables.product.prodname_oauth_apps %},{% endif %} and {% data variables.product.pat_generic %}s. -## {% data variables.product.prodname_github_app %}s +## {% data variables.product.prodname_github_apps %} -Organization owners can install {% data variables.product.prodname_github_app %}s on their organization. Repository admins can also install a {% data variables.product.prodname_github_app %} on the organization if the app does not request organization resources and if they only grant the app access to repositories where they are an admin. Organization members can submit a request for their organization owner to install a {% data variables.product.prodname_github_app %} on the organization. For more information, see {% ifversion fpt or ghec%}"[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-organization)."{% else %}"[AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps)."{% endif %} +Organization owners can install {% data variables.product.prodname_github_apps %} on their organization. Repository admins can also install a {% data variables.product.prodname_github_app %} on the organization if the app does not request organization resources and if they only grant the app access to repositories where they are an admin. Organization members can submit a request for their organization owner to install a {% data variables.product.prodname_github_app %} on the organization. For more information, see {% ifversion fpt or ghec%}"[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-organization)."{% else %}"[AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps)."{% endif %} -{% ifversion limit-app-access-requests %}Organization owners can prevent outside collaborators from requesting {% data variables.product.prodname_github_app %}s or from installing a {% data variables.product.prodname_github_app %} even if the collaborator is a repository admin. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests)."{% endif %} +{% ifversion limit-app-access-requests %}Organization owners can prevent outside collaborators from requesting {% data variables.product.prodname_github_apps %} or from installing a {% data variables.product.prodname_github_app %} even if the collaborator is a repository admin. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests)."{% endif %} -Organization owners can review the {% data variables.product.prodname_github_app %}s that are installed on their organization and modify the repositories that each app can access. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/reviewing-github-apps-installed-in-your-organization)." +Organization owners can review the {% data variables.product.prodname_github_apps %} that are installed on their organization and modify the repositories that each app can access. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/reviewing-github-apps-installed-in-your-organization)." -To help maintain {% data variables.product.prodname_github_app %}s owned by their organization, organization owners can designate other users in their organization as {% data variables.product.prodname_github_app %} managers. {% data variables.product.prodname_github_app %} managers can manage the settings of some or all of the {% data variables.product.prodname_github_apps %} that are owned by the organization. The {% data variables.product.prodname_github_app %} manager role does not grant users permission to install {% data variables.product.prodname_github_apps %} on an organization. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization)." +To help maintain {% data variables.product.prodname_github_apps %} owned by their organization, organization owners can designate other users in their organization as {% data variables.product.prodname_github_app %} managers. {% data variables.product.prodname_github_app %} managers can manage the settings of some or all of the {% data variables.product.prodname_github_apps %} that are owned by the organization. The {% data variables.product.prodname_github_app %} manager role does not grant users permission to install {% data variables.product.prodname_github_apps %} on an organization. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization)." {% ifversion fpt or ghec %} -## {% data variables.product.prodname_oauth_app %}s +## {% data variables.product.prodname_oauth_apps %} -Organization managers can restrict {% data variables.product.prodname_oauth_app %}s from accessing organization resources. When these restrictions are enabled, organization members and outside collaborators can still request approval for individual {% data variables.product.prodname_oauth_app %}s. For more information, see "[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)." +Organization managers can restrict {% data variables.product.prodname_oauth_apps %} from accessing organization resources. When these restrictions are enabled, organization members and outside collaborators can still request approval for individual {% data variables.product.prodname_oauth_apps %}. For more information, see "[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)." {% endif %} diff --git a/content/organizations/managing-programmatic-access-to-your-organization/reviewing-github-apps-installed-in-your-organization.md b/content/organizations/managing-programmatic-access-to-your-organization/reviewing-github-apps-installed-in-your-organization.md index 2841f192cb..9789ad65d3 100644 --- a/content/organizations/managing-programmatic-access-to-your-organization/reviewing-github-apps-installed-in-your-organization.md +++ b/content/organizations/managing-programmatic-access-to-your-organization/reviewing-github-apps-installed-in-your-organization.md @@ -1,6 +1,6 @@ --- title: Reviewing GitHub Apps installed in your organization -intro: "You can review the permissions and change the repository access for {% data variables.product.prodname_github_app %}s installed on your organization. You can also temporarily or permanently prevent a {% data variables.product.prodname_github_app %} from accessing resources owned by your organization." +intro: "You can review the permissions and change the repository access for {% data variables.product.prodname_github_apps %} installed on your organization. You can also temporarily or permanently prevent a {% data variables.product.prodname_github_app %} from accessing resources owned by your organization." redirect_from: - /articles/reviewing-your-organization-s-installed-integrations - /articles/reviewing-your-organizations-installed-integrations @@ -19,6 +19,6 @@ topics: shortTitle: Review installed GitHub Apps --- -Organization owners can review the {% data variables.product.prodname_github_app %}s that are installed on their organization. They can view the permissions granted to the app and change the repositories that the {% data variables.product.prodname_github_app %} can access. They can also suspend or delete the {% data variables.product.prodname_github_app %} to prevent the app from accessing resources owned by the organization. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps)." +Organization owners can review the {% data variables.product.prodname_github_apps %} that are installed on their organization. They can view the permissions granted to the app and change the repositories that the {% data variables.product.prodname_github_app %} can access. They can also suspend or delete the {% data variables.product.prodname_github_app %} to prevent the app from accessing resources owned by the organization. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps)." -Organization owners can also use the REST API to view the {% data variables.product.prodname_github_app %}s installed on their organization, along with the permissions and repository access granted to each {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/rest/orgs/orgs#list-app-installations-for-an-organization)." +Organization owners can also use the REST API to view the {% data variables.product.prodname_github_apps %} installed on their organization, along with the permissions and repository access granted to each {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/rest/orgs/orgs#list-app-installations-for-an-organization)." diff --git a/content/rest/codespaces/organizations.md b/content/rest/codespaces/organizations.md index 7a74bcb96c..e77ce3d6b9 100644 --- a/content/rest/codespaces/organizations.md +++ b/content/rest/codespaces/organizations.md @@ -15,7 +15,7 @@ autogenerated: rest You can manage {% data variables.product.prodname_codespaces %} billed to your organization. These endpoints are available for authenticated -organization admins and {% data variables.product.prodname_oauth_app %}s, but not GitHub Apps. For more information, +organization admins and {% data variables.product.prodname_oauth_apps %}, but not GitHub Apps. For more information, see "[AUTOTITLE](/codespaces)." diff --git a/content/rest/oauth-authorizations/index.md b/content/rest/oauth-authorizations/index.md index bdc3ae5971..2522fb1ac8 100644 --- a/content/rest/oauth-authorizations/index.md +++ b/content/rest/oauth-authorizations/index.md @@ -1,6 +1,6 @@ --- title: OAuth authorizations -intro: Use the REST API to manage the access {% data variables.product.prodname_oauth_app %}s have to your account. +intro: Use the REST API to manage the access {% data variables.product.prodname_oauth_apps %} have to your account. versions: ghes: '*' topics: diff --git a/content/rest/oauth-authorizations/oauth-authorizations.md b/content/rest/oauth-authorizations/oauth-authorizations.md index b725605eb5..6468d3fd9a 100644 --- a/content/rest/oauth-authorizations/oauth-authorizations.md +++ b/content/rest/oauth-authorizations/oauth-authorizations.md @@ -1,6 +1,6 @@ --- title: OAuth authorizations -intro: Use the REST API to manage the access {% data variables.product.prodname_oauth_app %}s have to your account. +intro: Use the REST API to manage the access {% data variables.product.prodname_oauth_apps %} have to your account. versions: ghes: '*' topics: @@ -12,6 +12,6 @@ autogenerated: rest ## About OAuth authorizations -You can use the REST API to manage the access {% data variables.product.prodname_oauth_app %}s have to your account. You can only access these endpoints via basic authentication using your username and password, not tokens. +You can use the REST API to manage the access {% data variables.product.prodname_oauth_apps %} have to your account. You can only access these endpoints via basic authentication using your username and password, not tokens. diff --git a/content/rest/orgs/webhooks.md b/content/rest/orgs/webhooks.md index 33f6bc7c6d..ab87b60596 100644 --- a/content/rest/orgs/webhooks.md +++ b/content/rest/orgs/webhooks.md @@ -23,8 +23,8 @@ All actions against organization webhooks require the authenticated user to be a In order to protect sensitive data which may be present in webhook configurations, we also enforce the following access control rules: -- {% data variables.product.prodname_oauth_app %}s cannot list, view, or edit webhooks which they did not create. -- Users cannot list, view, or edit webhooks which were created by {% data variables.product.prodname_oauth_app %}s. +- {% data variables.product.prodname_oauth_apps %} cannot list, view, or edit webhooks which they did not create. +- Users cannot list, view, or edit webhooks which were created by {% data variables.product.prodname_oauth_apps %}. ### Receiving Webhooks diff --git a/content/rest/overview/authenticating-to-the-rest-api.md b/content/rest/overview/authenticating-to-the-rest-api.md index 3d7e054dac..c4fd911329 100644 --- a/content/rest/overview/authenticating-to-the-rest-api.md +++ b/content/rest/overview/authenticating-to-the-rest-api.md @@ -48,13 +48,13 @@ If you do not authorize your {% data variables.product.pat_v1 %} for SAML SSO be If you want to use the API for an organization or on behalf of another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)." -You can also create an OAuth token with an {% data variables.product.prodname_oauth_app %} to access the REST API. However, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %} instead. {% data variables.product.prodname_github_app %}s allow more control over the access and permission that the app has. +You can also create an OAuth token with an {% data variables.product.prodname_oauth_app %} to access the REST API. However, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %} instead. {% data variables.product.prodname_github_apps %} allow more control over the access and permission that the app has. {% ifversion fpt or ghec %}Access tokens created by apps are automatically authorized for SAML SSO.{% endif %} ### Using basic authentication -Some REST API endpoints for {% data variables.product.prodname_github_app %}s and {% data variables.product.prodname_oauth_app %}s require you to use basic authentication to access the endpoint. You will use the app's client ID as the username and the app's client secret as the password. +Some REST API endpoints for {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} require you to use basic authentication to access the endpoint. You will use the app's client ID as the username and the app's client secret as the password. For example: diff --git a/content/rest/overview/permissions-required-for-github-apps.md b/content/rest/overview/permissions-required-for-github-apps.md index 49d3040bb0..96b6046857 100644 --- a/content/rest/overview/permissions-required-for-github-apps.md +++ b/content/rest/overview/permissions-required-for-github-apps.md @@ -1,6 +1,6 @@ --- title: Permissions required for GitHub Apps -intro: 'These are the permissions required for a {% data variables.product.prodname_github_app %} to use each REST API endpoint that works with {% data variables.product.prodname_github_app %}s.' +intro: 'These are the permissions required for a {% data variables.product.prodname_github_app %} to use each REST API endpoint that works with {% data variables.product.prodname_github_apps %}.' redirect_from: - /v3/apps/permissions - /rest/reference/permissions-required-for-github-apps diff --git a/content/rest/overview/troubleshooting.md b/content/rest/overview/troubleshooting.md index a9c081c5d5..034095c5ea 100644 --- a/content/rest/overview/troubleshooting.md +++ b/content/rest/overview/troubleshooting.md @@ -77,7 +77,7 @@ curl -H 'Authorization: Bearer YOUR-TOKEN' https://api.github.com/user/repos For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" and "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)." -For {% data variables.product.prodname_oauth_app %}s, you should use the [web application flow](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#web-application-flow) to generate an OAuth token to use in the API call's header: +For {% data variables.product.prodname_oauth_apps %}, you should use the [web application flow](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#web-application-flow) to generate an OAuth token to use in the API call's header: ```bash curl -H 'Authorization: Bearer YOUR-OAUTH-TOKEN' https://api.github.com/user/repos diff --git a/content/webhooks-and-events/webhooks/about-webhooks.md b/content/webhooks-and-events/webhooks/about-webhooks.md index 4fd1094688..50f70ab338 100644 --- a/content/webhooks-and-events/webhooks/about-webhooks.md +++ b/content/webhooks-and-events/webhooks/about-webhooks.md @@ -30,7 +30,7 @@ Webhooks can be triggered whenever specific events occur on {% data variables.pr You can add webhooks to{% ifversion ghes or ghae %} {% data variables.product.prodname_enterprise %},{% endif %} an organization, a repository, or a {% data variables.product.prodname_github_app %}. -When you add a webhook, you choose which events you want to subscribe to. To limit the number of HTTP requests to your server, you should only subscribe to the specific events that you plan on handling. By default, webhooks installed on {% ifversion ghes or ghae %} {% data variables.product.prodname_enterprise %},{% endif %} an organization or a repository are only subscribed to the push event. By default, webhooks on {% data variables.product.prodname_github_app %}s are not subscribed to any events. You can change the events that a webhook is subscribed to at any time. For a complete list of webhook events, see "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads)." +When you add a webhook, you choose which events you want to subscribe to. To limit the number of HTTP requests to your server, you should only subscribe to the specific events that you plan on handling. By default, webhooks installed on {% ifversion ghes or ghae %} {% data variables.product.prodname_enterprise %},{% endif %} an organization or a repository are only subscribed to the push event. By default, webhooks on {% data variables.product.prodname_github_apps %} are not subscribed to any events. You can change the events that a webhook is subscribed to at any time. For a complete list of webhook events, see "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads)." You typically need a server to receive webhooks events. When you add a webhook, you specify a URL where you want to receive the webhook events. {% data variables.product.company_short %} will send a HTTP POST payload to this URL when any events that the webhook is subscribed to occur. diff --git a/content/webhooks-and-events/webhooks/replacing-github-services.md b/content/webhooks-and-events/webhooks/replacing-github-services.md index 824a7eff0c..89555c915f 100644 --- a/content/webhooks-and-events/webhooks/replacing-github-services.md +++ b/content/webhooks-and-events/webhooks/replacing-github-services.md @@ -55,10 +55,10 @@ To replace GitHub Services with Webhooks: 1. Change your configuration depending on how you currently use GitHub Services: - **GitHub Apps**: Update your app's permissions and subscribed events to configure your app to receive the relevant webhook events. - - **{% data variables.product.prodname_oauth_app %}s**: Request either the `repo_hook` and/or `org_hook` scope(s) to manage the relevant events on behalf of users. + - **{% data variables.product.prodname_oauth_apps %}**: Request either the `repo_hook` and/or `org_hook` scope(s) to manage the relevant events on behalf of users. - **GitHub Service providers**: Request that users manually configure a webhook with the relevant events sent to you, or take this opportunity to build an app to manage this functionality. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." -1. Move additional configuration from outside of GitHub. Some GitHub Services require additional, custom configuration on the configuration page within GitHub. If your service does this, you will need to move this functionality into your application or rely on GitHub or {% data variables.product.prodname_oauth_app %}s where applicable. +1. Move additional configuration from outside of GitHub. Some GitHub Services require additional, custom configuration on the configuration page within GitHub. If your service does this, you will need to move this functionality into your application or rely on GitHub or {% data variables.product.prodname_oauth_apps %} where applicable. ## Supporting {% data variables.product.prodname_ghe_server %} diff --git a/data/glossaries/external.yml b/data/glossaries/external.yml index c3b2b408b5..09e1c53d36 100644 --- a/data/glossaries/external.yml +++ b/data/glossaries/external.yml @@ -338,7 +338,7 @@ that they configure and control. - term: integration description: >- - A third-party application that integrates with GitHub. These are often {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_actions %}, or custom actions. For more information, see "[AUTOTITLE](/get-started/exploring-integrations/about-building-integrations)." + A third-party application that integrates with GitHub. These are often {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_actions %}, or custom actions. For more information, see "[AUTOTITLE](/get-started/exploring-integrations/about-building-integrations)." - term: issue description: >- Issues are suggested improvements, tasks or questions related to the @@ -463,7 +463,7 @@ A third-party application that uses access tokens rather than passwords to access information for users. - term: OAuth token - description: The access token used by {% data variables.product.prodname_oauth_app %}s to access information for users. + description: The access token used by {% data variables.product.prodname_oauth_apps %} to access information for users. - term: outside collaborator description: >- A user who has been given access to one or more of an organization’s diff --git a/data/reusables/apps/maximum-github-apps-allowed.md b/data/reusables/apps/maximum-github-apps-allowed.md index e2a2c39d0a..f7e30b89a9 100644 --- a/data/reusables/apps/maximum-github-apps-allowed.md +++ b/data/reusables/apps/maximum-github-apps-allowed.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}A user or organization can register up to 100 {% data variables.product.prodname_github_apps %}, but there is no limit to how many {% data variables.product.prodname_github_app %}s can be installed on an account.{% endif %} +{% ifversion fpt or ghec %}A user or organization can register up to 100 {% data variables.product.prodname_github_apps %}, but there is no limit to how many {% data variables.product.prodname_github_apps %} can be installed on an account.{% endif %} diff --git a/data/reusables/apps/maximum-oauth-apps-allowed.md b/data/reusables/apps/maximum-oauth-apps-allowed.md index 93f9a85433..9f9cdc009e 100644 --- a/data/reusables/apps/maximum-oauth-apps-allowed.md +++ b/data/reusables/apps/maximum-oauth-apps-allowed.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}A user or organization can own up to 100 {% data variables.product.prodname_oauth_app %}s.{% endif %} +{% ifversion fpt or ghec %}A user or organization can own up to 100 {% data variables.product.prodname_oauth_apps %}.{% endif %} diff --git a/data/reusables/apps/user-to-server-rate-limits.md b/data/reusables/apps/user-to-server-rate-limits.md index 1f6c64fd30..751217e466 100644 --- a/data/reusables/apps/user-to-server-rate-limits.md +++ b/data/reusables/apps/user-to-server-rate-limits.md @@ -1 +1 @@ -{% ifversion ghes %}By default, user access token{% else %}User access token{% endif %} requests are limited to {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour and per authenticated user. All requests from {% data variables.product.prodname_oauth_app %}s authorized by a user or a {% data variables.product.pat_generic %} owned by the user, and requests authenticated with any of the user's authentication credentials, share the same quota of {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour for that user. +{% ifversion ghes %}By default, user access token{% else %}User access token{% endif %} requests are limited to {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour and per authenticated user. All requests from {% data variables.product.prodname_oauth_apps %} authorized by a user or a {% data variables.product.pat_generic %} owned by the user, and requests authenticated with any of the user's authentication credentials, share the same quota of {% ifversion ghae %}15,000{% elsif fpt or ghec or ghes %}5,000{% endif %} requests per hour for that user. diff --git a/data/reusables/audit_log/audit-log-action-categories.md b/data/reusables/audit_log/audit-log-action-categories.md index 4506e3e56f..d987822c74 100644 --- a/data/reusables/audit_log/audit-log-action-categories.md +++ b/data/reusables/audit_log/audit-log-action-categories.md @@ -51,7 +51,7 @@ {%- endif %} {%- ifversion ghec %} | `enterprise_domain` | Contains activities related to verified enterprise domains. -| `enterprise_installation` | Contains activities related to {% data variables.product.prodname_github_app %}s associated with an {% data variables.product.prodname_github_connect %} enterprise connection. +| `enterprise_installation` | Contains activities related to {% data variables.product.prodname_github_apps %} associated with an {% data variables.product.prodname_github_connect %} enterprise connection. {%- endif %} {%- ifversion fpt or ghec %} | `environment` | Contains activities related to {% data variables.product.prodname_actions %} environments. @@ -86,9 +86,9 @@ | `migration` | Contains activities related to transferring data from a _source_ location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a _target_ {% data variables.product.prodname_ghe_server %} instance. {%- endif %} | `oauth_access` | Contains activities related to OAuth access tokens. -| `oauth_application` | Contains activities related to {% data variables.product.prodname_oauth_app %}s. +| `oauth_application` | Contains activities related to {% data variables.product.prodname_oauth_apps %}. {%- ifversion fpt or ghec %} -| `oauth_authorization` | Contains activities related to authorizing {% data variables.product.prodname_oauth_app %}s. +| `oauth_authorization` | Contains activities related to authorizing {% data variables.product.prodname_oauth_apps %}. {%- endif %} | `org` | Contains activities related to organization membership. {%- ifversion ghec or ghes or ghae %} diff --git a/data/reusables/getting-started/marketplace.md b/data/reusables/getting-started/marketplace.md index 0706f3de7c..0ac275336c 100644 --- a/data/reusables/getting-started/marketplace.md +++ b/data/reusables/getting-started/marketplace.md @@ -1 +1 @@ -{% data variables.product.prodname_marketplace %} contains integrations that add functionality and improve your workflow. You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). +{% data variables.product.prodname_marketplace %} contains integrations that add functionality and improve your workflow. You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). diff --git a/data/reusables/marketplace/marketplace-apps-not-actions.md b/data/reusables/marketplace/marketplace-apps-not-actions.md index be6d850631..ebee517aec 100644 --- a/data/reusables/marketplace/marketplace-apps-not-actions.md +++ b/data/reusables/marketplace/marketplace-apps-not-actions.md @@ -1,5 +1,5 @@ {% note %} -**Note:** This article applies to publishing {% data variables.product.prodname_github_app %}s in {% data variables.product.prodname_marketplace %} only. For more information about publishing {% data variables.product.prodname_actions %} in {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace)." +**Note:** This article applies to publishing {% data variables.product.prodname_github_apps %} in {% data variables.product.prodname_marketplace %} only. For more information about publishing {% data variables.product.prodname_actions %} in {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace)." {% endnote %} diff --git a/data/reusables/shortdesc/deleting_oauth_apps.md b/data/reusables/shortdesc/deleting_oauth_apps.md index 05c92f297f..4d126bb3b7 100644 --- a/data/reusables/shortdesc/deleting_oauth_apps.md +++ b/data/reusables/shortdesc/deleting_oauth_apps.md @@ -1 +1 @@ -You can delete {% data variables.product.prodname_oauth_app %}s when you no longer use them. +You can delete {% data variables.product.prodname_oauth_apps %} when you no longer use them. diff --git a/data/reusables/user-settings/github_apps.md b/data/reusables/user-settings/github_apps.md index 4c73ccc2c7..06661ea719 100644 --- a/data/reusables/user-settings/github_apps.md +++ b/data/reusables/user-settings/github_apps.md @@ -1 +1 @@ -1. In the left sidebar, click **{% data variables.product.prodname_github_app %}s**. +1. In the left sidebar, click **{% data variables.product.prodname_github_apps %}**. diff --git a/data/reusables/webhooks/webhooks_intro.md b/data/reusables/webhooks/webhooks_intro.md index 77a8ad1c52..812d7bd6b8 100644 --- a/data/reusables/webhooks/webhooks_intro.md +++ b/data/reusables/webhooks/webhooks_intro.md @@ -1 +1 @@ -When configuring a webhook, you can choose which events will send you payloads. To limit the number of HTTP requests to your server, you should only subscribe to the specific events that you plan on handling. By default, webhooks installed on {% ifversion ghes or ghae %} [{% data variables.product.prodname_enterprise %}](/rest/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], or a [repository][repo-hooks] are only subscribed to the push event. By default, webhooks on {% data variables.product.prodname_github_app %}s are not subscribed to any events. You can change events that a webhook is subscribed to at any time. +When configuring a webhook, you can choose which events will send you payloads. To limit the number of HTTP requests to your server, you should only subscribe to the specific events that you plan on handling. By default, webhooks installed on {% ifversion ghes or ghae %} [{% data variables.product.prodname_enterprise %}](/rest/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], or a [repository][repo-hooks] are only subscribed to the push event. By default, webhooks on {% data variables.product.prodname_github_apps %} are not subscribed to any events. You can change events that a webhook is subscribed to at any time.