Skip to content

Repo sync #26099

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Requesting organization approval for OAuth Apps
title: Requesting organization approval for OAuth apps
intro: 'Organization members and outside collaborators can request that an owner approve access to organization resources for {% data variables.product.prodname_oauth_apps %}.'
redirect_from:
- /articles/requesting-organization-approval-for-third-party-applications
Expand All @@ -13,7 +13,7 @@ versions:
ghec: '*'
topics:
- Accounts
shortTitle: Request OAuth App approval
shortTitle: Request {% data variables.product.prodname_oauth_app %} approval
---

## About requesting organization approval for an {% data variables.product.prodname_oauth_app %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -664,32 +664,30 @@ Before you'll see `git` category actions, you must enable Git events in the audi

| Action | Description
|--------|-------------
| `oauth_application.create` | An [OAuth application][] was created for a user or organization account.
| `oauth_application.destroy` | An [OAuth application][] was deleted from a user or organization account.
| `oauth_application.create` | An [{% data variables.product.prodname_oauth_app %}](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app) was created for a user or organization account.
| `oauth_application.destroy` | An [{% data variables.product.prodname_oauth_app %}](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app) was deleted from a user or organization account.
{%- ifversion fpt or ghec %}
| `oauth_application.generate_client_secret` | An [OAuth application][]'s secret key was generated.
| `oauth_application.remove_client_secret` | An [OAuth application][]'s secret key was deleted.
| `oauth_application.generate_client_secret` | An [{% data variables.product.prodname_oauth_app %}](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app)'s secret key was generated.
| `oauth_application.remove_client_secret` | An [{% data variables.product.prodname_oauth_app %}](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app)'s secret key was deleted.
{%- endif %}
| `oauth_application.reset_secret` | An [OAuth application][]'s secret key was reset.
| `oauth_application.reset_secret` | An [{% data variables.product.prodname_oauth_app %}](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app)'s secret key was reset.
{%- ifversion fpt or ghec %}
| `oauth_application.revoke_all_tokens` | All user tokens for an [OAuth application][] were requested to be revoked.
| `oauth_application.revoke_all_tokens` | All user tokens for an [{% data variables.product.prodname_oauth_app %}](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app) were requested to be revoked.
{%- endif %}
| `oauth_application.revoke_tokens` | Token(s) for an [OAuth application][] were revoked.
| `oauth_application.transfer` | An [OAuth application][] was transferred from one user or organization account to another.
| `oauth_application.revoke_tokens` | Token(s) for an [{% data variables.product.prodname_oauth_app %}](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app) were revoked.
| `oauth_application.transfer` | An [{% data variables.product.prodname_oauth_app %}](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app) was transferred from one user or organization account to another.
{%- ifversion ghes or ghae %}
| `oauth_application.unsuspend` | An [OAuth application][] was unsuspended for a user or organization account.
| `oauth_application.unsuspend` | An [{% data variables.product.prodname_oauth_app %}](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app) was unsuspended for a user or organization account.
{%- endif %}

[OAuth application]: /apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app

{%- ifversion fpt or ghec %}
## `oauth_authorization` category actions

| Action | Description
|--------|-------------
| `oauth_authorization.create` | An authorization for an OAuth application was created. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)."
| `oauth_authorization.destroy` | An authorization for an OAuth application was deleted. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)."
| `oauth_authorization.update` | An authorization for an OAuth application was updated. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)."
| `oauth_authorization.create` | An authorization for an {% data variables.product.prodname_oauth_app %} was created. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)."
| `oauth_authorization.destroy` | An authorization for an {% data variables.product.prodname_oauth_app %} was deleted. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)."
| `oauth_authorization.update` | An authorization for an {% data variables.product.prodname_oauth_app %} was updated. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)."
{%- endif %}

## `org` category actions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ versions:

## About token data in the audit log

In your enterprise's audit log, for any actions that were performed using a {% data variables.product.pat_generic %} or OAuth application for authentication, the event data will show the authentication method used and the SHA-256 hash of the token.
In your enterprise's audit log, for any actions that were performed using a {% data variables.product.pat_generic %} or {% data variables.product.prodname_oauth_app %} for authentication, the event data will show the authentication method used and the SHA-256 hash of the token.

