The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "year", + "description": "If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2024. Default value is the current year.
If specified, only return results for a single month. The value of month is an integer between 1 and 12.
If specified, only return results for a single day. The value of day is an integer between 1 and 31.
If specified, only return results for a single hour. The value of hour is an integer between 0 and 23.
Billing usage report response for an organization
", + "example": { + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] + }, + "schema": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.
\nNote: This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"About the enhanced billing platform.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Billing usage report response for an organization
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ] + } ] }, "branches": { diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 260186126823..96f8e14d393b 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -111024,6 +111024,201 @@ } ] } + ], + "enhanced-billing": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/settings/billing/usage", + "title": "Get billing usage report for an organization", + "category": "billing", + "subcategory": "enhanced-billing", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "year", + "description": "If specified, only return results for a single year. The value of year is an integer with four digits representing a year. For example, 2024. Default value is the current year.
If specified, only return results for a single month. The value of month is an integer between 1 and 12.
If specified, only return results for a single day. The value of day is an integer between 1 and 31.
If specified, only return results for a single hour. The value of hour is an integer between 0 and 23.
Billing usage report response for an organization
", + "example": { + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] + }, + "schema": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.
\nNote: This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"About the enhanced billing platform.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Billing usage report response for an organization
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ] + } ] }, "branches": { @@ -263903,7 +264098,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nLists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Lists provisioned SCIM groups in an enterprise.
\nYou can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.
Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nCreates a SCIM group for an enterprise.
\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.
Creates a SCIM group for an enterprise.
\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.
Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nGets information about a SCIM group.
", + "descriptionHTML": "Gets information about a SCIM group.
", "statusCodes": [ { "httpStatusCode": "200", @@ -265038,7 +265233,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nReplaces an existing provisioned group’s information.
\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 endpoint instead.
", + "descriptionHTML": "Replaces an existing provisioned group’s information.
\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 endpoint instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -265585,7 +265780,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nUpdate a provisioned group’s individual attributes.
\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. The update function can also be used to add group memberships.
\nYou can submit group memberships individually or in batches for improved efficiency.
\nNote
\n\nMemberships are referenced via a local user id. Ensure users are created before referencing them here.
\nUpdate a provisioned group’s individual attributes.
\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. The update function can also be used to add group memberships.
\nYou can submit group memberships individually or in batches for improved efficiency.
\nNote
\n\nMemberships are referenced via a local user id. Ensure users are created before referencing them here.
\nNote
\n\nSCIM provisioning using the REST API is in public preview and subject to change.
\nDeletes a SCIM group from an enterprise.
", + "descriptionHTML": "Deletes a SCIM group from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", @@ -266140,7 +266335,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nLists provisioned SCIM enterprise members.
\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.
Lists provisioned SCIM enterprise members.
\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.
Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nCreates an external identity for a new SCIM enterprise user.
\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.
", + "descriptionHTML": "Creates an external identity for a new SCIM enterprise user.
\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.
", "statusCodes": [ { "httpStatusCode": "201", @@ -267345,7 +267540,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nGets information about a SCIM user.
", + "descriptionHTML": "Gets information about a SCIM user.
", "statusCodes": [ { "httpStatusCode": "200", @@ -267875,7 +268070,7 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nReplaces an existing provisioned user's information.
\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 endpoint.
\nWarning
\n\nSetting active: false will suspend a user, and their handle and email will be obfuscated.
Replaces an existing provisioned user's information.
\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 endpoint.
\nWarning
\n\nSetting active: false will suspend a user, and their handle and email will be obfuscated.
Note
\n\nSCIM provisioning for users and groups using the REST API is in public preview and subject to change.
\nUpdate a provisioned user's individual attributes.
\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.
Note
\n\nComplex SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will be ineffective.
Warning
\n\nSetting active: false will suspend a user, and their handle and email will be obfuscated.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nUpdate a provisioned user's individual attributes.
\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.
Note
\n\nComplex SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will be ineffective.
Warning
\n\nSetting active: false will suspend a user, and their handle and email will be obfuscated.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nNote
\n\nSCIM provisioning using the REST API is in public preview and subject to change.
\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.
", + "descriptionHTML": "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.
", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 600a63716529..486f3a556f40 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -198646,7 +198646,7 @@ "serverUrl": "http(s)://HOSTNAME", "verb": "post", "requestPath": "/manage/v1/config/init", - "title": "Initialize instance configuration with license upload", + "title": "Initialize instance configuration with license and password", "category": "enterprise-admin", "subcategory": "manage-ghes", "parameters": [], @@ -198675,7 +198675,7 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } }, "response": { @@ -198685,7 +198685,7 @@ } ], "previews": [], - "descriptionHTML": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.
\nNote that you afterwards need to POST to /manage/v1/config/apply to start the actual configuration process.
This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.
\nNote
\n\nThe 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.
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.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
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.
\nNote
\n\nThe 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.
Uploads an enterprise license. This operation does not automatically activate the license.
\nNote
\n\nThe 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.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe 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.
When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.
\nNote that you afterwards need to POST to /manage/v1/config/apply to start the actual configuration process.
This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.
\nNote
\n\nThe 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.
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.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
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.
\nNote
\n\nThe 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.
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 endpoint.
Uploads an enterprise license. This operation does not automatically activate the license.
\nNote
\n\nThe 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.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe 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.
When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.
\nNote that you afterwards need to POST to /manage/v1/config/apply to start the actual configuration process.
This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.
\nNote
\n\nThe 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.
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.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
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.
\nNote
\n\nThe 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.
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 endpoint.
Uploads an enterprise license. This operation does not automatically activate the license.
\nNote
\n\nThe 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.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe 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.
When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.
\nNote that you afterwards need to POST to /manage/v1/config/apply to start the actual configuration process.
This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.
\nNote
\n\nThe 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.
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.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
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.
\nNote
\n\nThe 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.
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 endpoint.
Uploads an enterprise license. This operation does not automatically activate the license.
\nNote
\n\nThe 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.
Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.
Note
\n\nThe 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.