The enablement status of secret scanning extended metadata
", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -265533,6 +265554,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -265984,6 +266014,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -266369,6 +266408,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -266693,6 +266741,18 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "secret_scanning_extended_metadata", + "in": "body", + "description": "The enablement status of secret scanning extended metadata
", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -267021,6 +267081,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -267630,6 +267699,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -268851,6 +268929,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -269234,6 +269321,17 @@ "not_set" ] }, + { + "type": "string", + "name": "secret_scanning_extended_metadata", + "in": "body", + "description": "The enablement status of secret scanning extended metadata
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -269573,6 +269671,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -270016,6 +270123,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -270508,6 +270624,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -270887,6 +271012,17 @@ "not_set" ] }, + { + "type": "string", + "name": "secret_scanning_extended_metadata", + "in": "body", + "description": "The enablement status of secret scanning extended metadata
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -271222,6 +271358,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -271832,6 +271977,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -273010,6 +273164,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -335628,6 +335791,192 @@ ] }, "copilot": { + "copilot-content-exclusion-management": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot/content_exclusion", + "title": "Get Copilot content exclusion rules for an organization", + "category": "copilot", + "subcategory": "copilot-content-exclusion-management", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"
\nOrganization owners can view details about Copilot content exclusion rules for the organization.
\nOAuth app tokens and personal access tokens (classic) need either the copilot or read:org scopes to use this endpoint.
Caution
\n\nOK
", + "example": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + }, + "schema": { + "title": "Copilot Organization Content Exclusion Details", + "description": "List all Copilot Content Exclusion rules for an organization.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The path to the file that will be excluded." + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot content exclusion\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot/content_exclusion", + "title": "Set Copilot content exclusion rules for an organization", + "category": "copilot", + "subcategory": "copilot-content-exclusion-management", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"
\nOrganization owners can set Copilot content exclusion rules for the organization.
\nOAuth app tokens and personal access tokens (classic) need the copilot scope to use this endpoint.
Caution
\n\nSuccess
", + "example": { + "message": "Content exclusion rules updated successfully." + }, + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Success
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "413", + "description": "Payload Too Large
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot content exclusion\" organization permissions": "write" + } + ] + } + } + ], "copilot-metrics": [ { "serverUrl": "https://api.github.com", @@ -339284,6 +339633,14 @@ ] } }, + { + "name": "assignee", + "in": "query", + "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., octocat or octocat,hubot) to return alerts assigned to any of the specified users.\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., octocat or octocat,hubot) to return alerts assigned to any of the specified users.\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., octocat or octocat,hubot) to return alerts assigned to any of the specified users.\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Resource not found
" }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, { "httpStatusCode": "500", "description": "Internal Error
" @@ -566614,6 +567083,10 @@ "httpStatusCode": "404", "description": "Resource not found
" }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, { "httpStatusCode": "500", "description": "Internal Error
" @@ -788176,6 +788649,10 @@ "httpStatusCode": "404", "description": "Resource not found
" }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, { "httpStatusCode": "500", "description": "Internal Error
" @@ -792111,6 +792588,10 @@ "httpStatusCode": "404", "description": "Resource not found
" }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, { "httpStatusCode": "500", "description": "Internal Error
" @@ -838932,6 +839413,10 @@ { "httpStatusCode": "204", "description": "No Content
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level.
" } ], "previews": [], @@ -848185,6 +848670,10 @@ { "httpStatusCode": "200", "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level.
" } ], "previews": [], diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index e6019d9cffc3..7573af1b959e 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -281561,6 +281561,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -281886,6 +281895,18 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "secret_scanning_extended_metadata", + "in": "body", + "description": "The enablement status of secret scanning extended metadata
", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -282218,6 +282239,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -282669,6 +282699,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -283054,6 +283093,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -283378,6 +283426,18 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "secret_scanning_extended_metadata", + "in": "body", + "description": "The enablement status of secret scanning extended metadata
", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -283706,6 +283766,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -284315,6 +284384,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -285536,6 +285614,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -285919,6 +286006,17 @@ "not_set" ] }, + { + "type": "string", + "name": "secret_scanning_extended_metadata", + "in": "body", + "description": "The enablement status of secret scanning extended metadata
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -286258,6 +286356,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -286701,6 +286808,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -287193,6 +287309,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -287572,6 +287697,17 @@ "not_set" ] }, + { + "type": "string", + "name": "secret_scanning_extended_metadata", + "in": "body", + "description": "The enablement status of secret scanning extended metadata
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -287907,6 +288043,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -288517,6 +288662,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -289695,6 +289849,15 @@ "not_set" ] }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -352589,6 +352752,923 @@ ] }, "copilot": { + "copilot-content-exclusion-management": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/content_exclusion", + "title": "Get Copilot content exclusion rules for an enterprise", + "category": "copilot", + "subcategory": "copilot-content-exclusion-management", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets information about an enterprise's Copilot content exclusion path rules.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"
\nEnterprise owners can view details about Copilot content exclusion rules for the enterprise.
\nOAuth app tokens and personal access tokens (classic) need either the read:enterprise or copilot scopes to use this endpoint.
Caution
\n\nOK
", + "example": { + "git@github.com:*/copilot": [ + "/__tests__/**" + ], + "octo-org/octo-repo": [ + "/src/some-dir/kernel.rs" + ] + }, + "schema": { + "title": "Copilot Enterprise Content Exclusion Details", + "description": "List all Copilot Content Exclusion rules for an enterprise.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The path to the file that will be excluded." + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "read" + } + ], + "disabledForPatV2": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/copilot/content_exclusion", + "title": "Set Copilot content exclusion rules for an enterprise", + "category": "copilot", + "subcategory": "copilot-content-exclusion-management", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets Copilot content exclusion path rules for an enterprise.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"
\nEnterprise owners can set Copilot content exclusion rules for the enterprise.
\nOAuth app tokens and personal access tokens (classic) need either the admin:enterprise or copilot scopes to use this endpoint.
Caution
\n\nSuccess
", + "example": { + "message": "Content exclusion rules updated successfully." + }, + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Success
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "413", + "description": "Payload Too Large
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ], + "disabledForPatV2": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot/content_exclusion", + "title": "Get Copilot content exclusion rules for an organization", + "category": "copilot", + "subcategory": "copilot-content-exclusion-management", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"
\nOrganization owners can view details about Copilot content exclusion rules for the organization.
\nOAuth app tokens and personal access tokens (classic) need either the copilot or read:org scopes to use this endpoint.
Caution
\n\nOK
", + "example": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + }, + "schema": { + "title": "Copilot Organization Content Exclusion Details", + "description": "List all Copilot Content Exclusion rules for an organization.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The path to the file that will be excluded." + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot content exclusion\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/copilot/content_exclusion", + "title": "Set Copilot content exclusion rules for an organization", + "category": "copilot", + "subcategory": "copilot-content-exclusion-management", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"
\nOrganization owners can set Copilot content exclusion rules for the organization.
\nOAuth app tokens and personal access tokens (classic) need the copilot scope to use this endpoint.
Caution
\n\nSuccess
", + "example": { + "message": "Content exclusion rules updated successfully." + }, + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Success
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "413", + "description": "Payload Too Large
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Copilot content exclusion\" organization permissions": "write" + } + ] + } + } + ], + "copilot-custom-agents": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/custom-agents", + "title": "Get custom agents for an enterprise", + "category": "copilot", + "subcategory": "copilot-custom-agents", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets the list of all custom agents defined in the /agents/*.md files in the .github-private repository for the enterprise.
\nIf no source repository has been configured, returns null for custom_agents.
Enterprise owners with read access to AI Controls can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response with custom agents
", + "example": { + "custom_agents": [ + { + "name": "Security Reviewer", + "file_path": "agents/security_reviewer.md", + "url": "https://github.com/my-org/.github-private/blob/main/agents/security_reviewer.md" + }, + { + "name": "Code Documenter", + "file_path": "agents/code_documenter.md", + "url": "https://github.com/my-org/.github-private/blob/main/agents/code_documenter.md" + } + ] + }, + "schema": { + "type": "object", + "properties": { + "custom_agents": { + "type": [ + "array", + "null" + ], + "description": "List of custom agents defined in the repository. Returns `null` if no source repository is configured.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the custom agent (derived from filename)." + }, + "file_path": { + "type": "string", + "description": "The path to the agent definition file." + }, + "url": { + "type": "string", + "description": "The URL to view the agent definition file." + } + } + } + } + } + } + } + }, + { + "key": "no_source", + "request": { + "description": "Example 2: Status Code 200", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response when no source repository configured
", + "example": { + "custom_agents": null + }, + "schema": { + "type": "object", + "properties": { + "custom_agents": { + "type": [ + "array", + "null" + ], + "description": "List of custom agents defined in the repository. Returns `null` if no source repository is configured.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the custom agent (derived from filename)." + }, + "file_path": { + "type": "string", + "description": "The path to the agent definition file." + }, + "url": { + "type": "string", + "description": "The URL to view the agent definition file." + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Success
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Not found or source repository not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "read" + } + ], + "disabledForPatV2": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/custom-agents/source", + "title": "Get the source organization for custom agents in an enterprise", + "category": "copilot", + "subcategory": "copilot-custom-agents", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets the organization and repository configured as the source for custom agent definitions in an enterprise.
\nCustom agents are enterprise-defined AI agents stored as markdown files in a special repository.\nAn enterprise admin configures one organization as the \"source\" and that org must have a repo named\n.github-private containing agent definitions in /agents/*.md.
Enterprise owners with read access to AI Controls can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response
", + "example": { + "organization": { + "id": 1, + "login": "octocat-org" + }, + "repository": { + "id": 123, + "name": ".github-private", + "full_name": "octocat-org/.github-private" + } + }, + "schema": { + "type": "object", + "required": [ + "organization", + "repository" + ], + "properties": { + "organization": { + "type": [ + "object", + "null" + ], + "required": [ + "id", + "login" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the organization" + }, + "login": { + "type": "string", + "description": "Login of the organization" + } + } + }, + "repository": { + "type": [ + "object", + "null" + ], + "required": [ + "id", + "name", + "full_name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the repository" + }, + "name": { + "type": "string", + "description": "Name of the repository" + }, + "full_name": { + "type": "string", + "description": "Full name of the repository including owner" + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "read" + } + ], + "disabledForPatV2": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/copilot/custom-agents/source", + "title": "Set the source organization for custom agents in an enterprise", + "category": "copilot", + "subcategory": "copilot-custom-agents", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "organization_id", + "in": "body", + "description": "The ID of the organization to use as the custom agents source.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "create_ruleset", + "in": "body", + "description": "Whether to create a ruleset to protect agent definition files. Defaults to true.
", + "default": true + } + ], + "descriptionHTML": "Sets an organization as the source for custom agent definitions in the enterprise.\nThe organization must have a .github-private repository containing agent definitions.
By default, this endpoint also creates an enterprise-level ruleset to protect\nagent definition files (agents/.md and .github/agents/.md). You can opt out\nof ruleset creation by setting create_ruleset to false.
Enterprise owners with write access to AI Controls can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response without ruleset
", + "example": { + "organization": { + "id": 123, + "login": "my-org", + "avatar_url": "https://avatars.githubusercontent.com/u/123" + }, + "repository": { + "id": 456, + "name": ".github-private", + "full_name": "my-org/.github-private" + } + }, + "schema": { + "type": "object", + "properties": { + "organization": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "login": { + "type": "string", + "description": "The login name of the organization." + }, + "avatar_url": { + "type": "string", + "description": "The avatar URL of the organization." + } + } + }, + "repository": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the .github-private repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository (owner/name)." + } + } + }, + "ruleset": { + "type": "object", + "description": "The created or existing ruleset (if create_ruleset was true).", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset." + }, + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset." + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Success
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ], + "disabledForPatV2": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/copilot/custom-agents/source", + "title": "Delete the custom agents source for an enterprise", + "category": "copilot", + "subcategory": "copilot-custom-agents", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Removes the custom agents source configuration for the enterprise.\nThis effectively disables custom agents for the enterprise by removing\nthe reference to the source organization's .github-private repository.
Note: This does not delete the .github-private repository or any agent\ndefinition files. It only removes the association between the enterprise\nand the source repository.
Enterprise owners with write access to AI Controls can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content - The custom agents source was successfully removed.
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content - The custom agents source was successfully removed.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden - The user does not have enterprise admin access.
" + }, + { + "httpStatusCode": "404", + "description": "Not found - Enterprise not found, feature not enabled, or no custom agents source is configured.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ], + "disabledForPatV2": true + } + } + ], "copilot-metrics": [ { "serverUrl": "https://api.github.com", @@ -362203,6 +363283,14 @@ ] } }, + { + "name": "assignee", + "in": "query", + "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., octocat or octocat,hubot) to return alerts assigned to any of the specified users.\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., octocat or octocat,hubot) to return alerts assigned to any of the specified users.\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., octocat or octocat,hubot) to return alerts assigned to any of the specified users.\nUse * to list alerts with at least one assignee or none to list alerts with no assignees.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Resource not found
" }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, { "httpStatusCode": "500", "description": "Internal Error
" @@ -619358,6 +620558,10 @@ "httpStatusCode": "404", "description": "Resource not found
" }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, { "httpStatusCode": "500", "description": "Internal Error
" @@ -842100,6 +843304,10 @@ "httpStatusCode": "404", "description": "Resource not found
" }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, { "httpStatusCode": "500", "description": "Internal Error
" @@ -846038,6 +847246,10 @@ "httpStatusCode": "404", "description": "Resource not found
" }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, { "httpStatusCode": "500", "description": "Internal Error
" @@ -901185,6 +902397,10 @@ { "httpStatusCode": "204", "description": "No Content
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level.
" } ], "previews": [], @@ -910340,521 +911556,529 @@ { "httpStatusCode": "200", "description": "OK
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/external-groups", - "title": "List external groups available to an organization", - "category": "teams", - "subcategory": "external-groups", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page token
", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "display_name", - "description": "Limits the list to groups containing the text in the group name
", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Cloud generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" - } - ] - }, - "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", - "type": "object", - "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name of the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The time of the last update for this group", - "type": "string", - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" - }, - { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" - } - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "title": "List a connection between an external group and a team", - "category": "teams", - "subcategory": "external-groups", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" - } - ] - }, - "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", - "type": "object", - "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name of the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The time of the last update for this group", - "type": "string", - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" - }, - { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" - } - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", - "title": "Update the connection between an external group and a team", - "category": "teams", - "subcategory": "external-groups", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Members\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/external-groups", + "title": "List external groups available to an organization", + "category": "teams", + "subcategory": "external-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page token
", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "display_name", + "description": "Limits the list to groups containing the text in the group name
", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Cloud generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + }, + "schema": { + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { + "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] + } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Members\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", + "title": "List a connection between an external group and a team", + "category": "teams", + "subcategory": "external-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + }, + "schema": { + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { + "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] + } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Members\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", + "title": "Update the connection between an external group and a team", + "category": "teams", + "subcategory": "external-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "group_id", + "in": "body", + "description": "External Group Id
", + "isRequired": true + } + ], + "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "group_id": 123 + }, + "parameters": { + "org": "ORG", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ], + "members": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + }, + "schema": { + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", + "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name for the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The date when the group was last updated_at", + "type": "string", + "examples": [ + "2021-01-03 22:27:15:000 -700" + ] + }, + "teams": { + "description": "An array of teams linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "type": "integer", + "examples": [ + 1 + ] + }, + "team_name": { + "description": "The name of the team", + "type": "string", + "examples": [ + "team-test" + ] + } + } + }, + "examples": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ] + }, + "members": { + "description": "An array of external members linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "type": "integer", + "examples": [ + 1 + ] + }, + "member_login": { + "description": "The handle/login for the user", + "type": "string", + "examples": [ + "mona-lisa_eocsaxrs" + ] + }, + "member_name": { + "description": "The user display name/profile name", + "type": "string", + "examples": [ + "Mona Lisa" + ] + }, + "member_email": { + "description": "An email attached to a user", + "type": "string", + "examples": [ + "mona_lisa@github.com" + ] + } + } + }, + "examples": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" }, { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "integer", - "name": "group_id", - "in": "body", - "description": "External Group Id
", - "isRequired": true - } - ], - "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "group_id": 123 - }, - "parameters": { - "org": "ORG", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00", - "teams": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ], - "members": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - }, - "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", - "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name for the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "type": "string", - "examples": [ - "2021-01-03 22:27:15:000 -700" - ] - }, - "teams": { - "description": "An array of teams linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "team_id", - "team_name" - ], - "properties": { - "team_id": { - "description": "The id for a team", - "type": "integer", - "examples": [ - 1 - ] - }, - "team_name": { - "description": "The name of the team", - "type": "string", - "examples": [ - "team-test" - ] - } - } - }, - "examples": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ] - }, - "members": { - "description": "An array of external members linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "type": "integer", - "examples": [ - 1 - ] - }, - "member_login": { - "description": "The handle/login for the user", - "type": "string", - "examples": [ - "mona-lisa_eocsaxrs" - ] - }, - "member_name": { - "description": "The user display name/profile name", - "type": "string", - "examples": [ - "Mona Lisa" - ] - }, - "member_email": { - "description": "An email attached to a user", - "type": "string", - "examples": [ - "mona_lisa@github.com" - ] - } - } - }, - "examples": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - } - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" + "httpStatusCode": "422", + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level.
" } ], "previews": [], @@ -910919,6 +912143,10 @@ { "httpStatusCode": "204", "description": "No Content
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level.
" } ], "previews": [], @@ -911283,6 +912511,10 @@ { "httpStatusCode": "200", "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level.
" } ], "previews": [], @@ -913390,6 +914622,10 @@ { "httpStatusCode": "200", "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level.
" } ], "previews": [], @@ -913577,6 +914813,10 @@ { "httpStatusCode": "200", "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level.
" } ], "previews": [], diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 8ee24cd692dc..0fb2b87d12dc 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -382167,8 +382167,7 @@ "site_admin": false }, "dismissed_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null + "dismissed_comment": "This alert is accurate but we use a sanitizer." }, "schema": { "type": "object", @@ -383407,7 +383406,7 @@ "type": "array", "name": "selected_repository_ids", "in": "body", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future.
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.