From 6dc23fd6edeec3c11fae7d3f98cf78dc4d94d824 Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Mon, 19 Jun 2023 09:14:33 -0700 Subject: [PATCH 1/2] update content around the automated permission articles (#37992) --- ...ng-a-user-access-token-for-a-github-app.md | 754 ------------------ ...r-github-app-installation-access-tokens.md | 1 + ...for-fine-grained-personal-access-tokens.md | 3 +- .../permissions-required-for-github-apps.md | 3 +- 4 files changed, 5 insertions(+), 756 deletions(-) diff --git a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md index ddb0432608..37d80b5802 100644 --- a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md +++ b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md @@ -135,757 +135,3 @@ You can generate a user access token with this method regardless of whether the By default, user access tokens expires after 8 hours. If you receive a user access token with an expiration, you will also receive a refresh token. The refresh token expire after 6 months. You can use this refresh token to regenerate a user access token. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens)." {% data variables.product.company_short %} strongly encourages you to use user access tokens that expire. If you previously opted out of using user access tokens that expire but want to reenable this feature, see "[AUTOTITLE](/apps/maintaining-github-apps/activating-optional-features-for-github-apps)". - -## Supported endpoints for user access tokens - -{% ifversion fpt or ghec %} -### Actions Runners - -- [List runner applications for a repository](/rest/actions#list-runner-applications-for-a-repository) -- [List self-hosted runners for a repository](/rest/actions#list-self-hosted-runners-for-a-repository) -- [Get a self-hosted runner for a repository](/rest/actions#get-a-self-hosted-runner-for-a-repository) -- [Delete a self-hosted runner from a repository](/rest/actions#delete-a-self-hosted-runner-from-a-repository) -- [Create a registration token for a repository](/rest/actions#create-a-registration-token-for-a-repository) -- [Create a remove token for a repository](/rest/actions#create-a-remove-token-for-a-repository) -- [List runner applications for an organization](/rest/actions#list-runner-applications-for-an-organization) -- [List self-hosted runners for an organization](/rest/actions#list-self-hosted-runners-for-an-organization) -- [Get a self-hosted runner for an organization](/rest/actions#get-a-self-hosted-runner-for-an-organization) -- [Delete a self-hosted runner from an organization](/rest/actions#delete-a-self-hosted-runner-from-an-organization) -- [Create a registration token for an organization](/rest/actions#create-a-registration-token-for-an-organization) -- [Create a remove token for an organization](/rest/actions#create-a-remove-token-for-an-organization) - -### Actions Secrets - -- [Get a repository public key](/rest/actions#get-a-repository-public-key) -- [List repository secrets](/rest/actions#list-repository-secrets) -- [Get a repository secret](/rest/actions#get-a-repository-secret) -- [Create or update a repository secret](/rest/actions#create-or-update-a-repository-secret) -- [Delete a repository secret](/rest/actions#delete-a-repository-secret) -- [Get an organization public key](/rest/actions#get-an-organization-public-key) -- [List organization secrets](/rest/actions#list-organization-secrets) -- [Get an organization secret](/rest/actions#get-an-organization-secret) -- [Create or update an organization secret](/rest/actions#create-or-update-an-organization-secret) -- [List selected repositories for an organization secret](/rest/actions#list-selected-repositories-for-an-organization-secret) -- [Set selected repositories for an organization secret](/rest/actions#set-selected-repositories-for-an-organization-secret) -- [Add selected repository to an organization secret](/rest/actions#add-selected-repository-to-an-organization-secret) -- [Remove selected repository from an organization secret](/rest/actions#remove-selected-repository-from-an-organization-secret) -- [Delete an organization secret](/rest/actions#delete-an-organization-secret) -{% endif %} - -{% ifversion fpt or ghec %} -### Artifacts - -- [List artifacts for a repository](/rest/actions#list-artifacts-for-a-repository) -- [List workflow run artifacts](/rest/actions#list-workflow-run-artifacts) -- [Get an artifact](/rest/actions#get-an-artifact) -- [Delete an artifact](/rest/actions#delete-an-artifact) -- [Download an artifact](/rest/actions#download-an-artifact) -{% endif %} - -### Check Runs - -- [Create a check run](/rest/checks#create-a-check-run) -- [Get a check run](/rest/checks#get-a-check-run) -- [Update a check run](/rest/checks#update-a-check-run) -- [List check run annotations](/rest/checks#list-check-run-annotations) -- [List check runs in a check suite](/rest/checks#list-check-runs-in-a-check-suite) -- [List check runs for a Git reference](/rest/checks#list-check-runs-for-a-git-reference) - -### Check Suites - -- [Create a check suite](/rest/checks#create-a-check-suite) -- [Get a check suite](/rest/checks#get-a-check-suite) -- [Rerequest a check suite](/rest/checks#rerequest-a-check-suite) -- [Update repository preferences for check suites](/rest/checks#update-repository-preferences-for-check-suites) -- [List check suites for a Git reference](/rest/checks#list-check-suites-for-a-git-reference) - -### Codes Of Conduct - -- [Get all codes of conduct](/rest/codes-of-conduct#get-all-codes-of-conduct) -- [Get a code of conduct](/rest/codes-of-conduct#get-a-code-of-conduct) - -### Deployment Statuses - -- [List deployment statuses](/rest/deployments#list-deployment-statuses) -- [Create a deployment status](/rest/deployments#create-a-deployment-status) -- [Get a deployment status](/rest/deployments#get-a-deployment-status) - -### Deployments - -- [List deployments](/rest/deployments#list-deployments) -- [Create a deployment](/rest/deployments#create-a-deployment) -- [Get a deployment](/rest/deployments#get-a-deployment) -- [Delete a deployment](/rest/deployments#delete-a-deployment) - -### Events - -- [List public events for a network of repositories](/rest/activity#list-public-events-for-a-network-of-repositories) -- [List public organization events](/rest/activity#list-public-organization-events) - -### Feeds - -- [Get feeds](/rest/activity#get-feeds) - -### Git Blobs - -- [Create a blob](/rest/git#create-a-blob) -- [Get a blob](/rest/git#get-a-blob) - -### Git Commits - -- [Create a commit](/rest/git#create-a-commit) -- [Get a commit](/rest/git#get-a-commit) - -### Git Refs - -- [Create a reference](/rest/git#create-a-reference) -- [Get a reference](/rest/git#get-a-reference) -- [List matching references](/rest/git#list-matching-references) -- [Update a reference](/rest/git#update-a-reference) -- [Delete a reference](/rest/git#delete-a-reference) - -### Git Tags - -- [Create a tag object](/rest/git#create-a-tag-object) -- [Get a tag](/rest/git#get-a-tag) - -### Git Trees - -- [Create a tree](/rest/git#create-a-tree) -- [Get a tree](/rest/git#get-a-tree) - -### Gitignore Templates - -- [Get all gitignore templates](/rest/gitignore#get-all-gitignore-templates) -- [Get a gitignore template](/rest/gitignore#get-a-gitignore-template) - -### Installations - -- [List repositories accessible to the user access token](/rest/apps#list-repositories-accessible-to-the-user-access-token) - -{% ifversion fpt or ghec %} -### Interaction Limits - -- [Get interaction restrictions for an organization](/rest/interactions#get-interaction-restrictions-for-an-organization) -- [Set interaction restrictions for an organization](/rest/interactions#set-interaction-restrictions-for-an-organization) -- [Remove interaction restrictions for an organization](/rest/interactions#remove-interaction-restrictions-for-an-organization) -- [Get interaction restrictions for a repository](/rest/interactions#get-interaction-restrictions-for-a-repository) -- [Set interaction restrictions for a repository](/rest/interactions#set-interaction-restrictions-for-a-repository) -- [Remove interaction restrictions for a repository](/rest/interactions#remove-interaction-restrictions-for-a-repository) -{% endif %} - -### Issue Assignees - -- [Add assignees to an issue](/rest/issues#add-assignees-to-an-issue) -- [Remove assignees from an issue](/rest/issues#remove-assignees-from-an-issue) - -### Issue Comments - -- [List issue comments](/rest/issues#list-issue-comments) -- [Create an issue comment](/rest/issues#create-an-issue-comment) -- [List issue comments for a repository](/rest/issues#list-issue-comments-for-a-repository) -- [Get an issue comment](/rest/issues#get-an-issue-comment) -- [Update an issue comment](/rest/issues#update-an-issue-comment) -- [Delete an issue comment](/rest/issues#delete-an-issue-comment) - -### Issue Events - -- [List issue events](/rest/issues#list-issue-events) - -### Issue Timeline - -- [List timeline events for an issue](/rest/issues#list-timeline-events-for-an-issue) - -### Issues - -- [List issues assigned to the authenticated user](/rest/issues#list-issues-assigned-to-the-authenticated-user) -- [List assignees](/rest/issues#list-assignees) -- [Check if a user can be assigned](/rest/issues#check-if-a-user-can-be-assigned) -- [List repository issues](/rest/issues#list-repository-issues) -- [Create an issue](/rest/issues#create-an-issue) -- [Get an issue](/rest/issues#get-an-issue) -- [Update an issue](/rest/issues#update-an-issue) -- [Lock an issue](/rest/issues#lock-an-issue) -- [Unlock an issue](/rest/issues#unlock-an-issue) - -{% ifversion fpt or ghec %} -### Jobs - -- [Get a job for a workflow run](/rest/actions#get-a-job-for-a-workflow-run) -- [Download job logs for a workflow run](/rest/actions#download-job-logs-for-a-workflow-run) -- [List jobs for a workflow run](/rest/actions#list-jobs-for-a-workflow-run) -{% endif %} - -### Labels - -- [List labels for an issue](/rest/issues#list-labels-for-an-issue) -- [Add labels to an issue](/rest/issues#add-labels-to-an-issue) -- [Set labels for an issue](/rest/issues#set-labels-for-an-issue) -- [Remove all labels from an issue](/rest/issues#remove-all-labels-from-an-issue) -- [Remove a label from an issue](/rest/issues#remove-a-label-from-an-issue) -- [List labels for a repository](/rest/issues#list-labels-for-a-repository) -- [Create a label](/rest/issues#create-a-label) -- [Get a label](/rest/issues#get-a-label) -- [Update a label](/rest/issues#update-a-label) -- [Delete a label](/rest/issues#delete-a-label) -- [Get labels for every issue in a milestone](/rest/issues#list-labels-for-issues-in-a-milestone) - -### Licenses - -- [Get all commonly used licenses](/rest/licenses#get-all-commonly-used-licenses) -- [Get a license](/rest/licenses#get-a-license) - -### Markdown - -- [Render a Markdown document](/rest/markdown#render-a-markdown-document) -- [Render a markdown document in raw mode](/rest/markdown#render-a-markdown-document-in-raw-mode) - -### Meta - -- [Meta](/rest/meta#meta) - -### Milestones - -- [List milestones](/rest/issues#list-milestones) -- [Create a milestone](/rest/issues#create-a-milestone) -- [Get a milestone](/rest/issues#get-a-milestone) -- [Update a milestone](/rest/issues#update-a-milestone) -- [Delete a milestone](/rest/issues#delete-a-milestone) - -### Organization Hooks - -- [List organization webhooks](/rest/orgs#webhooks/#list-organization-webhooks) -- [Create an organization webhook](/rest/orgs#webhooks/#create-an-organization-webhook) -- [Get an organization webhook](/rest/orgs#webhooks/#get-an-organization-webhook) -- [Update an organization webhook](/rest/orgs#webhooks/#update-an-organization-webhook) -- [Delete an organization webhook](/rest/orgs#webhooks/#delete-an-organization-webhook) -- [Ping an organization webhook](/rest/orgs#webhooks/#ping-an-organization-webhook) - -{% ifversion fpt or ghec %} -### Organization Invitations - -- [List pending organization invitations](/rest/orgs#list-pending-organization-invitations) -- [Create an organization invitation](/rest/orgs#create-an-organization-invitation) -- [List organization invitation teams](/rest/orgs#list-organization-invitation-teams) -{% endif %} - -### Organization Members - -- [List organization members](/rest/orgs#list-organization-members) -- [Check organization membership for a user](/rest/orgs#check-organization-membership-for-a-user) -- [Remove an organization member](/rest/orgs#remove-an-organization-member) -- [Get organization membership for a user](/rest/orgs#get-organization-membership-for-a-user) -- [Set organization membership for a user](/rest/orgs#set-organization-membership-for-a-user) -- [Remove organization membership for a user](/rest/orgs#remove-organization-membership-for-a-user) -- [List public organization members](/rest/orgs#list-public-organization-members) -- [Check public organization membership for a user](/rest/orgs#check-public-organization-membership-for-a-user) -- [Set public organization membership for the authenticated user](/rest/orgs#set-public-organization-membership-for-the-authenticated-user) -- [Remove public organization membership for the authenticated user](/rest/orgs#remove-public-organization-membership-for-the-authenticated-user) - -### Organization Outside Collaborators - -- [List outside collaborators for an organization](/rest/orgs#list-outside-collaborators-for-an-organization) -- [Convert an organization member to outside collaborator](/rest/orgs#convert-an-organization-member-to-outside-collaborator) -- [Remove outside collaborator from an organization](/rest/orgs#remove-outside-collaborator-from-an-organization) - -{% ifversion ghes %} -### Organization Pre Receive Hooks - -- [List pre-receive hooks for an organization](/rest/enterprise-admin#list-pre-receive-hooks-for-an-organization) -- [Get a pre-receive hook for an organization](/rest/enterprise-admin#get-a-pre-receive-hook-for-an-organization) -- [Update pre-receive hook enforcement for an organization](/rest/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization) -- [Remove pre-receive hook enforcement for an organization](/rest/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) -{% endif %} - -### Organization Team Projects - -- [List team projects](/rest/teams#list-team-projects) -- [Check team permissions for a project](/rest/teams#check-team-permissions-for-a-project) -- [Add or update team project permissions](/rest/teams#add-or-update-team-project-permissions) -- [Remove a project from a team](/rest/teams#remove-a-project-from-a-team) - -### Organization Team Repositories - -- [List team repositories](/rest/teams#list-team-repositories) -- [Check team permissions for a repository](/rest/teams#check-team-permissions-for-a-repository) -- [Add or update team repository permissions](/rest/teams#add-or-update-team-repository-permissions) -- [Remove a repository from a team](/rest/teams#remove-a-repository-from-a-team) - -{% ifversion fpt or ghec %} -### Organization Team Sync - -- [List IdP groups for a team](/rest/teams#list-idp-groups-for-a-team) -- [Create or update IdP group connections](/rest/teams#create-or-update-idp-group-connections) -- [List IdP groups for an organization](/rest/teams#list-idp-groups-for-an-organization) -{% endif %} - -### Organization Teams - -- [List teams](/rest/teams#list-teams) -- [Create a team](/rest/teams#create-a-team) -- [Get a team by name](/rest/teams#get-a-team-by-name) -- [Update a team](/rest/teams#update-a-team) -- [Delete a team](/rest/teams#delete-a-team) -{% ifversion fpt or ghec %} -- [List pending team invitations](/rest/teams#list-pending-team-invitations) -{% endif %} -- [List team members](/rest/teams#list-team-members) -- [Get team membership for a user](/rest/teams#get-team-membership-for-a-user) -- [Add or update team membership for a user](/rest/teams#add-or-update-team-membership-for-a-user) -- [Remove team membership for a user](/rest/teams#remove-team-membership-for-a-user) -- [List child teams](/rest/teams#list-child-teams) -- [List teams for the authenticated user](/rest/teams#list-teams-for-the-authenticated-user) - -### Organizations - -- [List organizations](/rest/orgs#list-organizations) -- [Get an organization](/rest/orgs#get-an-organization) -- [Update an organization](/rest/orgs#update-an-organization) -- [List organization memberships for the authenticated user](/rest/orgs#list-organization-memberships-for-the-authenticated-user) -- [Get an organization membership for the authenticated user](/rest/orgs#get-an-organization-membership-for-the-authenticated-user) -- [Update an organization membership for the authenticated user](/rest/orgs#update-an-organization-membership-for-the-authenticated-user) -- [List organizations for the authenticated user](/rest/orgs#list-organizations-for-the-authenticated-user) -- [List organizations for a user](/rest/orgs#list-organizations-for-a-user) - -{% ifversion fpt or ghec %} -### Organizations Credential Authorizations - -- [List SAML SSO authorizations for an organization](/rest/orgs#list-saml-sso-authorizations-for-an-organization) -- [Remove a SAML SSO authorization for an organization](/rest/orgs#remove-a-saml-sso-authorization-for-an-organization) -{% endif %} - -{% ifversion fpt or ghec %} -### Organizations Scim - -- [List SCIM provisioned identities](/rest/scim#list-scim-provisioned-identities) -- [Provision and invite a SCIM user](/rest/scim#provision-and-invite-a-scim-user) -- [Get SCIM provisioning information for a user](/rest/scim#get-scim-provisioning-information-for-a-user) -- [Set SCIM information for a provisioned user](/rest/scim#set-scim-information-for-a-provisioned-user) -- [Update an attribute for a SCIM user](/rest/scim#update-an-attribute-for-a-scim-user) -- [Delete a SCIM user from an organization](/rest/scim#delete-a-scim-user-from-an-organization) -{% endif %} - -{% ifversion fpt or ghec %} -### Source Imports - -- [Get an import status](/rest/migrations#get-an-import-status) -- [Start an import](/rest/migrations#start-an-import) -- [Update an import](/rest/migrations#update-an-import) -- [Cancel an import](/rest/migrations#cancel-an-import) -- [Get commit authors](/rest/migrations#get-commit-authors) -- [Map a commit author](/rest/migrations#map-a-commit-author) -- [Get large files](/rest/migrations#get-large-files) -- [Update Git LFS preference](/rest/migrations#update-git-lfs-preference) -{% endif %} - -### Project Collaborators - -- [List project collaborators](/rest/projects#list-project-collaborators) -- [Add project collaborator](/rest/projects#add-project-collaborator) -- [Remove project collaborator](/rest/projects#remove-project-collaborator) -- [Get project permission for a user](/rest/projects#get-project-permission-for-a-user) - -### Projects - -- [List organization projects](/rest/projects#list-organization-projects) -- [Create an organization project](/rest/projects#create-an-organization-project) -- [Get a project](/rest/projects#get-a-project) -- [Update a project](/rest/projects#update-a-project) -- [Delete a project](/rest/projects#delete-a-project) -- [List project columns](/rest/projects#list-project-columns) -- [Create a project column](/rest/projects#create-a-project-column) -- [Get a project column](/rest/projects#get-a-project-column) -- [Update a project column](/rest/projects#update-a-project-column) -- [Delete a project column](/rest/projects#delete-a-project-column) -- [List project cards](/rest/projects#list-project-cards) -- [Create a project card](/rest/projects#create-a-project-card) -- [Move a project column](/rest/projects#move-a-project-column) -- [Get a project card](/rest/projects#get-a-project-card) -- [Update a project card](/rest/projects#update-a-project-card) -- [Delete a project card](/rest/projects#delete-a-project-card) -- [Move a project card](/rest/projects#move-a-project-card) -- [List repository projects](/rest/projects#list-repository-projects) -- [Create a repository project](/rest/projects#create-a-repository-project) - -### Pull Comments - -- [List review comments on a pull request](/rest/pulls#list-review-comments-on-a-pull-request) -- [Create a review comment for a pull request](/rest/pulls#create-a-review-comment-for-a-pull-request) -- [List review comments in a repository](/rest/pulls#list-review-comments-in-a-repository) -- [Get a review comment for a pull request](/rest/pulls#get-a-review-comment-for-a-pull-request) -- [Update a review comment for a pull request](/rest/pulls#update-a-review-comment-for-a-pull-request) -- [Delete a review comment for a pull request](/rest/pulls#delete-a-review-comment-for-a-pull-request) - -### Pull Request Review Events - -- [Dismiss a review for a pull request](/rest/pulls#dismiss-a-review-for-a-pull-request) -- [Submit a review for a pull request](/rest/pulls#submit-a-review-for-a-pull-request) - -### Pull Request Review Requests - -- [List requested reviewers for a pull request](/rest/pulls#list-requested-reviewers-for-a-pull-request) -- [Request reviewers for a pull request](/rest/pulls#request-reviewers-for-a-pull-request) -- [Remove requested reviewers from a pull request](/rest/pulls#remove-requested-reviewers-from-a-pull-request) - -### Pull Request Reviews - -- [List reviews for a pull request](/rest/pulls#list-reviews-for-a-pull-request) -- [Create a review for a pull request](/rest/pulls#create-a-review-for-a-pull-request) -- [Get a review for a pull request](/rest/pulls#get-a-review-for-a-pull-request) -- [Update a review for a pull request](/rest/pulls#update-a-review-for-a-pull-request) -- [List comments for a pull request review](/rest/pulls#list-comments-for-a-pull-request-review) - -### Pulls - -- [List pull requests](/rest/pulls#list-pull-requests) -- [Create a pull request](/rest/pulls#create-a-pull-request) -- [Get a pull request](/rest/pulls#get-a-pull-request) -- [Update a pull request](/rest/pulls#update-a-pull-request) -- [List commits on a pull request](/rest/pulls#list-commits-on-a-pull-request) -- [List pull requests files](/rest/pulls#list-pull-requests-files) -- [Check if a pull request has been merged](/rest/pulls#check-if-a-pull-request-has-been-merged) -- [Merge a pull request (Merge Button)](/rest/pulls#merge-a-pull-request) - -### Reactions - -- [Delete a reaction](/rest/reactions) -- [List reactions for a commit comment](/rest/reactions#list-reactions-for-a-commit-comment) -- [Create reaction for a commit comment](/rest/reactions#create-reaction-for-a-commit-comment) -- [List reactions for an issue](/rest/reactions#list-reactions-for-an-issue) -- [Create reaction for an issue](/rest/reactions#create-reaction-for-an-issue) -- [List reactions for an issue comment](/rest/reactions#list-reactions-for-an-issue-comment) -- [Create reaction for an issue comment](/rest/reactions#create-reaction-for-an-issue-comment) -- [List reactions for a pull request review comment](/rest/reactions#list-reactions-for-a-pull-request-review-comment) -- [Create reaction for a pull request review comment](/rest/reactions#create-reaction-for-a-pull-request-review-comment){% ifversion team-discussions %} -- [List reactions for a team discussion comment](/rest/reactions#list-reactions-for-a-team-discussion-comment) -- [Create reaction for a team discussion comment](/rest/reactions#create-reaction-for-a-team-discussion-comment) -- [List reactions for a team discussion](/rest/reactions#list-reactions-for-a-team-discussion) -- [Create reaction for a team discussion](/rest/reactions#create-reaction-for-a-team-discussion){% endif %} -- [Delete a commit comment reaction](/rest/reactions#delete-a-commit-comment-reaction) -- [Delete an issue reaction](/rest/reactions#delete-an-issue-reaction) -- [Delete a reaction to a commit comment](/rest/reactions#delete-an-issue-comment-reaction) -- [Delete a pull request comment reaction](/rest/reactions#delete-a-pull-request-comment-reaction){% ifversion team-discussions %} -- [Delete team discussion reaction](/rest/reactions#delete-team-discussion-reaction) -- [Delete team discussion comment reaction](/rest/reactions#delete-team-discussion-comment-reaction){% endif %} - -### Repositories - -- [List organization repositories](/rest/repos#list-organization-repositories) -- [Create a repository for the authenticated user](/rest/repos#create-a-repository-for-the-authenticated-user) -- [Get a repository](/rest/repos#get-a-repository) -- [Update a repository](/rest/repos#update-a-repository) -- [Delete a repository](/rest/repos#delete-a-repository) -- [Compare two commits](/rest/commits#compare-two-commits) -- [List repository contributors](/rest/repos#list-repository-contributors) -- [List forks](/rest/repos#list-forks) -- [Create a fork](/rest/repos#create-a-fork) -- [List repository languages](/rest/repos#list-repository-languages) -- [List repository tags](/rest/repos#list-repository-tags) -- [List repository teams](/rest/repos#list-repository-teams) -- [Transfer a repository](/rest/repos#transfer-a-repository) -- [List public repositories](/rest/repos#list-public-repositories) -- [List repositories for the authenticated user](/rest/repos#list-repositories-for-the-authenticated-user) -- [List repositories for a user](/rest/repos#list-repositories-for-a-user) -- [Create repository using a repository template](/rest/repos#create-repository-using-a-repository-template) - -### Repository Activity - -- [List stargazers](/rest/activity#list-stargazers) -- [List watchers](/rest/activity#list-watchers) -- [List repositories starred by a user](/rest/activity#list-repositories-starred-by-a-user) -- [Check if a repository is starred by the authenticated user](/rest/activity#check-if-a-repository-is-starred-by-the-authenticated-user) -- [Star a repository for the authenticated user](/rest/activity#star-a-repository-for-the-authenticated-user) -- [Unstar a repository for the authenticated user](/rest/activity#unstar-a-repository-for-the-authenticated-user) -- [List repositories watched by a user](/rest/activity#list-repositories-watched-by-a-user) - -{% ifversion fpt or ghec %} -### Repository Automated Security Fixes - -- [Enable automated security fixes](/rest/repos#enable-automated-security-fixes) -- [Disable automated security fixes](/rest/repos#disable-automated-security-fixes) -{% endif %} - -### Repository Branches - -- [List branches](/rest/branches#list-branches) -- [Get a branch](/rest/branches#get-a-branch) -- [Get branch protection](/rest/branches#get-branch-protection) -- [Update branch protection](/rest/branches#update-branch-protection) -- [Delete branch protection](/rest/branches#delete-branch-protection) -- [Get admin branch protection](/rest/branches#get-admin-branch-protection) -- [Set admin branch protection](/rest/branches#set-admin-branch-protection) -- [Delete admin branch protection](/rest/branches#delete-admin-branch-protection) -- [Get pull request review protection](/rest/branches#get-pull-request-review-protection) -- [Update pull request review protection](/rest/branches#update-pull-request-review-protection) -- [Delete pull request review protection](/rest/branches#delete-pull-request-review-protection) -- [Get commit signature protection](/rest/branches#get-commit-signature-protection) -- [Create commit signature protection](/rest/branches#create-commit-signature-protection) -- [Delete commit signature protection](/rest/branches#delete-commit-signature-protection) -- [Get status checks protection](/rest/branches#get-status-checks-protection) -- [Update status check protection](/rest/branches#update-status-check-protection) -- [Remove status check protection](/rest/branches#remove-status-check-protection) -- [Get all status check contexts](/rest/branches#get-all-status-check-contexts) -- [Add status check contexts](/rest/branches#add-status-check-contexts) -- [Set status check contexts](/rest/branches#set-status-check-contexts) -- [Remove status check contexts](/rest/branches#remove-status-check-contexts) -- [Get access restrictions](/rest/branches#get-access-restrictions) -- [Delete access restrictions](/rest/branches#delete-access-restrictions) -- [List teams with access to the protected branch](/rest/repos#list-teams-with-access-to-the-protected-branch) -- [Add team access restrictions](/rest/branches#add-team-access-restrictions) -- [Set team access restrictions](/rest/branches#set-team-access-restrictions) -- [Remove team access restriction](/rest/branches#remove-team-access-restrictions) -- [List user restrictions of protected branch](/rest/repos#list-users-with-access-to-the-protected-branch) -- [Add user access restrictions](/rest/branches#add-user-access-restrictions) -- [Set user access restrictions](/rest/branches#set-user-access-restrictions) -- [Remove user access restrictions](/rest/branches#remove-user-access-restrictions) -- [Merge a branch](/rest/branches#merge-a-branch) - -### Repository Collaborators - -- [List repository collaborators](/rest/collaborators#list-repository-collaborators) -- [Check if a user is a repository collaborator](/rest/collaborators#check-if-a-user-is-a-repository-collaborator) -- [Add a repository collaborator](/rest/collaborators#add-a-repository-collaborator) -- [Remove a repository collaborator](/rest/collaborators#remove-a-repository-collaborator) -- [Get repository permissions for a user](/rest/collaborators#get-repository-permissions-for-a-user) - -### Repository Commit Comments - -- [List commit comments for a repository](/rest/commits#list-commit-comments-for-a-repository) -- [Get a commit comment](/rest/commits#get-a-commit-comment) -- [Update a commit comment](/rest/commits#update-a-commit-comment) -- [Delete a commit comment](/rest/commits#delete-a-commit-comment) -- [List commit comments](/rest/commits#list-commit-comments) -- [Create a commit comment](/rest/commits#create-a-commit-comment) - -### Repository Commits - -- [List commits](/rest/commits#list-commits) -- [Get a commit](/rest/commits#get-a-commit) -- [List branches for head commit](/rest/commits#list-branches-for-head-commit) -- [List pull requests associated with commit](/rest/repos#list-pull-requests-associated-with-commit) - -### Repository Community - -- [Get the code of conduct for a repository](/rest/codes-of-conduct#get-the-code-of-conduct-for-a-repository) -{% ifversion fpt or ghec %} -- [Get community profile metrics](/rest/metrics#get-community-profile-metrics) -{% endif %} - -### Repository Contents - -- [Download a repository archive](/rest/repos#download-a-repository-archive) -- [Get repository content](/rest/repos#get-repository-content) -- [Create or update file contents](/rest/repos#create-or-update-file-contents) -- [Delete a file](/rest/repos#delete-a-file) -- [Get a repository README](/rest/repos#get-a-repository-readme) -- [Get the license for a repository](/rest/licenses#get-the-license-for-a-repository) - -### Repository Event Dispatches - -- [Create a repository dispatch event](/rest/repos#create-a-repository-dispatch-event) - -### Repository Hooks - -- [List repository webhooks](/rest/webhooks#list-repository-webhooks) -- [Create a repository webhook](/rest/webhooks#create-a-repository-webhook) -- [Get a repository webhook](/rest/webhooks#get-a-repository-webhook) -- [Update a repository webhook](/rest/webhooks#update-a-repository-webhook) -- [Delete a repository webhook](/rest/webhooks#delete-a-repository-webhook) -- [Ping a repository webhook](/rest/webhooks#ping-a-repository-webhook) -- [Test the push repository webhook](/rest/repos#test-the-push-repository-webhook) - -### Repository Invitations - -- [List repository invitations](/rest/collaborators#list-repository-invitations) -- [Update a repository invitation](/rest/collaborators#update-a-repository-invitation) -- [Delete a repository invitation](/rest/collaborators#delete-a-repository-invitation) -- [List repository invitations for the authenticated user](/rest/collaborators#list-repository-invitations-for-the-authenticated-user) -- [Accept a repository invitation](/rest/collaborators#accept-a-repository-invitation) -- [Decline a repository invitation](/rest/collaborators#decline-a-repository-invitation) - -### Repository Keys - -- [List deploy keys](/rest/deployments#list-deploy-keys) -- [Create a deploy key](/rest/deployments#create-a-deploy-key) -- [Get a deploy key](/rest/deployments#get-a-deploy-key) -- [Delete a deploy key](/rest/deployments#delete-a-deploy-key) - -### Repository Pages - -- [Get a GitHub Pages site](/rest/pages#get-a-github-pages-site) -- [Create a GitHub Pages site](/rest/pages#create-a-github-pages-site) -- [Update information about a GitHub Pages site](/rest/pages#update-information-about-a-github-pages-site) -- [Delete a GitHub Pages site](/rest/pages#delete-a-github-pages-site) -- [List GitHub Pages builds](/rest/pages#list-github-pages-builds) -- [Request a GitHub Pages build](/rest/pages#request-a-github-pages-build) -- [Get GitHub Pages build](/rest/pages#get-github-pages-build) -- [Get latest pages build](/rest/pages#get-latest-pages-build) - -{% ifversion ghes %} -### Repository Pre Receive Hooks - -- [List pre-receive hooks for a repository](/rest/enterprise-admin#list-pre-receive-hooks-for-a-repository) -- [Get a pre-receive hook for a repository](/rest/enterprise-admin#get-a-pre-receive-hook-for-a-repository) -- [Update pre-receive hook enforcement for a repository](/rest/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository) -- [Remove pre-receive hook enforcement for a repository](/rest/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) -{% endif %} - -### Repository Releases - -- [List releases](/rest/repos#list-releases) -- [Create a release](/rest/repos#create-a-release) -- [Get a release](/rest/repos#get-a-release) -- [Update a release](/rest/repos#update-a-release) -- [Delete a release](/rest/repos#delete-a-release) -- [List release assets](/rest/repos#list-release-assets) -- [Get a release asset](/rest/repos#get-a-release-asset) -- [Update a release asset](/rest/repos#update-a-release-asset) -- [Delete a release asset](/rest/repos#delete-a-release-asset) -- [Get the latest release](/rest/repos#get-the-latest-release) -- [Get a release by tag name](/rest/repos#get-a-release-by-tag-name) - -### Repository Stats - -- [Get the weekly commit activity](/rest/metrics#get-the-weekly-commit-activity) -- [Get the last year of commit activity](/rest/metrics#get-the-last-year-of-commit-activity) -- [Get all contributor commit activity](/rest/metrics#get-all-contributor-commit-activity) -- [Get the weekly commit count](/rest/metrics#get-the-weekly-commit-count) -- [Get the hourly commit count for each day](/rest/metrics#get-the-hourly-commit-count-for-each-day) - -{% ifversion fpt or ghec %} -### Repository Vulnerability Alerts - -- [Enable vulnerability alerts](/rest/repos#enable-vulnerability-alerts) -- [Disable vulnerability alerts](/rest/repos#disable-vulnerability-alerts) -{% endif %} - -### Root - -- [Root endpoint](/rest#root-endpoint) -- [Emojis](/rest/emojis#emojis) -- [Get rate limit status for the authenticated user](/rest/rate-limit#get-rate-limit-status-for-the-authenticated-user) - -### Search - -- [Search code](/rest/search#search-code) -- [Search commits](/rest/search#search-commits) -- [Search labels](/rest/search#search-labels) -- [Search repositories](/rest/search#search-repositories) -- [Search topics](/rest/search#search-topics) -- [Search users](/rest/search#search-users) - -### Statuses - -- [Get the combined status for a specific reference](/rest/commits#get-the-combined-status-for-a-specific-reference) -- [List commit statuses for a reference](/rest/commits#list-commit-statuses-for-a-reference) -- [Create a commit status](/rest/commits#create-a-commit-status) - -{% ifversion team-discussions %} -### Team Discussions - -- [List discussions](/rest/teams#list-discussions) -- [Create a discussion](/rest/teams#create-a-discussion) -- [Get a discussion](/rest/teams#get-a-discussion) -- [Update a discussion](/rest/teams#update-a-discussion) -- [Delete a discussion](/rest/teams#delete-a-discussion) -- [List discussion comments](/rest/teams#list-discussion-comments) -- [Create a discussion comment](/rest/teams#create-a-discussion-comment) -- [Get a discussion comment](/rest/teams#get-a-discussion-comment) -- [Update a discussion comment](/rest/teams#update-a-discussion-comment) -- [Delete a discussion comment](/rest/teams#delete-a-discussion-comment) -{% endif %} - -### Topics - -- [Get all repository topics](/rest/repos#get-all-repository-topics) -- [Replace all repository topics](/rest/repos#replace-all-repository-topics) - -{% ifversion fpt or ghec %} -### Traffic - -- [Get repository clones](/rest/metrics#get-repository-clones) -- [Get top referral paths](/rest/metrics#get-top-referral-paths) -- [Get top referral sources](/rest/metrics#get-top-referral-sources) -- [Get page views](/rest/metrics#get-page-views) -{% endif %} - -{% ifversion fpt or ghec %} -### User Blocking - -- [List users blocked by the authenticated user](/rest/users#list-users-blocked-by-the-authenticated-user) -- [Check if a user is blocked by the authenticated user](/rest/users#check-if-a-user-is-blocked-by-the-authenticated-user) -- [List users blocked by an organization](/rest/orgs#list-users-blocked-by-an-organization) -- [Check if a user is blocked by an organization](/rest/orgs#check-if-a-user-is-blocked-by-an-organization) -- [Block a user from an organization](/rest/orgs#block-a-user-from-an-organization) -- [Unblock a user from an organization](/rest/orgs#unblock-a-user-from-an-organization) -- [Block a user](/rest/users#block-a-user) -- [Unblock a user](/rest/users#unblock-a-user) -{% endif %} - -{% ifversion fpt or ghes or ghec %} -### User Emails - -{% ifversion fpt or ghec %} -- [Set primary email visibility for the authenticated user](/rest/users#set-primary-email-visibility-for-the-authenticated-user) -{% endif %} -- [List email addresses for the authenticated user](/rest/users#list-email-addresses-for-the-authenticated-user) -- [Add email address(es)](/rest/users#add-an-email-address-for-the-authenticated-user) -- [Delete email address(es)](/rest/users#delete-an-email-address-for-the-authenticated-user) -- [List public email addresses for the authenticated user](/rest/users#list-public-email-addresses-for-the-authenticated-user) -{% endif %} - -### User Followers - -- [List followers of a user](/rest/users#list-followers-of-a-user) -- [List the people a user follows](/rest/users#list-the-people-a-user-follows) -- [Check if a person is followed by the authenticated user](/rest/users#check-if-a-person-is-followed-by-the-authenticated-user) -- [Follow a user](/rest/users#follow-a-user) -- [Unfollow a user](/rest/users#unfollow-a-user) -- [Check if a user follows another user](/rest/users#check-if-a-user-follows-another-user) - -### User Gpg Keys - -- [List GPG keys for the authenticated user](/rest/users#list-gpg-keys-for-the-authenticated-user) -- [Create a GPG key for the authenticated user](/rest/users#create-a-gpg-key-for-the-authenticated-user) -- [Get a GPG key for the authenticated user](/rest/users#get-a-gpg-key-for-the-authenticated-user) -- [Delete a GPG key for the authenticated user](/rest/users#delete-a-gpg-key-for-the-authenticated-user) -- [List gpg keys for a user](/rest/users#list-gpg-keys-for-a-user) - -### User Public Keys - -- [List public SSH keys for the authenticated user](/rest/users#list-public-ssh-keys-for-the-authenticated-user) -- [Create a public SSH key for the authenticated user](/rest/users#create-a-public-ssh-key-for-the-authenticated-user) -- [Get a public SSH key for the authenticated user](/rest/users#get-a-public-ssh-key-for-the-authenticated-user) -- [Delete a public SSH key for the authenticated user](/rest/users#delete-a-public-ssh-key-for-the-authenticated-user) -- [List public keys for a user](/rest/users#list-public-keys-for-a-user) - -### Users - -- [Get the authenticated user](/rest/users#get-the-authenticated-user) -- [List app installations accessible to the user access token](/rest/apps#list-app-installations-accessible-to-the-user-access-token) -{% ifversion fpt or ghec %} -- [List subscriptions for the authenticated user](/rest/apps#list-subscriptions-for-the-authenticated-user) -{% endif %} -- [List users](/rest/users#list-users) -- [Get a user](/rest/users#get-a-user) - -{% ifversion fpt or ghec %} -### Workflow Runs - -- [List workflow runs for a repository](/rest/actions#list-workflow-runs-for-a-repository) -- [Get a workflow run](/rest/actions#get-a-workflow-run) -- [Cancel a workflow run](/rest/actions#cancel-a-workflow-run) -- [Download workflow run logs](/rest/actions#download-workflow-run-logs) -- [Delete workflow run logs](/rest/actions#delete-workflow-run-logs) -- [Re run a workflow](/rest/actions#re-run-a-workflow) -- [List workflow runs](/rest/actions#list-workflow-runs) -- [Get workflow run usage](/rest/actions#get-workflow-run-usage) -{% endif %} - -{% ifversion fpt or ghec %} -### Workflows - -- [List repository workflows](/rest/actions#list-repository-workflows) -- [Get a workflow](/rest/actions#get-a-workflow) -- [Get workflow usage](/rest/actions#get-workflow-usage) -{% endif %} diff --git a/content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md b/content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md index 1f79a710f2..a9409a9b22 100644 --- a/content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md +++ b/content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md @@ -14,6 +14,7 @@ versions: ghec: '*' topics: - API + - GitHub Apps autogenerated: github-apps --- diff --git a/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md b/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md index 89e6c21856..3e3af1588d 100644 --- a/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md +++ b/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md @@ -1,6 +1,6 @@ --- title: Permissions required for fine-grained personal access tokens -intro: 'You can find the required permissions for each {% data variables.product.pat_v2 %}-compatible endpoint.' +intro: 'These are the permissions required for a {% data variables.product.pat_v2 %} to use each REST API endpoint that works with {% data variables.product.pat_v2 %}s.' versions: feature: pat-v2 shortTitle: 'Permissions for fine-grained PATs' @@ -11,5 +11,6 @@ autogenerated: github-apps When you create a {% data variables.product.pat_v2 %}, you grant it a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." +Some endpoints require additional permissions. When this is the case, the "Additional permissions" column will indicate the other permissions that are required to use the endpoint. diff --git a/content/rest/overview/permissions-required-for-github-apps.md b/content/rest/overview/permissions-required-for-github-apps.md index 8fb8a4d066..49d3040bb0 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: 'You can find the required permissions for each {% data variables.product.prodname_github_app %}-compatible endpoint.' +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.' redirect_from: - /v3/apps/permissions - /rest/reference/permissions-required-for-github-apps @@ -19,5 +19,6 @@ autogenerated: github-apps {% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/setting-permissions-for-github-apps)." +Some endpoints require additional permissions. When this is the case, the "Additional permissions" column will indicate the other permissions that are required to use the endpoint. From 001a9459faf72bf9482d23201bdcb77016436b8a Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Mon, 19 Jun 2023 09:20:04 -0700 Subject: [PATCH 2/2] SAML and GitHub Apps (#37985) Co-authored-by: James Martin --- ...g-with-a-github-app-on-behalf-of-a-user.md | 6 +++++ ...ng-a-user-access-token-for-a-github-app.md | 6 +++++ .../authorizing-github-apps.md | 8 ++++++ content/apps/using-github-apps/index.md | 1 + ...talling-a-github-app-from-a-third-party.md | 9 +++++++ .../using-github-apps/saml-and-github-apps.md | 25 +++++++++++++++++++ ...authentication-with-saml-single-sign-on.md | 2 ++ data/reusables/apps/github_app_auth_saml.md | 1 + .../reusables/apps/github_app_install_saml.md | 1 + .../confirm-install-account-org.md | 8 ++++++ 10 files changed, 67 insertions(+) create mode 100644 content/apps/using-github-apps/saml-and-github-apps.md create mode 100644 data/reusables/apps/github_app_auth_saml.md create mode 100644 data/reusables/apps/github_app_install_saml.md diff --git a/content/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user.md b/content/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user.md index 1a7db6dab2..f1cd2517ab 100644 --- a/content/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user.md +++ b/content/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user.md @@ -33,3 +33,9 @@ Once a user has authorized your app, you can generate a user access token, which Requests made with a user access token are sometimes called "user-to-server" requests. If you want to attribute app activity to the app instead of to a user, you should authenticate as an app installation instead. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation)." + +{% note %} + +**Note**: {% data reusables.apps.github_app_auth_saml %} + +{% endnote %} \ No newline at end of file diff --git a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md index 37d80b5802..aa45a2cef4 100644 --- a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md +++ b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md @@ -27,6 +27,12 @@ Users can revoke their authorization of a {% data variables.product.prodname_git You should keep user access tokens and refresh tokens secure. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app)." +{% note %} + +**Note**: {% data reusables.apps.github_app_auth_saml %} + +{% endnote %} + ## Using the web application flow to generate a user access token If your app runs in the browser, you should use the web application flow to generate a user access token. For a tutorial about using the web application flow, see "[AUTOTITLE](/apps/creating-github-apps/guides/using-the-web-application-flow-to-generate-a-user-access-token-for-a-github-app)." diff --git a/content/apps/using-github-apps/authorizing-github-apps.md b/content/apps/using-github-apps/authorizing-github-apps.md index 605356168a..c9242b3a01 100644 --- a/content/apps/using-github-apps/authorizing-github-apps.md +++ b/content/apps/using-github-apps/authorizing-github-apps.md @@ -28,6 +28,14 @@ When authorizing the {% data variables.product.prodname_github_app %}, you shoul You can review and revoke your authorization at any time. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-your-authorized-integrations)." +{% ifversion ghec %} +{% note %} + +**Note**: If your organization uses SAML SSO and you cannot see your organization's resources after you authorize a {% data variables.product.prodname_github_app %}, you may need to reauthorize the app after starting an active SAML session for your organization. For more information, see "[AUTOTITLE](/apps/using-github-apps/saml-and-github-apps)." + +{% endnote %} +{% endif %} + ## About {% data variables.product.prodname_github_app %}s 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/index.md b/content/apps/using-github-apps/index.md index 64a1b46bb3..dd9adcf11b 100644 --- a/content/apps/using-github-apps/index.md +++ b/content/apps/using-github-apps/index.md @@ -22,5 +22,6 @@ children: - /approving-updated-permissions-for-a-github-app - /reviewing-and-revoking-authorization-of-github-apps - /reviewing-and-modifying-installed-github-apps + - /saml-and-github-apps --- 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 9c11362006..fee541e8d2 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 @@ -48,6 +48,15 @@ The "app manager" role in an organization does not give a person the ability to During the installation process, the app owner will direct you to a {% data variables.product.company_short %} URL to install the {% data variables.product.prodname_github_app %}. The URL will look something like `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/APP-NAME/installations/new`, where `APP-NAME` is the name of the {% data variables.product.prodname_github_app %}. 1. Select the location where you want to install the {% data variables.product.prodname_github_app %}. You can select your personal account or an organization that you are a member of. + + {% ifversion ghec %} + {% note %} + + **Note**: {% data reusables.apps.github_app_install_saml %} + + {% endnote %} + {% endif %} + 1. If the app requires repository permissions, select **All repositories** or **Only select repositories**. The app will always have at least read-only access to all public repositories on {% data variables.product.company_short %}. If the app does not require repository permissions, these options will be omitted. diff --git a/content/apps/using-github-apps/saml-and-github-apps.md b/content/apps/using-github-apps/saml-and-github-apps.md new file mode 100644 index 0000000000..9a4f9b1642 --- /dev/null +++ b/content/apps/using-github-apps/saml-and-github-apps.md @@ -0,0 +1,25 @@ +--- +title: SAML and GitHub Apps +shortTitle: SAML with apps +intro: "If your organization uses SAML SSO, you may need to start an active SAML session for your organization before authorizing, installing, or requesting a {% data variables.product.prodname_github_app %}." +versions: + ghec: '*' +topics: + - GitHub Apps + - SSO +--- + +## Authorizing {% data variables.product.prodname_github_app %}s 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)." + +## Installing or requesting {% data variables.product.prodname_github_app %}s 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: + +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. Try to install or request the {% data variables.product.prodname_github_app %} again. For more information, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)," "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations)," and "[AUTOTITLE](/apps/using-github-apps/requesting-a-github-app-from-your-organization-owner)." diff --git a/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md b/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md index 75324f645e..0d99cb21a2 100644 --- a/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md +++ b/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md @@ -64,6 +64,8 @@ After an enterprise or organization owner enables or enforces SAML SSO for an or To see the {% data variables.product.prodname_oauth_apps %} you've authorized, visit your [{% data variables.product.prodname_oauth_apps %} page](https://github.com/settings/applications). To see the {% data variables.product.prodname_github_apps %} you've authorized, visit your [{% data variables.product.prodname_github_apps %} page](https://github.com/settings/apps/authorizations). +For more information, see "[AUTOTITLE](/apps/using-github-apps/saml-and-github-apps)." + {% endif %} ## Further reading diff --git a/data/reusables/apps/github_app_auth_saml.md b/data/reusables/apps/github_app_auth_saml.md new file mode 100644 index 0000000000..c9249602d2 --- /dev/null +++ b/data/reusables/apps/github_app_auth_saml.md @@ -0,0 +1 @@ +If a user reports that they cannot see resources owned by their organization after authorizing your {% data variables.product.prodname_github_app %} and the organization uses SAML SSO, instruct the user to start an active SAML session for their organization before reauthorizing. For more information, see {% ifversion ghec %}"[AUTOTITLE](/apps/using-github-apps/saml-and-github-apps)."{% else %}"[AUTOTITLE](/enterprise-cloud@latest/apps/using-github-apps/saml-and-github-apps)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} \ No newline at end of file diff --git a/data/reusables/apps/github_app_install_saml.md b/data/reusables/apps/github_app_install_saml.md new file mode 100644 index 0000000000..6edd0632af --- /dev/null +++ b/data/reusables/apps/github_app_install_saml.md @@ -0,0 +1 @@ +If your organization uses SAML SSO and you do not see your organization listed, you may need to start an active SAML session for your organization. For more information, see "[AUTOTITLE](/apps/using-github-apps/saml-and-github-apps)." \ No newline at end of file diff --git a/data/reusables/marketplace/confirm-install-account-org.md b/data/reusables/marketplace/confirm-install-account-org.md index 47d93cdda4..973ecf27c4 100644 --- a/data/reusables/marketplace/confirm-install-account-org.md +++ b/data/reusables/marketplace/confirm-install-account-org.md @@ -7,3 +7,11 @@ - Otherwise, under "Review your order," select the **Account** dropdown menu, then click the organization in which you'd like to install the app. ![Screenshot of the {% data variables.product.prodname_marketplace %} app purchase screen. A collapsed gray dropdown menu labeled "Account" is outlined in dark orange.](/assets/images/help/marketplace/marketplace-confirm-org-no-org-details.png) + + {% ifversion ghec %} + {% note %} + + **Note**: {% data reusables.apps.github_app_install_saml %} + + {% endnote %} + {% endif %}