diff --git a/.github/workflows/create-changelog-pr.yml b/.github/workflows/create-changelog-pr.yml index 3b89c9c5347d..3de39fcb2d2d 100644 --- a/.github/workflows/create-changelog-pr.yml +++ b/.github/workflows/create-changelog-pr.yml @@ -122,7 +122,7 @@ jobs: core.setOutput('pull-request-number', pullRequest.number); core.setOutput('pull-request-url', pullRequest.html_url); - - name: Add 'ready-for-doc-review' label to PR + - name: Add 'ready-for-doc-review' and 'skip FR board' labels to PR if: env.CONTINUE_WORKFLOW == 'true' uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd env: @@ -135,7 +135,7 @@ jobs: owner: context.repo.owner, repo: context.repo.repo, issue_number: Number(process.env.PULL_REQUEST_NUMBER), - labels: ['ready-for-doc-review'] + labels: ['ready-for-doc-review','skip FR board'] }); - name: Assign PR to commenter diff --git a/content/admin/managing-iam/provisioning-user-accounts-with-scim/managing-team-memberships-with-identity-provider-groups.md b/content/admin/managing-iam/provisioning-user-accounts-with-scim/managing-team-memberships-with-identity-provider-groups.md index a653de62eafa..eb16e3c383c5 100644 --- a/content/admin/managing-iam/provisioning-user-accounts-with-scim/managing-team-memberships-with-identity-provider-groups.md +++ b/content/admin/managing-iam/provisioning-user-accounts-with-scim/managing-team-memberships-with-identity-provider-groups.md @@ -57,7 +57,7 @@ If you use Microsoft Entra ID (previously known as Azure AD) as your IdP, you ca Enterprise owners can create teams at the enterprise level. {% data reusables.copilot.direct-assignment-rollout %} -For instructions on creating an enterprise team and syncing it with an IdP group, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/create-enterprise-teams). +Most of the instructions in this article apply to organization-level teams. For instructions on creating an enterprise team and syncing it with an IdP group, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/create-enterprise-teams). {% endif %} diff --git a/content/admin/overview/about-teams.md b/content/admin/overview/about-teams.md new file mode 100644 index 000000000000..f5b9280f3800 --- /dev/null +++ b/content/admin/overview/about-teams.md @@ -0,0 +1,56 @@ +--- +title: About teams in an enterprise +intro: 'Learn how teams simplify administration of user access, licensing, and communication.' +versions: + ghec: '*' +shortTitle: About teams +type: overview +topics: + - Enterprise + - Fundamentals +--- + +## What are teams? + +Teams are **groups of users** in an enterprise or organization. By creating teams, you can manage users at scale and simplify access, licensing, and communication. For example, you could create an auditor team for users who need access to audit logs, or a {% data variables.product.prodname_copilot_short %} team for users who receive {% data variables.product.prodname_copilot_short %} licenses. + +Administrators can create teams in an enterprise account or in organizations within an enterprise. + +* **Enterprise teams** are managed by enterprise owners and can include users from across the enterprise and its organizations. Currently, enterprise teams are used to manage {% data variables.product.prodname_copilot %} licenses for directly assigned users. {% data variables.product.company_short %} plans to expand the capabilities in the near future to include organization and role assignment. +* **Organization teams** are managed by organization administrators and can only include members of a single organization. Organization administrators can grant teams access to organization repositories, and organization members can mention teams in issues and discussions or add them as reviewers on pull requests. + +## Can I manage teams from an identity provider? + +If you have integrated {% data variables.product.github %} with an identity provider (IdP), you can link teams on {% data variables.product.github %} with groups in your IdP. When membership of the IdP group changes, the change is reflected in the {% data variables.product.github %} team, allowing you to centralize access management. + +The capabilities of this feature depend on whether you use {% data variables.product.prodname_emus %} or personal accounts. + +### {% data variables.product.prodname_emus %} + +You can make changes to IdP groups to manage repository access, add or remove users from organizations, or grant or remove {% data variables.product.prodname_copilot %} licenses. For example, if a new user is added to an IdP group that is linked to a team with access to an organization, the user receives access to that organization. For more information, see [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/managing-team-memberships-with-identity-provider-groups#about-team-management-with-enterprise-managed-users). + +This feature is available with both enterprise and organization teams. + +### Personal accounts + +Team synchronization allows you to centrally manage any privileges linked to an organization team, such as repository access and CODEOWNER status. However, team sync cannot be used to add users to organizations where they don't already have access. For more information, see [AUTOTITLE](/admin/managing-iam/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise). + +Team sync with personal accounts is only available with organization teams, and you must use Entra ID or Okta as an IdP. + +## What kind of team should I use? + +To simplify administration at scale, {% data variables.product.company_short %} recommends using enterprise teams wherever possible. However, you may need to create organization teams if the functionality you need is not covered by enterprise teams. {% data variables.product.company_short %} plans to address some of these limitations in the near future. + +Unlike organization teams, enterprise teams currently do **not** support: + +* Repository or organization access +* `@-mentions` of the team name in organizations +* Team sync if you use {% data variables.product.prodname_ghe_cloud %} with personal accounts +* CODEOWNER status +* Secret teams +* Nested teams +* Team maintainers + +In addition, enterprise teams are currently limited to 50 teams for a single enterprise and 500 users to each team. + +For more information about the capabilities of organization teams, see [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams). diff --git a/content/admin/overview/index.md b/content/admin/overview/index.md index 25bc88dcad65..b03a4b810c1e 100644 --- a/content/admin/overview/index.md +++ b/content/admin/overview/index.md @@ -19,6 +19,7 @@ children: - /best-practices-for-enterprises - /establishing-a-governance-framework-for-your-enterprise - /accessing-compliance-reports-for-your-enterprise + - /about-teams --- For more information, or to purchase {% data variables.product.prodname_enterprise %}, see [{% data variables.product.prodname_enterprise %}](https://github.com/enterprise). diff --git a/content/organizations/organizing-members-into-teams/about-teams.md b/content/organizations/organizing-members-into-teams/about-teams.md index 145c961cbf4f..e909b2496474 100644 --- a/content/organizations/organizing-members-into-teams/about-teams.md +++ b/content/organizations/organizing-members-into-teams/about-teams.md @@ -18,9 +18,13 @@ allowTitleToDifferFromFilename: true You can use teams to manage access for people in an organization, and for sending notifications. Organization owners and team maintainers can give teams admin, read, or write access to organization repositories. Organization members can send a notification to an entire team by mentioning the team's name. Teams can only be made up of members of your organization, outside collaborators are unable to be on a team. -Organization owners and team maintainers can disable team notifications. For more information, see [AUTOTITLE](/organizations/organizing-members-into-teams/configuring-team-notifications). +{% ifversion not ghes %} -Organization members can also send a notification to an entire team by requesting a review from that team. Organization members can request reviews from specific teams with read access to the repository where the pull request is opened. Teams can be designated as owners of certain types or areas of code in a CODEOWNERS file. +>![TIP] If you use an enterprise account, you can also create teams at the enterprise level. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/overview/about-teams). + +{% endif %} + +Organization members can send a notification to an entire team by requesting a review from that team. Organization members can request reviews from specific teams with read access to the repository where the pull request is opened. Teams can be designated as owners of certain types or areas of code in a CODEOWNERS file. For more information, see: * [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository) diff --git a/content/site-policy/github-terms/github-terms-of-service.md b/content/site-policy/github-terms/github-terms-of-service.md index d63511258640..dad85513eea7 100644 --- a/content/site-policy/github-terms/github-terms-of-service.md +++ b/content/site-policy/github-terms/github-terms-of-service.md @@ -146,6 +146,12 @@ You retain all moral rights to Your Content that you upload, publish, or submit To the extent this agreement is not enforceable by applicable law, you grant GitHub the rights we need to use Your Content without attribution and to make reasonable adaptations of Your Content as necessary to render the Website and provide the Service. +### 8. Access Reciprocity + +By using automated means to access, collect, or otherwise use (“Access”) any publicly accessible Content from the Service for the purpose of developing or training any commercially available artificial intelligence model, machine learning system, or similar technology (a "Commercial AI System"), you hereby waive any and all policies, terms, conditions, or contractual provisions governing products, services, websites or datasets you own or operate that would otherwise prohibit, restrict, or place conditions upon GitHub's Access to any publicly accessible data, information or content associated with your products or services, including for the purpose of developing or training any Commercial AI System. You further agree not to impose technical or other targeted measures to restrict or retaliate against such Access. + +This Section D.8 does not apply to Access solely for the purpose of academic research or if, on the date you Access the Content, the number of monthly active users of the products or services made available by you is less than 700 million in the preceding calendar month. For the purposes of this Section, "you" shall refer to you and any entity that directly or indirectly controls, is controlled by, or is under common control with you (affiliates). + ## E. Private Repositories **Short version:** _We treat the content of private repositories as confidential, and we only access it as described in our Privacy Statement—for security purposes, to assist the repository owner with a support matter, to maintain the integrity of the Service, to comply with our legal obligations, if we have reason to believe the contents are in violation of the law, or with your consent._ @@ -351,7 +357,7 @@ We reserve the right at any time and from time to time to modify or discontinue, ### 1. Governing Law -Except to the extent applicable law provides otherwise, this Agreement between you and GitHub and any access to or use of the Website or the Service are governed by the federal laws of the United States of America and the laws of the State of California, without regard to conflict of law provisions. You and GitHub agree to submit to the exclusive jurisdiction and venue of the courts located in the City and County of San Francisco, California. +Except to the extent applicable law provides otherwise, this Agreement between you and GitHub and any access to or use of the Website or the Service are governed by the federal laws of the United States of America and the laws of the State of California, without regard to conflict of law provisions. You and GitHub agree to submit to the exclusive jurisdiction and venue of the courts located in the City and County of San Francisco, California. However, any claim for injunctive relief with respect to a violation of section D.8 may be brought in any jurisdiction. ### 2. Non-Assignability diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index ac905a06d112..57d2d5c4944f 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -8577,13 +8577,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all secrets available in an environment without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all secrets available in an environment without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10071,13 +10071,13 @@ } ], "previews": [], - "descriptionHTML": "

Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10871,13 +10871,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -11069,13 +11069,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -63616,13 +63616,13 @@ } ], "previews": [], + "descriptionHTML": "

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -83452,13 +83452,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all notifications for the current user in the specified repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all notifications for the current user in the specified repository.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -104502,6 +104502,7 @@ } ], "previews": [], + "descriptionHTML": "

