Skip to content

Commit eaa6f5d

Browse files
authored
Update OAuth app capitalization (#37845)
1 parent 226f84c commit eaa6f5d

File tree

68 files changed

+200
-181
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+200
-181
lines changed

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Requesting organization approval for OAuth Apps
2+
title: Requesting organization approval for OAuth apps
33
intro: 'Organization members and outside collaborators can request that an owner approve access to organization resources for {% data variables.product.prodname_oauth_apps %}.'
44
redirect_from:
55
- /articles/requesting-organization-approval-for-third-party-applications
@@ -13,7 +13,7 @@ versions:
1313
ghec: '*'
1414
topics:
1515
- Accounts
16-
shortTitle: Request OAuth App approval
16+
shortTitle: Request {% data variables.product.prodname_oauth_app %} approval
1717
---
1818

1919
## About requesting organization approval for an {% data variables.product.prodname_oauth_app %}

content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -664,32 +664,30 @@ Before you'll see `git` category actions, you must enable Git events in the audi
664664

665665
| Action | Description
666666
|--------|-------------
667-
| `oauth_application.create` | An [OAuth application][] was created for a user or organization account.
668-
| `oauth_application.destroy` | An [OAuth application][] was deleted from a user or organization account.
667+
| `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.
668+
| `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.
669669
{%- ifversion fpt or ghec %}
670-
| `oauth_application.generate_client_secret` | An [OAuth application][]'s secret key was generated.
671-
| `oauth_application.remove_client_secret` | An [OAuth application][]'s secret key was deleted.
670+
| `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.
671+
| `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.
672672
{%- endif %}
673-
| `oauth_application.reset_secret` | An [OAuth application][]'s secret key was reset.
673+
| `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.
674674
{%- ifversion fpt or ghec %}
675-
| `oauth_application.revoke_all_tokens` | All user tokens for an [OAuth application][] were requested to be revoked.
675+
| `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.
676676
{%- endif %}
677-
| `oauth_application.revoke_tokens` | Token(s) for an [OAuth application][] were revoked.
678-
| `oauth_application.transfer` | An [OAuth application][] was transferred from one user or organization account to another.
677+
| `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.
678+
| `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.
679679
{%- ifversion ghes or ghae %}
680-
| `oauth_application.unsuspend` | An [OAuth application][] was unsuspended for a user or organization account.
680+
| `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.
681681
{%- endif %}
682682

683-
[OAuth application]: /apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app#registering-your-app
684-
685683
{%- ifversion fpt or ghec %}
686684
## `oauth_authorization` category actions
687685

688686
| Action | Description
689687
|--------|-------------
690-
| `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)."
691-
| `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)."
692-
| `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)."
688+
| `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)."
689+
| `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)."
690+
| `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)."
693691
{%- endif %}
694692

695693
## `org` category actions

content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/identifying-audit-log-events-performed-by-an-access-token.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ versions:
88

99
## About token data in the audit log
1010

11-
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.
11+
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.
1212

1313
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.
1414

content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Key | Value
8282
{%- ifversion ghes or ghae %}
8383
`note` | Miscellaneous event-specific information (in either plain text or JSON format).{% endif %}
8484
{%- ifversion ghes or ghae %}
85-
`oauth_app_id` | ID of the OAuth application associated with the action.{% endif %}
85+
`oauth_app_id` | ID of the {% data variables.product.prodname_oauth_app %} associated with the action.{% endif %}
8686
`operation` | Operation type that corresponds with the action. Operation types are `create`, `access`, `modify`, `remove`, `authentication`, `transfer`, and `restore`.
8787
{%- ifversion ghes or ghae %}
8888
`org` | Name of the organization affected by the action (if applicable).{% endif %}

content/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Common use cases for {% data variables.product.prodname_github_apps %} include:
3030
- 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
3131
- Integrating your tool or external service with {% data variables.product.company_short %}
3232

33-
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.
33+
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.
3434

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

content/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Migrating OAuth Apps to GitHub Apps
2+
title: Migrating OAuth apps to GitHub Apps
33
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 %}.'
44
redirect_from:
55
- /apps/migrating-oauth-apps-to-github-apps

content/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Authenticating to the REST API with an OAuth App
3-
shortTitle: Authenticate with an OAuth App
2+
title: Authenticating to the REST API with an OAuth app
3+
shortTitle: Authenticate with an {% data variables.product.prodname_oauth_app %}
44
intro: Learn about the different ways to authenticate with some examples.
55
redirect_from:
66
- /guides/basics-of-authentication
@@ -29,8 +29,8 @@ You can download the complete source code for this project [from the platform-sa
2929

3030
## Registering your app
3131

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

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

content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Authorizing OAuth Apps
2+
title: Authorizing OAuth apps
33
intro: '{% data reusables.shortdesc.authorizing_oauth_apps %}'
44
redirect_from:
55
- /apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps
@@ -16,7 +16,7 @@ versions:
1616
ghae: '*'
1717
ghec: '*'
1818
topics:
19-
- OAuth Apps
19+
- OAuth apps
2020
---
2121

2222
{% note %}
@@ -33,9 +33,9 @@ Both {% data variables.product.prodname_oauth_app %}s and {% data variables.prod
3333

3434
If you want to skip authorizing your app in the standard way, such as when testing your app, you can use the [non-web application flow](#non-web-application-flow).
3535

36-
To authorize your OAuth app, consider which authorization flow best fits your app.
36+
To authorize your {% data variables.product.prodname_oauth_app %}, consider which authorization flow best fits your app.
3737

38-
- [web application flow](#web-application-flow): Used to authorize users for standard OAuth apps that run in the browser. (The [implicit grant type](https://tools.ietf.org/html/rfc6749#section-4.2) is not supported.)
38+
- [web application flow](#web-application-flow): Used to authorize users for standard {% data variables.product.prodname_oauth_apps %} that run in the browser. (The [implicit grant type](https://tools.ietf.org/html/rfc6749#section-4.2) is not supported.)
3939
- [device flow](#device-flow): Used for headless apps, such as CLI tools.
4040

4141
## Web application flow
@@ -274,7 +274,7 @@ Non-web authentication is available for limited situations like testing. If you
274274
## Redirect URLs
275275

276276
The `redirect_uri` parameter is optional. If left out, GitHub will
277-
redirect users to the callback URL configured in the OAuth Application
277+
redirect users to the callback URL configured in the {% data variables.product.prodname_oauth_app %}
278278
settings. If provided, the redirect URL's host (excluding sub-domains) and port must exactly
279279
match the callback URL. The redirect URL's path must reference a
280280
subdirectory of the callback URL.
@@ -303,29 +303,29 @@ http://127.0.0.1:1234/path
303303

304304
Note that OAuth RFC [recommends not to use `localhost`](https://datatracker.ietf.org/doc/html/rfc8252#section-7.3), but instead to use loopback literal `127.0.0.1` or IPv6 `::1`.
305305

306-
## Creating multiple tokens for OAuth Apps
306+
## Creating multiple tokens for {% data variables.product.prodname_oauth_apps %}
307307

308308
You can create multiple tokens for a user/application/scope combination to create tokens for specific use cases.
309309

310-
This is useful if your OAuth App supports one workflow that uses GitHub for sign-in and only requires basic user information. Another workflow may require access to a user's private repositories. Using multiple tokens, your OAuth App can perform the web flow for each use case, requesting only the scopes needed. If a user only uses your application to sign in, they are never required to grant your OAuth App access to their private repositories.
310+
This is useful if your {% data variables.product.prodname_oauth_app %} supports one workflow that uses GitHub for sign-in and only requires basic user information. Another workflow may require access to a user's private repositories. Using multiple tokens, your {% data variables.product.prodname_oauth_app %} can perform the web flow for each use case, requesting only the scopes needed. If a user only uses your application to sign in, they are never required to grant your {% data variables.product.prodname_oauth_app %} access to their private repositories.
311311

312312
{% data reusables.apps.oauth-token-limit %}
313313

314314
{% data reusables.apps.deletes_ssh_keys %}
315315

316316
## Directing users to review their access
317317

318-
You can link to authorization information for an OAuth App so that users can review and revoke their application authorizations.
318+
You can link to authorization information for an {% data variables.product.prodname_oauth_app %} so that users can review and revoke their application authorizations.
319319

320-
To build this link, you'll need your OAuth Apps `client_id` that you received from GitHub when you registered the application.
320+
To build this link, you'll need your {% data variables.product.prodname_oauth_app %}'s `client_id` that you received from GitHub when you registered the application.
321321

322322
```
323323
{% data variables.product.oauth_host_code %}/settings/connections/applications/:client_id
324324
```
325325

326326
{% tip %}
327327

328-
**Tip:** To learn more about the resources that your OAuth App can access for a user, see "[AUTOTITLE](/rest/guides/discovering-resources-for-a-user)."
328+
**Tip:** To learn more about the resources that your {% data variables.product.prodname_oauth_app %} can access for a user, see "[AUTOTITLE](/rest/guides/discovering-resources-for-a-user)."
329329

330330
{% endtip %}
331331

content/apps/oauth-apps/building-oauth-apps/best-practices-for-creating-an-oauth-app.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: Best practices for creating an OAuth App
2+
title: Best practices for creating an OAuth app
33
shortTitle: Best practices
4-
intro: 'Follow these best practices to improve the security and performance of your OAuth App.'
4+
intro: 'Follow these best practices to improve the security and performance of your {% data variables.product.prodname_oauth_app %}.'
55
versions:
66
fpt: '*'
77
ghes: '*'
88
ghae: '*'
99
ghec: '*'
1010
topics:
11-
- OAuth Apps
11+
- OAuth apps
1212
---
1313

1414
## Use a {% data variables.product.prodname_github_app %} instead
1515

16-
If possible, consider using a {% data variables.product.prodname_github_app %} instead of an OAuth App. 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 are leaked.
16+
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.
1717

1818
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.
1919

@@ -23,7 +23,7 @@ For more information about migrating an existing {% data variables.product.prodn
2323

2424
## Use minimal scopes
2525

26-
Your OAuth App should only request the scopes that the app needs to perform its intended functionality. If any tokens for your app become compromised, this will limit the amount of damage that can occur. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps)."
26+
Your {% data variables.product.prodname_oauth_app %} should only request the scopes that the app needs to perform its intended functionality. If any tokens for your app become compromised, this will limit the amount of damage that can occur. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps)."
2727

2828
## Secure your app's credentials
2929

@@ -45,7 +45,7 @@ If your app is a native client, client-side app, or runs on a user device (as op
4545

4646
## Use the appropriate token type
4747

48-
OAuth Apps can generate user access tokens in order to make authenticated API requests. Your app should never use a {% data variables.product.pat_generic %} or {% data variables.product.company_short %} password to authenticate.
48+
{% data variables.product.prodname_oauth_apps %} can generate user access tokens in order to make authenticated API requests. Your app should never use a {% data variables.product.pat_generic %} or {% data variables.product.company_short %} password to authenticate.
4949

5050
## Make a plan for handling security breaches
5151

content/apps/oauth-apps/building-oauth-apps/creating-a-custom-badge-for-your-oauth-app.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Creating a custom badge for your OAuth App
2+
title: Creating a custom badge for your OAuth app
33
intro: '{% data reusables.shortdesc.creating_custom_badges_oauth_apps %}'
44
redirect_from:
55
- /apps/building-oauth-apps/creating-custom-badges-for-oauth-apps
@@ -11,15 +11,15 @@ versions:
1111
ghae: '*'
1212
ghec: '*'
1313
topics:
14-
- OAuth Apps
14+
- OAuth apps
1515
shortTitle: Create custom badges
1616
---
17-
By default, a new OAuth App will have an automatically generated [identicon](https://github.com/blog/1586-identicons).
17+
By default, a new {% data variables.product.prodname_oauth_app %} will have an automatically generated [identicon](https://github.com/blog/1586-identicons).
1818
An identicon badge looks something like this:
1919

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

22-
After you create an OAuth App, you can customize the 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 be used to visually distinguish your app.
22+
After you create an {% data variables.product.prodname_oauth_app %}, you can customize the 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 be used to visually distinguish your app.
2323

2424
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 %}
2525

0 commit comments

Comments
 (0)