Skip to content

Commit 3de34c4

Browse files
authoredApr 18, 2025
Merge pull request #37640 from github/repo-sync
Repo sync
2 parents fcbda1b + f0c6820 commit 3de34c4

File tree

27 files changed

+196
-45
lines changed

27 files changed

+196
-45
lines changed
 
Loading
Loading
-870 Bytes
Loading
3.15 KB
Loading
1.92 KB
Loading
64 Bytes
Loading

‎assets/images/social-cards/issues.png

3.01 KB
Loading

‎content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge.md

+13
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@ versions:
2020

2121
To add a workflow status badge to your `README.md` file, first find the URL for the status badge you would like to display. Then you can use Markdown to display the badge as an image in your `README.md` file. For more information about image markup in Markdown, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images).
2222

23+
## Using the UI
24+
25+
You can create a workflow status badge directly on the UI using the workflow file name, branch parameter, and event parameter.
26+
27+
{% data reusables.repositories.navigate-to-repo %}
28+
{% data reusables.repositories.actions-tab %}
29+
{% data reusables.repositories.navigate-to-workflow %}
30+
1. On the right side of the page, next to the "Filter workflow runs" field, click {% octicon "kebab-horizontal" aria-label="Show workflow options" %} to display a dropdown menu and click **Create status badge**.
31+
1. Optionally, select a branch if you want to display the status badge for a branch different from the default branch.
32+
1. Optionally, select the event that will trigger the workflow.
33+
1. Click **{% octicon "copy" aria-hidden="true" %} Copy status badge Markdown**.
34+
1. Copy the Markdown into your `README.md` file.
35+
2336
## Using the workflow file name
2437

2538
You can build the URL for a workflow status badge using the name of the workflow file:

‎content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/exporting-membership-information-for-your-enterprise.md

+2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ You can also use {% data variables.product.prodname_dotcom %}'s APIs to retrieve
3434

3535
Organization owners can also export membership information for an organization. For more information, see [AUTOTITLE](/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization).
3636

37+
The membership information report includes everyone associated with the enterprise, regardless of whether they consume a license. This report is useful for reviewing current enterprise membership, permissions, and roles for all individuals currently associated with the enterprise. For information about current and billable licenses, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise).
38+
3739
## Exporting a membership information report
3840

3941
You can download a CSV file containing the membership information report for your enterprise.

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

+1-1
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-accounts-and-repositories/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md

+14
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@ If your enterprise uses {% data variables.product.prodname_emus %}, you will not
4545
{% data reusables.saml.revoke-sso-identity %}
4646
{% data reusables.saml.confirm-revoke-identity %}
4747

