Skip to content

Commit c896f67

Browse files
OctomergerOctomerger
authored
Merge branch 'main' into repo-sync
2 parents e26f59b + 2effd8d commit c896f67

File tree

40 files changed

+11744
-3162
lines changed

40 files changed

+11744
-3162
lines changed

‎content/rest/enterprise-admin/scim.md

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,77 @@
11
---
22
title: SCIM
3-
intro: ''
3+
intro: 'You can automate user creation and team memberships using the SCIM API.'
44
versions:
55
ghes: '>=3.6'
66
topics:
77
- API
88
miniTocMaxHeadingLevel: 3
99
---
1010

11+
{% note %}
12+
13+
**Note:** The SCIM API for {% data variables.product.product_name %} is currently in private beta and subject to change. To access the private beta and test the API, contact your account manager on {% data variables.contact.contact_enterprise_sales %}.
14+
15+
{% endnote %}
16+
17+
## About the SCIM API
18+
19+
{% data variables.product.product_name %} provides a SCIM API for use by SCIM-enabled Identity Providers (IdPs). An integration on the IdP can use the API to automatically provision, manage, or deprovision user accounts on a {% data variables.product.product_name %} instance that uses SAML single sign-on (SSO) for authentication. For more information about SAML SSO, see "[About SAML for enterprise IAM](/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam)."
20+
21+
The SCIM API is based on SCIM 2.0. For more information, see the [specification](https://www.simplecloud.info/#Specification).
22+
23+
### SCIM endpoint URLs
24+
25+
An IdP can use the following root URL to communicate with the SCIM API for a {% data variables.product.product_name %} instance.
26+
27+
```
28+
{% data variables.product.api_url_code %}/scim/v2/
29+
```
30+
31+
Endpoint URLs for the SCIM API are case-sensitive. For example, the first letter in the `Users` endpoint must be capitalized.
32+
33+
```shell
34+
GET /scim/v2/Users/{scim_user_id}
35+
```
36+
37+
### Authenticating calls to the SCIM API
38+
39+
The SCIM integration on the IdP performs actions on behalf of an enterprise owner for the {% data variables.product.product_name %} instance. For more information, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners)."
40+
41+
To authenticate requests to the API, the person who configures SCIM on the IdP must use a personal access token (classic) with `admin:enterprise` scope, which the IdP must provide in the request's `Authorization` header. For more information about personal access tokens (classic), see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)".
42+
43+
{% note %}
44+
45+
**Note:** Enterprise owners must generate and use a personal access token (classic) for authentication of requests to the SCIM API. {% ifversion ghes > 3.8 %}Fine-grained personal access tokens and {% endif %}GitHub app callers are not supported at this time.
46+
47+
{% endnote %}
48+
49+
### About mapping of SAML and SCIM data
50+
51+
The {% data variables.product.product_name %} instance links each user who authenticates successfully with SAML SSO to a SCIM identity. To link the identities successfully, the SAML IdP and the SCIM integration must use matching SAML `NameID` and SCIM `userName` values for each user.
52+
53+
{% ifversion ghes > 3.7 %}
54+
{% note %}
55+
56+
**Note:** If the {% data variables.product.product_name %} uses Azure AD as a SAML IdP, {% data variables.product.product_name %} will also check the SCIM `externalId` claim and SAML `http://schemas.microsoft.com/identity/claims/objectidentifier` claim to match users first, instead of using `NameID` and `userName`.
57+
58+
{% endnote %}
59+
{% endif %}
60+
61+
### Supported SCIM user attributes
62+
63+
The SCIM API's `User` endpoints support the following attributes within a request's parameters.
64+
65+
| Name | Type | Description |
66+
| :- | :- | :- |
67+
| `displayName` | String | Human-readable name for a user. |
68+
| `name.formatted` | String | The user's full name, including all middle names, titles, and suffixes, formatted for display.
69+
| `name.givenName` | String | The first name of the user. |
70+
| `name.familyName` | String | The last name of the user. |
71+
| `userName` | String | The username for the user, generated by the IdP. Undergoes [normalization](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#about-username-normalization) before being used.
72+
| `emails` | Array | List of the user's emails. |
73+
| `roles` | Array | List of the user's roles. |
74+
| `externalId` | String | This identifier is generated by an IdP provider. You can find the `externalId` for a user either on the IdP, or by using the [List SCIM provisioned identities](#list-scim-provisioned-identities-for-an-enterprise) endpoint and filtering on other known attributes, such as a user's username or email address on the {% data variables.product.product_name %} instance. |
75+
| `id` | String | Identifier generated by the instance's SCIM endpoint. |
76+
| `active` | Boolean | Indicates whether the identity is active (`true`) or should be suspended (`false`). |
77+

‎data/release-notes/enterprise-server/3-3/12.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ sections:
2020
- Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail.
2121
- '{% data variables.product.prodname_actions %} storage settings cannot be validated and saved in the {% data variables.enterprise.management_console %} when "Force Path Style" is selected, and must instead be configured with the `ghe-actions-precheck` command line utility.'
2222
- '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}'
23+
- The [file finder](/search-github/searching-on-github/finding-files-on-github) does not return any results. To restore functionality, reinstall the 3.3.12 patch release using a full upgrade package. For more information, see "[Upgrading GitHub Enterprise Server](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-with-an-upgrade-package)."

‎lib/redirects/static/client-side-rest-api-redirects.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -956,8 +956,8 @@
956956
"/rest/teams#unlink-external-idp-group-team-connection": "/rest/teams/external-groups#unlink-external-idp-group-team-connection",
957957
"/rest/teams#list-idp-groups-for-a-team": "/rest/teams/team-sync#list-idp-groups-for-a-team",
958958
"/rest/teams#create-or-update-idp-group-connections": "/rest/teams/team-sync#create-or-update-idp-group-connections",
959-
"/rest/actions/oidc#get-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository": "/rest/actions/oidc#get-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository",
960-
"/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository": "/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository",
959+
"/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository": "/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository",
960+
"/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository": "/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository",
961961
"/rest/teams#list-idp-groups-for-a-team-legacy": "/rest/teams/team-sync#list-idp-groups-for-a-team-legacy",
962962
"/rest/teams#create-or-update-idp-group-connections-legacy": "/rest/teams/team-sync#create-or-update-idp-group-connections-legacy",
963963
"/rest/enterprise-admin#list-global-webhooks": "/rest/enterprise-admin/global-webhooks#list-global-webhooks",

‎lib/rest/static/apps/enabled-for-apps.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4115,13 +4115,13 @@
41154115
"requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun"
41164116
},
41174117
{
4118-
"slug": "get-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository",
4118+
"slug": "get-the-customization-template-for-an-oidc-subject-claim-for-a-repository",
41194119
"subcategory": "oidc",
41204120
"verb": "get",
41214121
"requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub"
41224122
},
41234123
{
4124-
"slug": "set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository",
4124+
"slug": "set-the-customization-template-for-an-oidc-subject-claim-for-a-repository",
41254125
"subcategory": "oidc",
41264126
"verb": "put",
41274127
"requestPath": "/repos/{owner}/{repo}/actions/oidc/customization/sub"
@@ -22133,7 +22133,7 @@
2213322133
"requestPath": "/scim/v2/enterprises/{enterprise}/Groups"
2213422134
},
2213522135
{
22136-
"slug": "provision-a-scim-enterprise-group-and-invite-users",
22136+
"slug": "provision-a-scim-enterprise-group",
2213722137
"subcategory": "scim",
2213822138
"verb": "post",
2213922139
"requestPath": "/scim/v2/enterprises/{enterprise}/Groups"
@@ -22169,7 +22169,7 @@
2216922169
"requestPath": "/scim/v2/enterprises/{enterprise}/Users"
2217022170
},
2217122171
{
22172-
"slug": "provision-and-invite-a-scim-enterprise-user",
22172+
"slug": "provision-a-scim-enterprise-user",
2217322173
"subcategory": "scim",
2217422174
"verb": "post",
2217522175
"requestPath": "/scim/v2/enterprises/{enterprise}/Users"

‎lib/rest/static/decorated/api.github.com.json

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88571,6 +88571,10 @@
8857188571
"contentType": "application/json",
8857288572
"description": "Example",
8857388573
"acceptHeader": "application/vnd.github.v3+json",
88574+
"bodyParameters": {
88575+
"subscribed": true,
88576+
"ignored": false
88577+
},
8857488578
"parameters": {
8857588579
"owner": "OWNER",
8857688580
"repo": "REPO"
@@ -241395,6 +241399,10 @@
241395241399
"contentType": "application/json",
241396241400
"description": "Example",
241397241401
"acceptHeader": "application/vnd.github.v3+json",
241402+
"bodyParameters": {
241403+
"limit": "collaborators_only",
241404+
"expiry": "one_month"
241405+
},
241398241406
"parameters": {
241399241407
"org": "ORG"
241400241408
}
@@ -383879,7 +383887,7 @@
383879383887
"type": "string",
383880383888
"name": "merge_method",
383881383889
"in": "body",
383882-
"description": "<p>Merge method to use. Possible values are <code>merge</code>, <code>squash</code> or <code>rebase</code>. Default is <code>merge</code>.</p>",
383890+
"description": "<p>The merge method to use.</p>",
383883383891
"enum": [
383884383892
"merge",
383885383893
"squash",
@@ -383890,11 +383898,15 @@
383890383898
"enabledForGitHubApps": true,
383891383899
"codeExamples": [
383892383900
{
383893-
"key": "default",
383901+
"key": "response-if-merge-was-successful",
383894383902
"request": {
383895383903
"contentType": "application/json",
383896383904
"description": "Example",
383897383905
"acceptHeader": "application/vnd.github.v3+json",
383906+
"bodyParameters": {
383907+
"commit_title": "Expand enum",
383908+
"commit_message": "Add a new value to the merge_method enum"
383909+
},
383898383910
"parameters": {
383899383911
"owner": "OWNER",
383900383912
"repo": "REPO",
@@ -441091,7 +441103,14 @@
441091441103
"request": {
441092441104
"contentType": "application/json",
441093441105
"description": "Example",
441094-
"acceptHeader": "application/vnd.github.v3+json"
441106+
"acceptHeader": "application/vnd.github.v3+json",
441107+
"bodyParameters": {
441108+
"name": "Hello-World",
441109+
"description": "This is your first repo!",
441110+
"homepage": "https://github.com",
441111+
"private": false,
441112+
"is_template": true
441113+
}
441095441114
},
441096441115
"response": {
441097441116
"statusCode": "201",
@@ -448469,6 +448488,11 @@
448469448488
"contentType": "application/json",
448470448489
"description": "Example",
448471448490
"acceptHeader": "application/vnd.github.v3+json",
448491+
"bodyParameters": {
448492+
"organization": "octocat",
448493+
"name": "Hello-World",
448494+
"default_branch_only": true
448495+
},
448472448496
"parameters": {
448473448497
"owner": "OWNER",
448474448498
"repo": "REPO"

0 commit comments

Comments
 (0)