SAML and GitHub Apps (#37985)
Co-authored-by: James Martin <jamesmartin@users.noreply.github.com>
This commit is contained in:
@@ -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 %}.
|
||||
|
||||
@@ -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
|
||||
---
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
25
content/apps/using-github-apps/saml-and-github-apps.md
Normal file
25
content/apps/using-github-apps/saml-and-github-apps.md
Normal file
@@ -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)."
|
||||
Reference in New Issue
Block a user