diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 02cb38d7c..39d3202d4 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -434431,7 +434431,7 @@ "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", + "description": "Lists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "operationId": "enterprise-admin/list-provisioned-groups-enterprise", "tags": [ "enterprise-admin", @@ -434966,7 +434966,7 @@ }, "post": { "summary": "Provision a SCIM enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nCreates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", + "description": "Creates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", "operationId": "enterprise-admin/provision-enterprise-group", "tags": [ "enterprise-admin" @@ -435475,7 +435475,7 @@ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nGets information about a SCIM group.", + "description": "Gets information about a SCIM group.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", "tags": [ "enterprise-admin" @@ -435950,7 +435950,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "Replaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", "tags": [ "enterprise-admin" @@ -436542,7 +436542,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n> [!NOTE]\n> Memberships are referenced via a local user id. Ensure users are created before referencing them here.", + "description": "Update a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n> [!NOTE]\n> Memberships are referenced via a local user id. Ensure users are created before referencing them here.", "operationId": "enterprise-admin/update-attribute-for-enterprise-group", "tags": [ "enterprise-admin" @@ -437132,7 +437132,7 @@ }, "delete": { "summary": "Delete a SCIM group from an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning using the REST API is in public preview and subject to change.\n\nDeletes a SCIM group from an enterprise.", + "description": "Deletes a SCIM group from an enterprise.", "operationId": "enterprise-admin/delete-scim-group-from-enterprise", "tags": [ "enterprise-admin" @@ -437429,7 +437429,7 @@ "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", + "description": "Lists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", "operationId": "enterprise-admin/list-provisioned-identities-enterprise", "tags": [ "enterprise-admin" @@ -438025,7 +438025,7 @@ }, "post": { "summary": "Provision a SCIM enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", + "description": "Creates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", "operationId": "enterprise-admin/provision-enterprise-user", "tags": [ "enterprise-admin" @@ -438789,7 +438789,7 @@ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nGets information about a SCIM user.", + "description": "Gets information about a SCIM user.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", "tags": [ "enterprise-admin" @@ -439331,7 +439331,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", + "description": "Replaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", "tags": [ "enterprise-admin" @@ -440060,7 +440060,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", + "description": "Update a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "operationId": "enterprise-admin/update-attribute-for-enterprise-user", "tags": [ "enterprise-admin" @@ -440788,7 +440788,7 @@ }, "delete": { "summary": "Delete a SCIM user from an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning using the REST API is in public preview and subject to change.\n\nSuspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", + "description": "Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", "operationId": "enterprise-admin/delete-user-from-enterprise", "tags": [ "enterprise-admin" diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 96f908a4c..f86cc4603 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -89102,9 +89102,6 @@ paths: get: summary: List provisioned SCIM groups for an enterprise description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Lists provisioned SCIM groups in an enterprise. You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. @@ -89359,9 +89356,6 @@ paths: post: summary: Provision a SCIM enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Creates a SCIM group for an enterprise. When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. @@ -89469,11 +89463,7 @@ paths: "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": get: summary: Get SCIM provisioning information for an enterprise group - description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - - Gets information about a SCIM group. + description: Gets information about a SCIM group. operationId: enterprise-admin/get-provisioning-information-for-enterprise-group tags: - enterprise-admin @@ -89513,9 +89503,6 @@ paths: put: summary: Set SCIM information for a provisioned enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. @@ -89577,9 +89564,6 @@ paths: patch: summary: Update an attribute for a SCIM enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Update a provisioned group’s individual attributes. To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. @@ -89679,11 +89663,7 @@ paths: subcategory: scim delete: summary: Delete a SCIM group from an enterprise - description: |- - > [!NOTE] - > SCIM provisioning using the REST API is in public preview and subject to change. - - Deletes a SCIM group from an enterprise. + description: Deletes a SCIM group from an enterprise. operationId: enterprise-admin/delete-scim-group-from-enterprise tags: - enterprise-admin @@ -89711,9 +89691,6 @@ paths: get: summary: List SCIM provisioned identities for an enterprise description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Lists provisioned SCIM enterprise members. When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. @@ -89957,9 +89934,6 @@ paths: post: summary: Provision a SCIM enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Creates an external identity for a new SCIM enterprise user. SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. @@ -90149,11 +90123,7 @@ paths: "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": get: summary: Get SCIM provisioning information for an enterprise user - description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - - Gets information about a SCIM user. + description: Gets information about a SCIM user. operationId: enterprise-admin/get-provisioning-information-for-enterprise-user tags: - enterprise-admin @@ -90191,9 +90161,6 @@ paths: put: summary: Set SCIM information for a provisioned enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Replaces an existing provisioned user's information. You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. @@ -90239,9 +90206,6 @@ paths: patch: summary: Update an attribute for a SCIM enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Update a provisioned user's individual attributes. To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). @@ -90333,11 +90297,11 @@ paths: subcategory: scim delete: summary: Delete a SCIM user from an enterprise - description: |- - > [!NOTE] - > SCIM provisioning using the REST API is in public preview and subject to change. - - Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. + description: 'Suspends a SCIM user permanently from an enterprise. This action + will: remove all the user''s data, anonymize their login, email, and display + name, erase all external identity SCIM attributes, delete the user''s emails, + avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. + This action is irreversible.' operationId: enterprise-admin/delete-user-from-enterprise tags: - enterprise-admin diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 02cb38d7c..39d3202d4 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -434431,7 +434431,7 @@ "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", + "description": "Lists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "operationId": "enterprise-admin/list-provisioned-groups-enterprise", "tags": [ "enterprise-admin", @@ -434966,7 +434966,7 @@ }, "post": { "summary": "Provision a SCIM enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nCreates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", + "description": "Creates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", "operationId": "enterprise-admin/provision-enterprise-group", "tags": [ "enterprise-admin" @@ -435475,7 +435475,7 @@ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nGets information about a SCIM group.", + "description": "Gets information about a SCIM group.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", "tags": [ "enterprise-admin" @@ -435950,7 +435950,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "Replaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", "tags": [ "enterprise-admin" @@ -436542,7 +436542,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n> [!NOTE]\n> Memberships are referenced via a local user id. Ensure users are created before referencing them here.", + "description": "Update a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n> [!NOTE]\n> Memberships are referenced via a local user id. Ensure users are created before referencing them here.", "operationId": "enterprise-admin/update-attribute-for-enterprise-group", "tags": [ "enterprise-admin" @@ -437132,7 +437132,7 @@ }, "delete": { "summary": "Delete a SCIM group from an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning using the REST API is in public preview and subject to change.\n\nDeletes a SCIM group from an enterprise.", + "description": "Deletes a SCIM group from an enterprise.", "operationId": "enterprise-admin/delete-scim-group-from-enterprise", "tags": [ "enterprise-admin" @@ -437429,7 +437429,7 @@ "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", + "description": "Lists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", "operationId": "enterprise-admin/list-provisioned-identities-enterprise", "tags": [ "enterprise-admin" @@ -438025,7 +438025,7 @@ }, "post": { "summary": "Provision a SCIM enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", + "description": "Creates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", "operationId": "enterprise-admin/provision-enterprise-user", "tags": [ "enterprise-admin" @@ -438789,7 +438789,7 @@ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nGets information about a SCIM user.", + "description": "Gets information about a SCIM user.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", "tags": [ "enterprise-admin" @@ -439331,7 +439331,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", + "description": "Replaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", "tags": [ "enterprise-admin" @@ -440060,7 +440060,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", + "description": "Update a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "operationId": "enterprise-admin/update-attribute-for-enterprise-user", "tags": [ "enterprise-admin" @@ -440788,7 +440788,7 @@ }, "delete": { "summary": "Delete a SCIM user from an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning using the REST API is in public preview and subject to change.\n\nSuspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", + "description": "Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", "operationId": "enterprise-admin/delete-user-from-enterprise", "tags": [ "enterprise-admin" diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 96f908a4c..f86cc4603 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -89102,9 +89102,6 @@ paths: get: summary: List provisioned SCIM groups for an enterprise description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Lists provisioned SCIM groups in an enterprise. You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. @@ -89359,9 +89356,6 @@ paths: post: summary: Provision a SCIM enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Creates a SCIM group for an enterprise. When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. @@ -89469,11 +89463,7 @@ paths: "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": get: summary: Get SCIM provisioning information for an enterprise group - description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - - Gets information about a SCIM group. + description: Gets information about a SCIM group. operationId: enterprise-admin/get-provisioning-information-for-enterprise-group tags: - enterprise-admin @@ -89513,9 +89503,6 @@ paths: put: summary: Set SCIM information for a provisioned enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. @@ -89577,9 +89564,6 @@ paths: patch: summary: Update an attribute for a SCIM enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Update a provisioned group’s individual attributes. To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. @@ -89679,11 +89663,7 @@ paths: subcategory: scim delete: summary: Delete a SCIM group from an enterprise - description: |- - > [!NOTE] - > SCIM provisioning using the REST API is in public preview and subject to change. - - Deletes a SCIM group from an enterprise. + description: Deletes a SCIM group from an enterprise. operationId: enterprise-admin/delete-scim-group-from-enterprise tags: - enterprise-admin @@ -89711,9 +89691,6 @@ paths: get: summary: List SCIM provisioned identities for an enterprise description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Lists provisioned SCIM enterprise members. When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. @@ -89957,9 +89934,6 @@ paths: post: summary: Provision a SCIM enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Creates an external identity for a new SCIM enterprise user. SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. @@ -90149,11 +90123,7 @@ paths: "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": get: summary: Get SCIM provisioning information for an enterprise user - description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - - Gets information about a SCIM user. + description: Gets information about a SCIM user. operationId: enterprise-admin/get-provisioning-information-for-enterprise-user tags: - enterprise-admin @@ -90191,9 +90161,6 @@ paths: put: summary: Set SCIM information for a provisioned enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Replaces an existing provisioned user's information. You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. @@ -90239,9 +90206,6 @@ paths: patch: summary: Update an attribute for a SCIM enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Update a provisioned user's individual attributes. To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). @@ -90333,11 +90297,11 @@ paths: subcategory: scim delete: summary: Delete a SCIM user from an enterprise - description: |- - > [!NOTE] - > SCIM provisioning using the REST API is in public preview and subject to change. - - Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. + description: 'Suspends a SCIM user permanently from an enterprise. This action + will: remove all the user''s data, anonymize their login, email, and display + name, erase all external identity SCIM attributes, delete the user''s emails, + avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. + This action is irreversible.' operationId: enterprise-admin/delete-user-from-enterprise tags: - enterprise-admin diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index f4363a3cb..de278ac1f 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -61416,7 +61416,7 @@ "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", + "description": "Lists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "operationId": "enterprise-admin/list-provisioned-groups-enterprise", "tags": [ "enterprise-admin", @@ -61498,7 +61498,7 @@ }, "post": { "summary": "Provision a SCIM enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nCreates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", + "description": "Creates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", "operationId": "enterprise-admin/provision-enterprise-group", "tags": [ "enterprise-admin" @@ -61579,7 +61579,7 @@ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nGets information about a SCIM group.", + "description": "Gets information about a SCIM group.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", "tags": [ "enterprise-admin" @@ -61643,7 +61643,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "Replaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", "tags": [ "enterprise-admin" @@ -61752,7 +61752,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n> [!NOTE]\n> Memberships are referenced via a local user id. Ensure users are created before referencing them here.", + "description": "Update a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n> [!NOTE]\n> Memberships are referenced via a local user id. Ensure users are created before referencing them here.", "operationId": "enterprise-admin/update-attribute-for-enterprise-group", "tags": [ "enterprise-admin" @@ -61871,7 +61871,7 @@ }, "delete": { "summary": "Delete a SCIM group from an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning using the REST API is in public preview and subject to change.\n\nDeletes a SCIM group from an enterprise.", + "description": "Deletes a SCIM group from an enterprise.", "operationId": "enterprise-admin/delete-scim-group-from-enterprise", "tags": [ "enterprise-admin" @@ -61922,7 +61922,7 @@ "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", + "description": "Lists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", "operationId": "enterprise-admin/list-provisioned-identities-enterprise", "tags": [ "enterprise-admin" @@ -62000,7 +62000,7 @@ }, "post": { "summary": "Provision a SCIM enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", + "description": "Creates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", "operationId": "enterprise-admin/provision-enterprise-user", "tags": [ "enterprise-admin" @@ -62081,7 +62081,7 @@ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nGets information about a SCIM user.", + "description": "Gets information about a SCIM user.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", "tags": [ "enterprise-admin" @@ -62142,7 +62142,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", + "description": "Replaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", "tags": [ "enterprise-admin" @@ -62221,7 +62221,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", + "description": "Update a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "operationId": "enterprise-admin/update-attribute-for-enterprise-user", "tags": [ "enterprise-admin" @@ -62358,7 +62358,7 @@ }, "delete": { "summary": "Delete a SCIM user from an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning using the REST API is in public preview and subject to change.\n\nSuspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", + "description": "Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", "operationId": "enterprise-admin/delete-user-from-enterprise", "tags": [ "enterprise-admin" diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 0309442a2..22176f450 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -44529,9 +44529,6 @@ paths: get: summary: List provisioned SCIM groups for an enterprise description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Lists provisioned SCIM groups in an enterprise. You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. @@ -44588,9 +44585,6 @@ paths: post: summary: Provision a SCIM enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Creates a SCIM group for an enterprise. When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. @@ -44645,11 +44639,7 @@ paths: "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": get: summary: Get SCIM provisioning information for an enterprise group - description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - - Gets information about a SCIM group. + description: Gets information about a SCIM group. operationId: enterprise-admin/get-provisioning-information-for-enterprise-group tags: - enterprise-admin @@ -44690,9 +44680,6 @@ paths: put: summary: Set SCIM information for a provisioned enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. @@ -44765,9 +44752,6 @@ paths: patch: summary: Update an attribute for a SCIM enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Update a provisioned group’s individual attributes. To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. @@ -44847,11 +44831,7 @@ paths: subcategory: scim delete: summary: Delete a SCIM group from an enterprise - description: |- - > [!NOTE] - > SCIM provisioning using the REST API is in public preview and subject to change. - - Deletes a SCIM group from an enterprise. + description: Deletes a SCIM group from an enterprise. operationId: enterprise-admin/delete-scim-group-from-enterprise tags: - enterprise-admin @@ -44885,9 +44865,6 @@ paths: get: summary: List SCIM provisioned identities for an enterprise description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Lists provisioned SCIM enterprise members. When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. @@ -44943,9 +44920,6 @@ paths: post: summary: Provision a SCIM enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Creates an external identity for a new SCIM enterprise user. SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. @@ -45000,11 +44974,7 @@ paths: "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": get: summary: Get SCIM provisioning information for an enterprise user - description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - - Gets information about a SCIM user. + description: Gets information about a SCIM user. operationId: enterprise-admin/get-provisioning-information-for-enterprise-user tags: - enterprise-admin @@ -45044,9 +45014,6 @@ paths: put: summary: Set SCIM information for a provisioned enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Replaces an existing provisioned user's information. You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. @@ -45103,9 +45070,6 @@ paths: patch: summary: Update an attribute for a SCIM enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Update a provisioned user's individual attributes. To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). @@ -45209,11 +45173,11 @@ paths: subcategory: scim delete: summary: Delete a SCIM user from an enterprise - description: |- - > [!NOTE] - > SCIM provisioning using the REST API is in public preview and subject to change. - - Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. + description: 'Suspends a SCIM user permanently from an enterprise. This action + will: remove all the user''s data, anonymize their login, email, and display + name, erase all external identity SCIM attributes, delete the user''s emails, + avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. + This action is irreversible.' operationId: enterprise-admin/delete-user-from-enterprise tags: - enterprise-admin diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index f4363a3cb..de278ac1f 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -61416,7 +61416,7 @@ "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", + "description": "Lists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "operationId": "enterprise-admin/list-provisioned-groups-enterprise", "tags": [ "enterprise-admin", @@ -61498,7 +61498,7 @@ }, "post": { "summary": "Provision a SCIM enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nCreates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", + "description": "Creates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", "operationId": "enterprise-admin/provision-enterprise-group", "tags": [ "enterprise-admin" @@ -61579,7 +61579,7 @@ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nGets information about a SCIM group.", + "description": "Gets information about a SCIM group.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", "tags": [ "enterprise-admin" @@ -61643,7 +61643,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "Replaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", "tags": [ "enterprise-admin" @@ -61752,7 +61752,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise group", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n> [!NOTE]\n> Memberships are referenced via a local user id. Ensure users are created before referencing them here.", + "description": "Update a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n> [!NOTE]\n> Memberships are referenced via a local user id. Ensure users are created before referencing them here.", "operationId": "enterprise-admin/update-attribute-for-enterprise-group", "tags": [ "enterprise-admin" @@ -61871,7 +61871,7 @@ }, "delete": { "summary": "Delete a SCIM group from an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning using the REST API is in public preview and subject to change.\n\nDeletes a SCIM group from an enterprise.", + "description": "Deletes a SCIM group from an enterprise.", "operationId": "enterprise-admin/delete-scim-group-from-enterprise", "tags": [ "enterprise-admin" @@ -61922,7 +61922,7 @@ "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", + "description": "Lists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", "operationId": "enterprise-admin/list-provisioned-identities-enterprise", "tags": [ "enterprise-admin" @@ -62000,7 +62000,7 @@ }, "post": { "summary": "Provision a SCIM enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", + "description": "Creates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", "operationId": "enterprise-admin/provision-enterprise-user", "tags": [ "enterprise-admin" @@ -62081,7 +62081,7 @@ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nGets information about a SCIM user.", + "description": "Gets information about a SCIM user.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", "tags": [ "enterprise-admin" @@ -62142,7 +62142,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", + "description": "Replaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", "tags": [ "enterprise-admin" @@ -62221,7 +62221,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise user", - "description": "> [!NOTE]\n> SCIM provisioning for users and groups using the REST API is in public preview and subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", + "description": "Update a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "operationId": "enterprise-admin/update-attribute-for-enterprise-user", "tags": [ "enterprise-admin" @@ -62358,7 +62358,7 @@ }, "delete": { "summary": "Delete a SCIM user from an enterprise", - "description": "> [!NOTE]\n> SCIM provisioning using the REST API is in public preview and subject to change.\n\nSuspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", + "description": "Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", "operationId": "enterprise-admin/delete-user-from-enterprise", "tags": [ "enterprise-admin" diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 0309442a2..22176f450 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -44529,9 +44529,6 @@ paths: get: summary: List provisioned SCIM groups for an enterprise description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Lists provisioned SCIM groups in an enterprise. You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. @@ -44588,9 +44585,6 @@ paths: post: summary: Provision a SCIM enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Creates a SCIM group for an enterprise. When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. @@ -44645,11 +44639,7 @@ paths: "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": get: summary: Get SCIM provisioning information for an enterprise group - description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - - Gets information about a SCIM group. + description: Gets information about a SCIM group. operationId: enterprise-admin/get-provisioning-information-for-enterprise-group tags: - enterprise-admin @@ -44690,9 +44680,6 @@ paths: put: summary: Set SCIM information for a provisioned enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. @@ -44765,9 +44752,6 @@ paths: patch: summary: Update an attribute for a SCIM enterprise group description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Update a provisioned group’s individual attributes. To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. @@ -44847,11 +44831,7 @@ paths: subcategory: scim delete: summary: Delete a SCIM group from an enterprise - description: |- - > [!NOTE] - > SCIM provisioning using the REST API is in public preview and subject to change. - - Deletes a SCIM group from an enterprise. + description: Deletes a SCIM group from an enterprise. operationId: enterprise-admin/delete-scim-group-from-enterprise tags: - enterprise-admin @@ -44885,9 +44865,6 @@ paths: get: summary: List SCIM provisioned identities for an enterprise description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Lists provisioned SCIM enterprise members. When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. @@ -44943,9 +44920,6 @@ paths: post: summary: Provision a SCIM enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Creates an external identity for a new SCIM enterprise user. SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. @@ -45000,11 +44974,7 @@ paths: "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": get: summary: Get SCIM provisioning information for an enterprise user - description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - - Gets information about a SCIM user. + description: Gets information about a SCIM user. operationId: enterprise-admin/get-provisioning-information-for-enterprise-user tags: - enterprise-admin @@ -45044,9 +45014,6 @@ paths: put: summary: Set SCIM information for a provisioned enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Replaces an existing provisioned user's information. You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. @@ -45103,9 +45070,6 @@ paths: patch: summary: Update an attribute for a SCIM enterprise user description: |- - > [!NOTE] - > SCIM provisioning for users and groups using the REST API is in public preview and subject to change. - Update a provisioned user's individual attributes. To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). @@ -45209,11 +45173,11 @@ paths: subcategory: scim delete: summary: Delete a SCIM user from an enterprise - description: |- - > [!NOTE] - > SCIM provisioning using the REST API is in public preview and subject to change. - - Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. + description: 'Suspends a SCIM user permanently from an enterprise. This action + will: remove all the user''s data, anonymize their login, email, and display + name, erase all external identity SCIM attributes, delete the user''s emails, + avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. + This action is irreversible.' operationId: enterprise-admin/delete-user-from-enterprise tags: - enterprise-admin diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json index fdc0fdc25..9a6f10887 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json @@ -60172,15 +60172,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -60223,7 +60223,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -60412,7 +60412,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml index 784345e98..19a3460b0 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml @@ -18518,13 +18518,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -18533,7 +18534,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -18564,7 +18565,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -18706,7 +18707,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json index fdc0fdc25..9a6f10887 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json @@ -60172,15 +60172,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -60223,7 +60223,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -60412,7 +60412,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml index 784345e98..19a3460b0 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml @@ -18518,13 +18518,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -18533,7 +18534,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -18564,7 +18565,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -18706,7 +18707,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). diff --git a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json index 63f996f80..66b06b5e8 100644 --- a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json +++ b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json @@ -10369,15 +10369,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -10405,7 +10405,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -10493,7 +10493,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" diff --git a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml index da956c48e..445b0917f 100644 --- a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml +++ b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml @@ -7273,13 +7273,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -7288,7 +7289,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -7308,7 +7309,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -7365,7 +7366,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). diff --git a/descriptions/ghes-3.12/ghes-3.12.json b/descriptions/ghes-3.12/ghes-3.12.json index 63f996f80..66b06b5e8 100644 --- a/descriptions/ghes-3.12/ghes-3.12.json +++ b/descriptions/ghes-3.12/ghes-3.12.json @@ -10369,15 +10369,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -10405,7 +10405,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -10493,7 +10493,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" diff --git a/descriptions/ghes-3.12/ghes-3.12.yaml b/descriptions/ghes-3.12/ghes-3.12.yaml index da956c48e..445b0917f 100644 --- a/descriptions/ghes-3.12/ghes-3.12.yaml +++ b/descriptions/ghes-3.12/ghes-3.12.yaml @@ -7273,13 +7273,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -7288,7 +7289,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -7308,7 +7309,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -7365,7 +7366,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). diff --git a/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json b/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json index 8dea288f9..8cd90a69b 100644 --- a/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json +++ b/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json @@ -60309,15 +60309,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -60360,7 +60360,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -60549,7 +60549,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -60576,7 +60576,7 @@ "parameters": [ { "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml b/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml index c11b451b9..c596e8038 100644 --- a/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml @@ -18531,13 +18531,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -18546,7 +18547,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -18577,7 +18578,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -18719,7 +18720,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -18740,9 +18741,9 @@ paths: description: Self-hosted Enterprise Server protocol parameters: - name: apply - description: Whether to apply changes from the license. Uploading a license - does not automatically apply changes. To make the changes effective, you - can specify to apply the license too. + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. in: query required: false schema: diff --git a/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.json b/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.json index 8dea288f9..8cd90a69b 100644 --- a/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.json +++ b/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.json @@ -60309,15 +60309,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -60360,7 +60360,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -60549,7 +60549,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -60576,7 +60576,7 @@ "parameters": [ { "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.yaml b/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.yaml index c11b451b9..c596e8038 100644 --- a/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.yaml +++ b/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.yaml @@ -18531,13 +18531,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -18546,7 +18547,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -18577,7 +18578,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -18719,7 +18720,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -18740,9 +18741,9 @@ paths: description: Self-hosted Enterprise Server protocol parameters: - name: apply - description: Whether to apply changes from the license. Uploading a license - does not automatically apply changes. To make the changes effective, you - can specify to apply the license too. + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. in: query required: false schema: diff --git a/descriptions/ghes-3.13/ghes-3.13.2022-11-28.json b/descriptions/ghes-3.13/ghes-3.13.2022-11-28.json index abe5a2d69..c724f6d65 100644 --- a/descriptions/ghes-3.13/ghes-3.13.2022-11-28.json +++ b/descriptions/ghes-3.13/ghes-3.13.2022-11-28.json @@ -10371,15 +10371,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -10407,7 +10407,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -10495,7 +10495,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -280257,7 +280257,7 @@ }, "license-apply": { "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghes-3.13/ghes-3.13.2022-11-28.yaml b/descriptions/ghes-3.13/ghes-3.13.2022-11-28.yaml index dbe8fbb3e..2659164f0 100644 --- a/descriptions/ghes-3.13/ghes-3.13.2022-11-28.yaml +++ b/descriptions/ghes-3.13/ghes-3.13.2022-11-28.yaml @@ -7277,13 +7277,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -7292,7 +7293,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -7312,7 +7313,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -7369,7 +7370,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -211547,9 +211548,9 @@ components: type: string license-apply: name: apply - description: Whether to apply changes from the license. Uploading a license - does not automatically apply changes. To make the changes effective, you can - specify to apply the license too. + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. in: query required: false schema: diff --git a/descriptions/ghes-3.13/ghes-3.13.json b/descriptions/ghes-3.13/ghes-3.13.json index abe5a2d69..c724f6d65 100644 --- a/descriptions/ghes-3.13/ghes-3.13.json +++ b/descriptions/ghes-3.13/ghes-3.13.json @@ -10371,15 +10371,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -10407,7 +10407,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -10495,7 +10495,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -280257,7 +280257,7 @@ }, "license-apply": { "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", "in": "query", "required": false, "schema": { diff --git a/descriptions/ghes-3.13/ghes-3.13.yaml b/descriptions/ghes-3.13/ghes-3.13.yaml index dbe8fbb3e..2659164f0 100644 --- a/descriptions/ghes-3.13/ghes-3.13.yaml +++ b/descriptions/ghes-3.13/ghes-3.13.yaml @@ -7277,13 +7277,14 @@ paths: subcategory: manage-ghes "/manage/v1/config/init": post: - summary: Initialize instance configuration with license upload + summary: Initialize instance configuration with license and password description: |- - When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. - Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) - This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -7292,7 +7293,7 @@ paths: - enterprise-admin externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password servers: - url: "{protocol}://{hostname}" variables: @@ -7312,7 +7313,7 @@ paths: default: value: license: "@enterprise.ghl" - password: secret-password! + password: provide-password-here! responses: '202': description: Response @@ -7369,7 +7370,7 @@ paths: put: summary: Upload an enterprise license description: |- - Uploads an enterprise license. This operation does not automatically activate the license. + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. > [!NOTE] > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). @@ -211547,9 +211548,9 @@ components: type: string license-apply: name: apply - description: Whether to apply changes from the license. Uploading a license - does not automatically apply changes. To make the changes effective, you can - specify to apply the license too. + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. in: query required: false schema: diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index 99b75b6b2..45d95bfed 100644 --- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -60309,15 +60309,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -60360,7 +60360,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -60549,7 +60549,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The requ{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}