List repositories that an app installation can access.

", "statusCodes": [ { "httpStatusCode": "200", @@ -104519,8 +104520,7 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ], - "descriptionHTML": "

List repositories that an app installation can access.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -135737,7 +135737,6 @@ } ], "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

", "statusCodes": [ { "httpStatusCode": "200", @@ -135747,7 +135746,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -163702,7 +163702,6 @@ } ], "previews": [], - "descriptionHTML": "

Returns information about the specified GitHub code of conduct.

", "statusCodes": [ { "httpStatusCode": "200", @@ -163716,7 +163715,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Returns information about the specified GitHub code of conduct.

" } ] }, @@ -190044,13 +190044,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -207224,13 +207224,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211274,7 +211274,6 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint allows you to check the status of the most recent configuration process:

\n

Note that you may need to wait several seconds after you start a process before you can check its status.

\n

The different statuses are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusDescription
PENDINGThe job has not started yet
CONFIGURINGThe job is running
DONEThe job has finished correctly
FAILEDThe job has finished unexpectedly
", "statusCodes": [ { "httpStatusCode": "200", @@ -211284,7 +211283,8 @@ "httpStatusCode": "401", "description": "

Unauthorized

" } - ] + ], + "descriptionHTML": "

This endpoint allows you to check the status of the most recent configuration process:

