Skip to content

Commit a9a2372

Browse files
taylorreissaritai
andauthored
GHES SCIM Documentation Updates (Batch 2/3) (#55212)
Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
1 parent 1b3650e commit a9a2372

File tree

6 files changed

+64
-29
lines changed

6 files changed

+64
-29
lines changed

content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Before suspending site administrators, you must demote them to regular users. Se
4444
If you use certain external authentication features, you cannot manage user suspension from the site admin dashboard or command line:
4545

4646
* If LDAP Sync is enabled for {% data variables.location.product_location %}, users are automatically suspended based on the scenarios that are described in [AUTOTITLE](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync).
47-
* If SCIM provisioning is enabled, SCIM-provisioned users must be suspended or unsuspended through your identity provider.
47+
* If SCIM provisioning is enabled, SCIM-provisioned users must be suspended or unsuspended through your identity provider.{% ifversion scim-for-ghes-public-beta %} See [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/provisioning-users-and-groups-with-scim-using-the-rest-api#provisioning-users-with-the-rest-api).{% endif %}
4848

4949
## Viewing suspended users in the site admin dashboard
5050

content/admin/managing-iam/provisioning-user-accounts-with-scim/configuring-scim-provisioning-for-users.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,8 @@ To ensure you can continue to sign in and configure settings when SCIM is enable
126126
{% data reusables.enterprise-accounts.security-tab %}
127127
1. Under "SCIM Configuration", select **Enable SCIM configuration**.
128128

129+
You can confirm that SCIM is now enabled by checking your instance's [audit logs](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise). You should expect to see a "business.enable_open_scim" event, indicating that GitHub's [SCIM REST API](/admin/managing-iam/provisioning-user-accounts-with-scim/provisioning-users-and-groups-with-scim-using-the-rest-api) has been enabled on your instance.
130+
129131
{% endif %}
130132

131133
{% ifversion ghec %}
@@ -191,12 +193,15 @@ If you don't use a partner IdP, or if you only use a partner IdP for authenticat
191193

192194
{% ifversion scim-for-ghes-public-beta %}
193195

194-
## 6. Disable optional settings
196+
## 6. Update settings
197+
198+
After you have finished the configuration process, you should disable the following setting in the Management Console:
199+
200+
* **Disable administrator demotion/promotion**: Disable this setting to allow assignment of the enterprise owner role via SCIM. If this setting remains enabled, you will not be able to provision enterprise owners via SCIM.
195201

196-
After you have finished the configuration process, you can disable the following settings in the Management Console:
202+
Optionally, you can disable the following setting in the Management Console as well:
197203

198204
* **Allow creation of accounts with built-in authentication**: Disable this setting if you want all users to be provisioned from your IdP.
199-
* **Disable administrator demotion/promotion**: Disable this setting if you want to be able to grant the enterprise owner role via SCIM.
200205

201206
{% endif %}
202207

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Disabling SCIM provisioning for users
3+
shortTitle: Disable SCIM provisioning
4+
intro: 'You can disable SCIM provisioning for your enterprise''s user accounts.'
5+
permissions: Site administrators
6+
versions:
7+
feature: scim-for-ghes-public-beta
8+
topics:
9+
- Accounts
10+
- Enterprise
11+
---
12+
13+
{% data reusables.scim.ghes-beta-note %}
14+
15+
## How do I disable SCIM?
16+
17+
To disable SCIM provisioning while keeping SAML on:
18+
19+
{% data reusables.enterprise-accounts.access-enterprise %}
20+
{% data reusables.enterprise-accounts.settings-tab %}
21+
{% data reusables.enterprise-accounts.security-tab %}
22+
4. Deselect **Enable SCIM configuration**.
23+
24+
When this happens, users will still be able to use SAML single sign-on through your identity provider, but SCIM provisioning will no longer work. Instead, SAML JIT provisioning will be used again. For more information on SAML provisioning, see [AUTOTITLE](/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise).
25+
26+
If for some reason you no longer have access to your instance, you will need to sign in to the management console and enable built-in authentication. For more information, see [AUTOTITLE](/admin/managing-iam/using-built-in-authentication/configuring-built-in-authentication#configuring-built-in-authentication). Once this is complete, you can sign in to your instance with the SCIM setup user you created when enabling SCIM, and uncheck the **Enable SCIM configuration** checkbox described above.
27+
28+
## How else can be SCIM disabled?
29+
30+
In addition to directly disabling SCIM provisioning on your instance, SCIM will be disabled if any of the following actions are taken:
31+
32+
* The **SAML** radio button is unselected in the "Authentication" section of the Management Console.
33+
* The SAML **Issuer** or **Single sign-on URL** field is updated in the "Authentication" section of the Management Console.
34+
35+
## What happens if I disable SCIM?
36+
37+
When SCIM is disabled on {% data variables.product.prodname_ghe_server %}:
38+
39+
* In your instance's [audit logs](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise), you should expect to see a "business.disable_open_scim" event.
40+
* All linked SCIM identities and SCIM-provisioned groups will be deleted from the instance.
41+
* Requests to the SCIM API endpoints on your instance will no longer succeed.
42+
* All SCIM external identities on {% data variables.product.prodname_ghe_server %} will be deleted.
43+
* All user accounts will remain with the same usernames, and they will not be suspended when SCIM is disabled.
44+
* All of the external groups that were previously provisioned by SCIM will be deleted.
45+
* All user accounts, including SCIM-provisioned user accounts, will remain on the instance and will not be suspended.
46+
* Site administrators will be able to manage the lifecycle of SCIM-provisioned users, such as suspension and deletion, from the site admin dashboard.
47+
* Users will still be able to sign on via SAML, if enabled.
48+
* The "Suspended Members" page in your enterprise settings will no longer be present. Suspended members can still be seen in the [Site Admin dashboard](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/suspending-and-unsuspending-users#viewing-suspended-users-in-the-site-admin-dashboard)
49+
{%- ifversion scim-for-ghes-ga %}
50+
* You will be able to see the "SAML authentication" section on the `https://HOSTNAME/users/USER/security` site admin page for users. If any SAML mappings were previously created for users on the {% data variables.product.prodname_ghe_server %} before SCIM was enabled, it will be possible to once again view and update them in this section.
51+
{%- endif %}

content/admin/managing-iam/provisioning-user-accounts-with-scim/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ children:
1616
- /configuring-authentication-and-provisioning-with-entra-id
1717
- /configuring-authentication-and-provisioning-with-pingfederate
1818
- /configuring-scim-provisioning-with-okta
19+
- /disabling-scim-provisioning-for-users
1920
- /provisioning-users-and-groups-with-scim-using-the-rest-api
2021
- /managing-team-memberships-with-identity-provider-groups
2122
- /troubleshooting-team-membership-with-identity-provider-groups

content/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes.md

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -101,32 +101,9 @@ After an IdP administrator grants a person access to {% data variables.location.
101101

102102
{% ifversion scim-for-ghes-public-beta %}
103103

104-
## What happens if I disable SCIM?
104+
## How is SCIM disabled?
105105

106-
SCIM will be disabled on {% data variables.product.prodname_ghe_server %} if any of the following things happens.
107-
108-
* The **Enable SCIM configuration** checkbox is unselected on the "Authentication security" page in the enterprise settings.
109-
* The **SAML** radio button is unselected in the "Authentication" section of the Management Console.
110-
* The SAML **Issuer** or **Single sign-on URL** field is updated in the "Authentication" section of the Management Console.
111-
112-
When SCIM is disabled on {% data variables.product.prodname_ghe_server %}:
113-
114-
* All linked SCIM identities and SCIM-provisioned groups will be deleted from the instance.
115-
* Requests to the SCIM API endpoints on your instance will no longer succeed.
116-
* All SCIM external identities on {% data variables.product.prodname_ghe_server %} will be deleted.
117-
* All user accounts will remain with the same usernames, and they will not be suspended when SCIM is disabled.
118-
* All of the external groups that were previously provisioned by SCIM will be deleted.
119-
* All user accounts, including SCIM-provisioned user accounts, will remain on the instance and will not be suspended.
120-
* Site administrators will be able to manage the lifecycle of SCIM-provisioned users, such as suspension and deletion, from the site admin dashboard.
121-
* Users will still be able to sign on via SAML, if enabled.
122-
* The "Suspended Members" page in your enterprise settings will no longer be present. Suspended members can still be seen in the [Site Admin dashboard](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/suspending-and-unsuspending-users#viewing-suspended-users-in-the-site-admin-dashboard)
123-
{%- ifversion scim-for-ghes-ga %}
124-
* You will be able to see the "SAML authentication" section on the `https://HOSTNAME/users/USER/security` site admin page for users. If any SAML mappings were previously created for users on the {% data variables.product.prodname_ghe_server %} before SCIM was enabled, it will be possible to once again view and update them in this section.
125-
{%- endif %}
126-
127-
{% endif %}
128-
129-
{% ifversion scim-for-ghes-public-beta %}
106+
For more information on the different ways that SCIM can be disabled, see [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/disabling-scim-provisioning-for-users).
130107

131108
## Getting started
132109

content/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,4 +146,5 @@ You can enable or disable SAML authentication for {% data variables.location.pro
146146
{%- endif %}
147147
{%- ifversion ghes %}
148148
* [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator)
149+
{% ifversion scim-for-ghes-public-beta %}* [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/configuring-scim-provisioning-for-users){% endif %}
149150
{%- endif %}

0 commit comments

Comments
 (0)