Skip to content

Commit 169b547

Browse files
stacycarterCopilotsabrowning1mchammer01
authored
Update IP allow lists documentation for public resources (#58344)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
1 parent 0098702 commit 169b547

2 files changed

Lines changed: 19 additions & 4 deletions

File tree

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
For example, you can allow access to the private resources exclusively from the IP address of your office network.
22

3-
After you configure an IP allow list, the list determines whether users can access protected resources through the web UI, APIs, or Git, using any of the following authentication methods:
3+
Once you configure a {% data variables.product.github %} IP allow list, the list determines whether users or apps can access protected resources through the web UI, APIs, or Git when they use any of the following authentication methods.
44

5-
* Username and password, using {% data variables.product.prodname_dotcom %} authentication or SAML SSO
5+
**Interactive (web) authentication:**
6+
* User authentication, including {% data variables.product.prodname_dotcom %} authentication, SAML, and OIDC authentication
7+
8+
**Non-interactive authentication:**
69
* {% data variables.product.pat_generic_caps %}
7-
* SSH key
10+
* OAuth app tokens
11+
* SSH keys (including deploy keys and SSH keys used by {% data variables.product.prodname_github_apps %}
12+
* {% data variables.product.prodname_github_app %} user-to-server or installation tokens, including the {% data variables.product.prodname_actions %}`GITHUB_TOKEN`
13+
14+
> [!NOTE]
15+
> IP allow lists don't currently restrict access when a {% data variables.product.prodname_github_app %} is installed on a user account and uses server-to-server installation tokens to access an organization or enterprise.
816
917
The IP allow list applies to users with any role or access, including enterprise and organization owners, repository administrators, and external collaborators.

data/reusables/identity-and-permissions/ip-allow-lists-which-resources-are-protected.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,19 @@ IP allow lists **do** restrict access to:
44

55
* Organization-owned repositories
66
* Private and internal repositories
7-
* Public resources, when a user is signed into {% data variables.product.prodname_dotcom %}
7+
* Public resources, when a user is signed into {% data variables.product.prodname_dotcom %} (including non-interactive authentication methods such as:
8+
* {% data variables.product.pat_generic_caps %}
9+
* OAuth app tokens
10+
* SSH keys, including deploy keys
11+
* {% data variables.product.prodname_github_app %} user-to-server or installation tokens, including the {% data variables.product.prodname_actions %}`GITHUB_TOKEN`
12+
> [!NOTE]
13+
> Excluding installation tokens used by a {% data variables.product.prodname_github_app %} which is installed on a user account.
814
* Raw URLs for files in repositories, such as `https://raw.githubusercontent.com/octo-org/octo-repo/main/README.md?token=ABC10001`
915

1016
IP allow lists do **not** restrict access to:
1117

1218
* Repositories, including forks, owned by {% data variables.enterprise.prodname_managed_users %}
1319
* Public resources, when accessed anonymously
20+
* A {% data variables.product.prodname_github_app %} (server-to-server) installation token when the {% data variables.product.prodname_github_app %} is installed on a user account.
1421
* {% data variables.product.prodname_copilot %} features that do not require directly fetching private or organizational data from {% data variables.product.prodname_dotcom %}
1522
* Anonymized URLs for images and videos uploaded to issues or pull requests, such as `https://private-user-images.githubusercontent.com/10001/20002.png?jwt=ABC10001`, unless you use {% data variables.enterprise.data_residency %}

0 commit comments

Comments
 (0)