Skip to content

Commit 4b764ba

Browse files
stacycarterisaacmbrownjusuchin85jc-clark
authored
Update user-provisioning-with-scim-on-ghes.md (#54807)
Co-authored-by: Isaac Brown <[email protected]> Co-authored-by: Justin Alex <[email protected]> Co-authored-by: Joe Clark <[email protected]>
1 parent c72141a commit 4b764ba

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed

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

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,25 @@ During the {% data variables.release-phases.private_preview %}, your account tea
6767

6868
When SCIM is enabled, you will no longer be able to delete, suspend, or promote SCIM-provisioned users directly on {% data variables.product.prodname_ghe_server %}. You must manage these processes from your IdP.
6969

70-
## What will happen to existing users on my instance?
70+
To view suspended members, navigate to the "Suspended Members" tab of your enterprise settings. This page will be present when SCIM is enabled on {% data variables.product.prodname_ghe_server %}.
7171

72-
If you currently use SAML SSO, and you are enabling SCIM, you should be aware of what happens to existing users during SCIM provisioning.
72+
{% data reusables.enterprise-accounts.access-enterprise %}
73+
{% data reusables.enterprise-accounts.people-tab %}
74+
1. Click **Suspended Members**.
7375

74-
* When SCIM is enabled, users with SAML-linked identities will **not be able to sign in** until their identities have been provisioned by SCIM.{% ifversion scim-for-ghes-ga %} You will no longer be able to update the SAML `NameID` of existing users in the site admin dashboard.{% endif %}
75-
* When your instance receives a SCIM request, SCIM identities are matched to existing users by **comparing the `userName` SCIM field with the {% data variables.product.prodname_dotcom %} username**. If a user with a matching username doesn't exist, {% data variables.product.prodname_dotcom %} creates a new user.
76-
* If {% data variables.product.prodname_dotcom %} successfully identifies a user from the IdP, but account details such as email address, first name, or last name don't match, the instance **overwrites the details** with values from the IdP. Any email addresses other than the primary email provisioned by SCIM will also be deleted from the user account.
76+
## What happens when I enable SCIM?
77+
78+
If you currently use SAML SSO, and you are enabling SCIM, you should be aware of what happens to existing user accounts on {% data variables.product.prodname_ghe_server %} once SCIM is enabled.
79+
80+
* Existing users with SAML mappings will **not be able to sign in** until their identities have been provisioned by SCIM.
81+
{%- ifversion scim-for-ghes-ga %}
82+
* {% data variables.product.prodname_ghe_server %} will no longer store SAML mappings for users. Instead, SCIM identities will be stored for users when a user is provisioned.
83+
* You will no longer see the "SAML authentication" section on the `https://HOSTNAME/users/USER/security` site admin page for users. It will not be possible to view or update SAML NameID mappings that were previously visible in this section, since these stored SAML mappings are no longer evaluated during SAML authentication when SCIM is enabled.
84+
{%- endif %}
85+
* When your instance receives a SCIM request, SCIM identities are matched to existing users by **comparing the SCIM `userName` attribute value with the {% data variables.product.prodname_ghe_server %} username**. This means that an existing {% data variables.product.prodname_ghe_server %} user account, regardless of whether it was originally created as a local user account or via SAML JIT-provisioning, can be converted into a SCIM-linked user account if these two values match.
86+
* If a user account with a matching username does exist, {% data variables.product.prodname_ghe_server %} links the SCIM identity to this user account.
87+
* If a user account with a matching username doesn't exist, {% data variables.product.prodname_ghe_server %} creates a new user account and links it to this SCIM identity.
88+
* If {% data variables.product.prodname_dotcom %} successfully matches a user who is authenticating via SAML with an existing user account, but account details such as email address, first name, or last name don't match, the instance **overwrites the details** with values from the IdP. Any email addresses other than the primary email provisioned by SCIM will also be deleted from the user account.
7789

7890
## What happens during SAML authentication?
7991

@@ -89,19 +101,26 @@ After an IdP administrator grants a person access to {% data variables.location.
89101

90102
## What happens if I disable SCIM?
91103

92-
SCIM will be disabled on your instance if any of the following things happens.
104+
SCIM will be disabled on {% data variables.product.prodname_ghe_server %} if any of the following things happens.
93105

94106
* The **Enable SCIM configuration** checkbox is unselected on the "Authentication security" page in the enterprise settings.
95107
* The **SAML** radio button is unselected in the "Authentication" section of the Management Console.
96108
* The SAML **Issuer** or **Single sign-on URL** field is updated in the "Authentication" section of the Management Console.
97109

98-
If SCIM is disabled on the instance:
110+
When SCIM is disabled on {% data variables.product.prodname_ghe_server %}:
99111

112+
* All linked SCIM identities and SCIM-provisioned groups will be deleted from the instance.
100113
* Requests to the SCIM API endpoints on your instance will no longer succeed.
101-
* SCIM-provisioned users will remain unchanged and will not be suspended.
114+
* All SCIM external identities on {% data variables.product.prodname_ghe_server %} will be deleted.
115+
* All user accounts will remain with the same usernames, and they will not be suspended when SCIM is disabled.
116+
* All of the external groups that were previously provisioned by SCIM will be deleted.
117+
* All user accounts, including SCIM-provisioned user accounts, will remain on the instance and will not be suspended.
102118
* Site administrators will be able to manage the lifecycle of SCIM-provisioned users, such as suspension and deletion, from the site admin dashboard.
103119
* Users will still be able to sign on via SAML, if enabled.
104-
* Users will be unlinked from their external identity record, and the record will be deleted.
120+
* 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)
121+
{%- ifversion scim-for-ghes-ga %}
122+
* 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.
123+
{%- endif %}
105124

106125
{% endif %}
107126

0 commit comments

Comments
 (0)