If you learn that a token was compromised, you can understand the actions taken by the compromised token by searching your enterprise's audit log for all events associated with that token.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Key | Value
{%- ifversion ghes or ghae %}
`note` | Miscellaneous event-specific information (in either plain text or JSON format).{% endif %}
{%- ifversion ghes or ghae %}
`oauth_app_id` | ID of the OAuth application associated with the action.{% endif %}
`oauth_app_id` | ID of the {% data variables.product.prodname_oauth_app %} associated with the action.{% endif %}
`operation` | Operation type that corresponds with the action. Operation types are `create`, `access`, `modify`, `remove`, `authentication`, `transfer`, and `restore`.
{%- ifversion ghes or ghae %}
`org` | Name of the organization affected by the action (if applicable).{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 OAuth Apps, {% data variables.product.prodname_github_app %}s use OAuth 2.0 and can act on behalf of a user. Unlike 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_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.

{% 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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Migrating OAuth Apps to GitHub Apps
title: Migrating OAuth apps to GitHub Apps
intro: 'Learn about the advantages of migrating your {% data variables.product.prodname_oauth_app %} to a {% data variables.product.prodname_github_app %}, and learn how to migrate your {% data variables.product.prodname_oauth_app %}.'
redirect_from:
- /apps/migrating-oauth-apps-to-github-apps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ shortTitle: Refresh user access tokens

To enforce regular token rotation and reduce the impact of a compromised token, you can configure your {% data variables.product.prodname_github_app %} to use user access tokens that expire. If your app uses user access tokens that expire, then you will receive a refresh token when you generate a user access token. The user access token expires after eight hours, and the refresh token expires after six months. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)."

You can use the refresh token to generate a new user access token and a new refresh token. Once you use a refresh token, that refresh token and the old user access token will not longer work.
You can use the refresh token to generate a new user access token and a new refresh token. Once you use a refresh token, that refresh token and the old user access token will no longer work.

If your refresh token expires before you use it, you can regenerate a user access token and refresh token by sending users 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)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,44 +14,48 @@ versions:
ghec: '*'
topics:
- GitHub Apps
shortTitle: Custom badges
shortTitle: Custom badge
---
By default, a new GitHub App will have an automatically generated [identicon](https://github.com/blog/1586-identicons).
An identicon badge looks something like this:

![An identicon, which consists of white pixels in a random pattern on a circular yellow background.](/assets/images/help/apps/identicon.png)
## About badges

After you register a GitHub App, you can customize your app's badge by uploading a logo and selecting a background color. A badge is a square logo image inside of a circular badge. You can choose a background color for the badge, which can visually distinguish your app.
Every {% data variables.product.prodname_github_app %} has a badge. A badge is a square image inside a circular background.

Your logo should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend an image size of at least 200px x 200px. {% ifversion fpt or ghec %}See "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app#guidelines-for-logos)" for more guidance on customizing badges.{% endif %}
By default, a new GitHub App will use an automatically generated identicon as a badge. An identicon badge looks something like this:

![Screenshot of an identicon, which consists of white pixels in a random pattern on a circular yellow background.](/assets/images/help/apps/identicon.png)

After you register a GitHub App, you can customize your app's badge by uploading a logo and selecting a background color. Your logo should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend an image dimension of 200 pixels by 200 pixels.

{% ifversion fpt or ghec %}

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_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.

{% endif %}

To create a custom badge:
## Creating a custom badge

{% data reusables.user-settings.access_settings %}
{% data reusables.apps.settings-step %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}
{% data reusables.user-settings.modify_github_app %}
1. Under "Display information," drag and drop an image from a local folder or click **Upload a logo** to select an image from your computer.
1. Optionally, crop your image. When you're done, click **Set new avatar**.
1. Under "Badge background color," type the [hexadecimal color code](http://www.color-hex.com/) of the background color for your badge.
1. Under "Display information", drag and drop an image from a local folder or click **Upload a logo** to select an image from your computer.
1. Optionally, crop your image.
1. Click **Set new avatar**.
1. Under "Badge background color", type the hexadecimal color code of the background color for your badge.

{% ifversion fpt or ghec %}
{% note %}

**Note:** The "Badge background color" input field will only appear after you upload an application logo.
**Note:** The "Badge background color" input field will only appear after you upload a logo.

{% endnote %}
{% endif %}

{% ifversion fpt or ghec %}

## Next steps

For more information about listing your {% data variables.product.prodname_github_app %} in {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace)".
For more information about listing your {% data variables.product.prodname_github_app %} in {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace)."

{% endif %}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Authenticating to the REST API with an OAuth App
shortTitle: Authenticate with an OAuth App
title: Authenticating to the REST API with an OAuth app
shortTitle: Authenticate with an {% data variables.product.prodname_oauth_app %}
intro: Learn about the different ways to authenticate with some examples.
redirect_from:
- /guides/basics-of-authentication
Expand Down Expand Up @@ -29,8 +29,8 @@ You can download the complete source code for this project [from the platform-sa

## Registering your app

First, you'll need to [register your application][new oauth app]. Every
registered OAuth application is assigned a unique Client ID and Client Secret.
First, you'll need to [register your application](https://github.com/settings/applications/new). Every
registered {% data variables.product.prodname_oauth_app %} is assigned a unique Client ID and Client Secret.
The Client Secret should not be shared! That includes checking the string
into your repository.

Expand Down Expand Up @@ -367,5 +367,4 @@ we would've seen the same confirmation dialog from earlier pop-up and warn us.
[libraries]: /rest/overview/libraries
[oauth scopes]: /apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps
[platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/basics-of-authentication
[new oauth app]: https://github.com/settings/applications/new
[app settings]: https://github.com/settings/developers
Loading