\n

Note that you may need to wait several seconds after you start a process before you can check its status.

\n

The different statuses are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusDescription
PENDINGThe job has not started yet
CONFIGURINGThe job is running
DONEThe job has finished correctly
FAILEDThe job has finished unexpectedly
" }, { "serverUrl": "http(s)://HOSTNAME", @@ -212205,6 +212205,7 @@ } ], "previews": [], + "descriptionHTML": "

Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.

\n

Notes:

\n", "statusCodes": [ { "httpStatusCode": "204", @@ -212214,8 +212215,7 @@ "httpStatusCode": "401", "description": "

Unauthorized

" } - ], - "descriptionHTML": "

Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.

\n

Notes:

\n" + ] }, { "serverUrl": "http(s)://HOSTNAME", @@ -224531,13 +224531,13 @@ } ], "previews": [], + "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -320129,13 +320129,13 @@ } ], "previews": [], + "descriptionHTML": "

Get a random sentence from the Zen of GitHub

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" + ] } ] }, @@ -343328,13 +343328,13 @@ } ], "previews": [], - "descriptionHTML": "

List public organization memberships for the specified user.

\n

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

List public organization memberships for the specified user.

\n

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.

" } ], "custom-properties": [ @@ -344949,13 +344949,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Response - list of custom role names

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -346881,7 +346881,6 @@ } ], "previews": [], - "descriptionHTML": "

Check if a user is, publicly or privately, a member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -346895,7 +346894,8 @@ "httpStatusCode": "404", "description": "