48+
{% elsif scim-for-ghes-public-beta %}
49+
50+
## Viewing a linked identity
51+
52+
You can view the single sign-on identity that a member has linked to their account on GitHub.
53+
54+
{% data reusables.enterprise-accounts.access-enterprise %}
55+
{% data reusables.enterprise-accounts.people-tab %}
56+
{% data reusables.saml.click-person-revoke-identity %}
57+
{% data reusables.saml.saml-identity-linked %}
58+
{% data reusables.saml.view-sso-identity %}
59+
60+
The identity data on this page will include the SCIM data that was sent to {% data variables.product.github %} during user provisioning. This SCIM data is what {% data variables.product.github %} uses when matching a SAML SSO request to the provisioned user. Note that {% data variables.product.github %} does not use SAML mappings when SCIM is enabled. For more information on how {% data variables.product.github %} maps SAML and SCIM data for users, please see [AUTOTITLE](/rest/enterprise-admin/scim?apiVersion=2022-11-28#mapping-of-saml-and-scim-data).
61+
4862
{% endif %}
4963

5064
## Viewing and revoking an active SAML session

‎content/admin/managing-iam/iam-configuration-reference/username-considerations-for-external-authentication.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -97,14 +97,19 @@ This will cause a username conflict, and only the first user will be provisioned
9797

9898
Usernames{% ifversion ghec %}, including underscore and short code,{% endif %} must not exceed 39 characters.
9999

100+
{% ifversion ghes %}
101+
> [!NOTE]
102+
> If you use SAML with SCIM provisioning, users must be SCIM provisioned before using SAML single sign-on. If a user hasn't been provisioned, they won't be able to complete authentication on your {% data variables.product.prodname_ghe_server %} instance. For more information, see [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes#how-will-i-manage-user-lifecycles-with-scim).
103+
{% endif %}
104+
100105
## About username normalization
101106

102107
Usernames for user accounts on {% data variables.product.prodname_dotcom %} can only contain alphanumeric characters and dashes (`-`).
103108

104109
{% ifversion ghec %}
105110
When you configure SAML authentication, {% data variables.product.github %} uses the SCIM `userName` attribute value sent from the IdP to determine the username for the corresponding user account on {% data variables.product.prodname_dotcom %}. If this value includes unsupported characters, {% data variables.product.github %} will normalize the username per the following rules.
106111
{% elsif ghes %}
107-
When you configure CAS, LDAP, or SAML authentication, {% data variables.product.prodname_ghe_server %} uses an identifier from the user account on your external authentication provider to determine the username for the corresponding user account on your {% data variables.product.prodname_ghe_server %} instance. If the identifier includes unsupported characters, {% data variables.product.github %} will normalize the username per the following rules.
112+
When you configure CAS, LDAP, or SAML authentication (without SCIM), {% data variables.product.prodname_ghe_server %} uses an identifier from the user account on your external authentication provider to determine the username for the corresponding user account on your {% data variables.product.prodname_ghe_server %} instance. When SAML authentication is configured with SCIM, {% data variables.product.github %} uses the SCIM `userName` attribute value sent from the IdP to determine the username for the corresponding user account. If the identifier includes unsupported characters, {% data variables.product.github %} will normalize the username per the following rules.
108113
{% endif %}
109114

110115
1. {% data variables.product.github %} will normalize any non-alphanumeric character in your account's username into a dash. For example, a username of `mona.the.octocat` will be normalized to `mona-the-octocat`. Note that normalized usernames also can't start or end with a dash. They also can't contain two consecutive dashes.
@@ -154,7 +159,7 @@ When you configure CAS, LDAP, or SAML authentication, {% data variables.product.
154159

155160
## Resolving username problems
156161

157-
When a new user is being provisioned, if the username is longer than 39 characters (including underscore and short code), or conflicts with an existing user in the enterprise, the provisioning attempt will fail with a `409` error.
162+
When a new user is being provisioned, if the username conflicts with an existing user in the enterprise, the provisioning attempt will fail with a `409` error. If the username is longer than 39 characters (including underscore{% ifversion ghec %} and short code{% endif %}), the provisioning attempt will fail with a `400` error. For a full list of possible user provisioning status codes, see [AUTOTITLE](/rest/enterprise-admin/scim?apiVersion=2022-11-28#provision-a-scim-enterprise-user--status-codes).
158163

159164
To resolve this problem, you must make one of the following changes in your IdP so that all normalized usernames will be within the character limit and unique.
160165

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

+8-3
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

+1
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/provisioning-users-and-groups-with-scim-using-the-rest-api.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,9 @@ After you configure SCIM provisioning for your enterprise, you may need to migra
267267

268268
* If your requests to the REST API are rate-limited, you can learn more in [Understand rate limits on {% data variables.product.prodname_dotcom %}](#understand-rate-limits-on-github).
269269

270-
* If you enable audit log streaming and stream events for API requests, you can review any requests to the REST API endpoints for SCIM provisioning by filtering for events from the `EnterpriseUsersScim` or `EnterpriseGroupsScim` controllers.
270+
* All SCIM requests that {% data variables.product.company_short %} receives, with the exception of successful HTTP `GET` requests, will generate an [audit log](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#external_identity) event. These logs will contain useful information about the request outcome, payload information, and any errors. These logs can be used to determine whether or not {% data variables.product.company_short %} received a SCIM request, and troubleshoot API failures.
271+
* To determine if a user has been provisioned, you can use the following audit log query: `action:external_identity.provision user:USERNAME{% ifversion ghec %}_SHORTCODE{% endif %}`
272+
* If you do not find a user using the query above, you can search for `action:external_identity.scim_api_failure` events on the date that you expected to have received the request.
271273

272274
* If a SCIM request fails and you're unable to determine the cause, check the status of your identity management system to ensure that services were available.{% ifversion ghec %} Additionally, check {% data variables.product.company_short %}'s status page. For more information, see [AUTOTITLE](/support/learning-about-github-support/about-github-support#about-github-status).{% endif %}
273275

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

+2-25
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

0 commit comments

Comments
 (0)