Skip to content

Commit cf789f5

Browse files
authored
Merge pull request #1656 from github/openapi-update-c79c769b41b3369c5576626d9cd6166e2c60f2e0ceefbed9c58322b7f78a3d93
Update OpenAPI 3.0 Descriptions
2 parents a81864b + 3eb7de4 commit cf789f5

4 files changed

Lines changed: 16 additions & 16 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -333716,13 +333716,13 @@
333716333716
"post": {
333717333717
"summary": "Provision a SCIM enterprise group",
333718333718
"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.",
333719-
"operationId": "enterprise-admin/provision-and-invite-enterprise-group",
333719+
"operationId": "enterprise-admin/provision-enterprise-group",
333720333720
"tags": [
333721333721
"enterprise-admin"
333722333722
],
333723333723
"externalDocs": {
333724333724
"description": "API method documentation",
333725-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users"
333725+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group"
333726333726
},
333727333727
"parameters": [
333728333728
{
@@ -336703,13 +336703,13 @@
336703336703
"post": {
336704336704
"summary": "Provision a SCIM enterprise user",
336705336705
"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.",
336706-
"operationId": "enterprise-admin/provision-and-invite-enterprise-user",
336706+
"operationId": "enterprise-admin/provision-enterprise-user",
336707336707
"tags": [
336708336708
"enterprise-admin"
336709336709
],
336710336710
"externalDocs": {
336711336711
"description": "API method documentation",
336712-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user"
336712+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-user"
336713336713
},
336714336714
"parameters": [
336715336715
{

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

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

6537265372
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.
65373-
operationId: enterprise-admin/provision-and-invite-enterprise-group
65373+
operationId: enterprise-admin/provision-enterprise-group
6537465374
tags:
6537565375
- enterprise-admin
6537665376
externalDocs:
6537765377
description: API method documentation
65378-
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users
65378+
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group
6537965379
parameters:
6538065380
- *62
6538165381
requestBody:
@@ -65904,12 +65904,12 @@ paths:
6590465904
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`.
6590565905

6590665906
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.
65907-
operationId: enterprise-admin/provision-and-invite-enterprise-user
65907+
operationId: enterprise-admin/provision-enterprise-user
6590865908
tags:
6590965909
- enterprise-admin
6591065910
externalDocs:
6591165911
description: API method documentation
65912-
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user
65912+
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-user
6591365913
parameters:
6591465914
- *62
6591565915
requestBody:

descriptions/ghes-3.6/ghes-3.6.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44946,13 +44946,13 @@
4494644946
"post": {
4494744947
"summary": "Provision a SCIM enterprise group",
4494844948
"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.",
44949-
"operationId": "enterprise-admin/provision-and-invite-enterprise-group",
44949+
"operationId": "enterprise-admin/provision-enterprise-group",
4495044950
"tags": [
4495144951
"enterprise-admin"
4495244952
],
4495344953
"externalDocs": {
4495444954
"description": "API method documentation",
44955-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users"
44955+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group"
4495644956
},
4495744957
"parameters": [
4495844958
{
@@ -45445,13 +45445,13 @@
4544545445
"post": {
4544645446
"summary": "Provision a SCIM enterprise user",
4544745447
"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.",
45448-
"operationId": "enterprise-admin/provision-and-invite-enterprise-user",
45448+
"operationId": "enterprise-admin/provision-enterprise-user",
4544945449
"tags": [
4545045450
"enterprise-admin"
4545145451
],
4545245452
"externalDocs": {
4545345453
"description": "API method documentation",
45454-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user"
45454+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-user"
4545545455
},
4545645456
"parameters": [
4545745457
{

descriptions/ghes-3.6/ghes-3.6.yaml

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

3206232062
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.
32063-
operationId: enterprise-admin/provision-and-invite-enterprise-group
32063+
operationId: enterprise-admin/provision-enterprise-group
3206432064
tags:
3206532065
- enterprise-admin
3206632066
externalDocs:
3206732067
description: API method documentation
32068-
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users
32068+
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group
3206932069
parameters:
3207032070
- "$ref": "#/components/parameters/enterprise"
3207132071
requestBody:
@@ -32408,12 +32408,12 @@ paths:
3240832408
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`.
3240932409

3241032410
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.
32411-
operationId: enterprise-admin/provision-and-invite-enterprise-user
32411+
operationId: enterprise-admin/provision-enterprise-user
3241232412
tags:
3241332413
- enterprise-admin
3241432414
externalDocs:
3241532415
description: API method documentation
32416-
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user
32416+
url: https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-user
3241732417
parameters:
3241832418
- "$ref": "#/components/parameters/enterprise"
3241932419
requestBody:

0 commit comments

Comments
 (0)