Skip to content

Commit cfd2822

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #1657 from github/openapi-update-6a8eab87a5a72e072b0947c8d3baa959279bb92378e0e465acf69a5ec33a27bd
Update OpenAPI 3.1 Descriptions
2 parents cf789f5 + 34f3c12 commit cfd2822

4 files changed

Lines changed: 16 additions & 16 deletions

File tree

‎descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -395184,13 +395184,13 @@
395184395184
"post": {
395185395185
"summary": "Provision a SCIM enterprise group",
395186395186
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.",
395187-
"operationId": "enterprise-admin/provision-and-invite-enterprise-group",
395187+
"operationId": "enterprise-admin/provision-enterprise-group",
395188395188
"tags": [
395189395189
"enterprise-admin"
395190395190
],
395191395191
"externalDocs": {
395192395192
"description": "API method documentation",
395193-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users"
395193+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group"
395194395194
},
395195395195
"parameters": [
395196395196
{
@@ -398593,13 +398593,13 @@
398593398593
"post": {
398594398594
"summary": "Provision a SCIM enterprise user",
398595398595
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.",
398596-
"operationId": "enterprise-admin/provision-and-invite-enterprise-user",
398596+
"operationId": "enterprise-admin/provision-enterprise-user",
398597398597
"tags": [
398598398598
"enterprise-admin"
398599398599
],
398600398600
"externalDocs": {
398601398601
"description": "API method documentation",
398602-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user"
398602+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-user"
398603398603
},
398604398604
"parameters": [
398605398605
{

‎descriptions-next/ghes-3.6/dereferenced/ghes-3.6.deref.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66845,12 +66845,12 @@ paths:
6684566845
Creates a SCIM group for an enterprise.
6684666846

6684766847
If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.
66848-
operationId: enterprise-admin/provision-and-invite-enterprise-group
66848+
operationId: enterprise-admin/provision-enterprise-group
6684966849
tags:
6685066850
- enterprise-admin
6685166851
externalDocs:
6685266852
description: API method documentation
66853-
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users
66853+
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group
6685466854
parameters:
6685566855
- *60
6685666856
requestBody:
@@ -67397,12 +67397,12 @@ paths:
6739767397
SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.
6739867398

6739967399
When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
67400-
operationId: enterprise-admin/provision-and-invite-enterprise-user
67400+
operationId: enterprise-admin/provision-enterprise-user
6740167401
tags:
6740267402
- enterprise-admin
6740367403
externalDocs:
6740467404
description: API method documentation
67405-
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user
67405+
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-user
6740667406
parameters:
6740767407
- *60
6740867408
requestBody:

‎descriptions-next/ghes-3.6/ghes-3.6.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45199,13 +45199,13 @@
4519945199
"post": {
4520045200
"summary": "Provision a SCIM enterprise group",
4520145201
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.",
45202-
"operationId": "enterprise-admin/provision-and-invite-enterprise-group",
45202+
"operationId": "enterprise-admin/provision-enterprise-group",
4520345203
"tags": [
4520445204
"enterprise-admin"
4520545205
],
4520645206
"externalDocs": {
4520745207
"description": "API method documentation",
45208-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users"
45208+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group"
4520945209
},
4521045210
"parameters": [
4521145211
{
@@ -45698,13 +45698,13 @@
4569845698
"post": {
4569945699
"summary": "Provision a SCIM enterprise user",
4570045700
"description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.",
45701-
"operationId": "enterprise-admin/provision-and-invite-enterprise-user",
45701+
"operationId": "enterprise-admin/provision-enterprise-user",
4570245702
"tags": [
4570345703
"enterprise-admin"
4570445704
],
4570545705
"externalDocs": {
4570645706
"description": "API method documentation",
45707-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user"
45707+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-user"
4570845708
},
4570945709
"parameters": [
4571045710
{

‎descriptions-next/ghes-3.6/ghes-3.6.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32187,12 +32187,12 @@ paths:
3218732187
Creates a SCIM group for an enterprise.
3218832188

3218932189
If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.
32190-
operationId: enterprise-admin/provision-and-invite-enterprise-group
32190+
operationId: enterprise-admin/provision-enterprise-group
3219132191
tags:
3219232192
- enterprise-admin
3219332193
externalDocs:
3219432194
description: API method documentation
32195-
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users
32195+
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group
3219632196
parameters:
3219732197
- "$ref": "#/components/parameters/enterprise"
3219832198
requestBody:
@@ -32535,12 +32535,12 @@ paths:
3253532535
SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.
3253632536

3253732537
When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
32538-
operationId: enterprise-admin/provision-and-invite-enterprise-user
32538+
operationId: enterprise-admin/provision-enterprise-user
3253932539
tags:
3254032540
- enterprise-admin
3254132541
externalDocs:
3254232542
description: API method documentation
32543-
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user
32543+
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-user
3254432544
parameters:
3254532545
- "$ref": "#/components/parameters/enterprise"
3254632546
requestBody:

0 commit comments

Comments
 (0)