Not Found if requester is an organization member and user is not a member

" } - ] + ], + "descriptionHTML": "

Check if a user is, publicly or privately, a member of the organization.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -363918,7 +363918,6 @@ } ], "previews": [], - "descriptionHTML": "

Delete a ruleset for an organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -363932,7 +363931,8 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ] + ], + "descriptionHTML": "

Delete a ruleset for an organization.

" } ], "security-managers": [ @@ -365213,7 +365213,6 @@ } ], "previews": [], - "descriptionHTML": "

Updates a webhook configured in an organization. When you update a webhook,\nthe secret will be overwritten. If you previously had a secret set, you must\nprovide the same secret or set a new secret or the secret will be removed. If\nyou are only updating individual webhook config properties, use \"Update a webhook\nconfiguration for an organization\".

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "200", @@ -365227,7 +365226,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Updates a webhook configured in an organization. When you update a webhook,\nthe secret will be overwritten. If you previously had a secret set, you must\nprovide the same secret or set a new secret or the secret will be removed. If\nyou are only updating individual webhook config properties, use \"Update a webhook\nconfiguration for an organization\".

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -379072,13 +379072,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific package metadata for a public package owned by a user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific package metadata for a public package owned by a user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -410870,13 +410870,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -436791,13 +436791,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n
\n

List the reactions to a team discussion comment.

\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n
\n

List the reactions to a team discussion comment.

\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -442689,13 +442689,13 @@ } ], "previews": [], + "descriptionHTML": "

Users with push access to the repository can edit a release.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Users with push access to the repository can edit a release.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -461793,7 +461793,6 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", @@ -461803,7 +461802,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -463176,13 +463176,13 @@ } ], "previews": [], + "descriptionHTML": "

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -463240,13 +463240,13 @@ } ], "previews": [], - "descriptionHTML": "

Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -496421,13 +496421,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -522406,7 +522406,6 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.

\n
\n

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

", "statusCodes": [ { "httpStatusCode": "200", @@ -522416,7 +522415,8 @@ "httpStatusCode": "404", "description": "

Not Found if project is not managed by this team

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.

\n
\n

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -533381,13 +533381,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.

\n
\n

Get a specific discussion on a team's page.

\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.

\n
\n

Get a specific discussion on a team's page.

\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -536193,7 +536193,6 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.

\n
\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

\n

Note

\n

\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

\n
", "statusCodes": [ { "httpStatusCode": "204", @@ -536203,7 +536202,8 @@ "httpStatusCode": "403", "description": "

if team synchronization is set up

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.

\n
\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

\n

Note

\n

\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"

\n
" } ] }, @@ -541063,7 +541063,6 @@ } ], "previews": [], - "descriptionHTML": "

Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository, you would use a subject_type value of repository and a subject_id value of 1300192 (the ID of the Spoon-Knife repository).

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -541077,7 +541076,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

\n

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository, you would use a subject_type value of repository and a subject_id value of 1300192 (the ID of the Spoon-Knife repository).

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" } ], "emails": [ diff --git a/src/secret-scanning/data/public-docs.yml b/src/secret-scanning/data/public-docs.yml index 37213e5a1466..bc8e495b3e4f 100644 --- a/src/secret-scanning/data/public-docs.yml +++ b/src/secret-scanning/data/public-docs.yml @@ -543,7 +543,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' base64Supported: false isduplicate: false - provider: Azure @@ -751,7 +751,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' base64Supported: false isduplicate: true - provider: Azure @@ -1024,7 +1024,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' base64Supported: false isduplicate: false - provider: Azure @@ -3696,7 +3696,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: false - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' base64Supported: false isduplicate: false - provider: MongoDB diff --git a/src/secret-scanning/lib/config.json b/src/secret-scanning/lib/config.json index cc9085711684..1d5acb324f6d 100644 --- a/src/secret-scanning/lib/config.json +++ b/src/secret-scanning/lib/config.json @@ -1,5 +1,5 @@ { - "sha": "eccf6431f1e97d23ff7575fc7afabf9f7b27329f", - "blob-sha": "3f57c664f49dbf57e8c64c07e611cab51689c215", + "sha": "d9b6f5d1cc49b0244927746bb3cc3b0ee35a67f7", + "blob-sha": "f9097b9e8b93a9b46bbf0cc0ceb91d06cb137efb", "targetFilename": "code-security/secret-scanning/introduction/supported-secret-scanning-patterns" } \ No newline at end of file