Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the organizations with access to a self-hosted runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Resource not found
" } - ] + ], + "descriptionHTML": "Lists all labels for a self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runners configured in a repository.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all self-hosted runners configured in a repository.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
No Content
" } - ] + ], + "descriptionHTML": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote
\n\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -98310,7 +98309,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.
\nYou must use a JWT to access this endpoint.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -109851,13 +109851,13 @@ } ], "previews": [], - "descriptionHTML": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -113883,7 +113883,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -117163,7 +117166,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -120549,7 +120555,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -126186,13 +126195,13 @@ } ], "previews": [], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -132056,13 +132065,13 @@ } ], "previews": [], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nDisables the ability to restrict who can push to this branch.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nDisables the ability to restrict who can push to this branch.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -172135,7 +172144,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -177920,7 +177932,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -179042,7 +179057,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -179752,7 +179770,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -180494,7 +180515,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -180607,7 +180631,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -193345,13 +193372,13 @@ } ], "previews": [], - "descriptionHTML": "Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Parameters that are not provided will be overwritten with the default value or removed if no default exists.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210527,13 +210554,13 @@ } ], "previews": [], - "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
Created
" } - ] + ], + "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
Created
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -214888,13 +214915,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -215099,13 +215126,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -225123,7 +225150,6 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", @@ -225133,7 +225159,8 @@ "httpStatusCode": "201", "description": "Response when creating a new impersonation OAuth token
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -242858,7 +242885,6 @@ } ], "previews": [], - "descriptionHTML": "Get the content of a gitignore template.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw .gitignore contents.Not modified
" } - ] + ], + "descriptionHTML": "Get the content of a gitignore template.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw .gitignore contents.List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
Note
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ] + ], + "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -298472,7 +298499,6 @@ } ], "previews": [], - "descriptionHTML": "Lists all events for an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -298482,7 +298508,8 @@ "httpStatusCode": "410", "description": "Gone
" } - ] + ], + "descriptionHTML": "Lists all events for an issue.
" } ], "labels": [ @@ -301709,7 +301736,6 @@ } ], "previews": [], - "descriptionHTML": "Gets a milestone using the given milestone number.
", "statusCodes": [ { "httpStatusCode": "200", @@ -301719,7 +301745,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Gets a milestone using the given milestone number.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -320568,13 +320595,13 @@ } ], "previews": [], - "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -345777,13 +345804,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Response - list of custom role names
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.
Resource not found
" } - ] + ], + "descriptionHTML": "If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.
Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.
\nOnly GitHub Apps can use this endpoint.
", "statusCodes": [ { "httpStatusCode": "202", @@ -356441,7 +356467,8 @@ "httpStatusCode": "500", "description": "Internal Error
" } - ] + ], + "descriptionHTML": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.
\nOnly GitHub Apps can use this endpoint.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -365302,13 +365329,13 @@ } ], "previews": [], - "descriptionHTML": "Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Lists packages owned by the authenticated user within the user's namespace.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
The value of per_page multiplied by page cannot be greater than 10000.
Lists packages owned by the authenticated user within the user's namespace.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
", "statusCodes": [ { "httpStatusCode": "204", @@ -411005,7 +411037,8 @@ "httpStatusCode": "404", "description": "Not Found if pull request has not been merged
" } - ] + ], + "descriptionHTML": "Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -435584,7 +435617,6 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -435594,7 +435626,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "List the reactions to a pull request review comment.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -437373,13 +437406,13 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -462338,13 +462371,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -468917,13 +468950,13 @@ } } ], - "descriptionHTML": "Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.
OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.
Created
" } ], + "descriptionHTML": "Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.
OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.
Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.baptiste-preview+json\nLists suites of rule evaluations at the repository level.\nFor more information, see \"Managing rulesets for a repository.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -487769,7 +487801,8 @@ "httpStatusCode": "500", "description": "Internal Error
" } - ] + ], + "descriptionHTML": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"Managing rulesets for a repository.\"
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -497679,7 +497712,6 @@ } ], "previews": [], - "descriptionHTML": "Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nValidation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
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.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "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.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -536970,7 +537003,6 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -536980,7 +537012,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -537038,7 +537071,6 @@ } ], "previews": [], - "descriptionHTML": "The \"Get team member\" endpoint (described below) is closing down.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "204", @@ -537048,7 +537080,8 @@ "httpStatusCode": "404", "description": "if user is not a member
" } - ] + ], + "descriptionHTML": "The \"Get team member\" endpoint (described below) is closing down.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index 7767dd7d64f2..cb708d1062ae 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -113981,7 +113981,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -117261,7 +117264,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -120647,7 +120653,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -175785,7 +175794,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -181570,7 +181582,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -182692,7 +182707,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -183402,7 +183420,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -184144,7 +184165,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -184257,7 +184281,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -416585,7 +416612,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -416806,7 +416836,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index 53185dcbcc0b..42a12088cb40 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -1846,13 +1846,13 @@ } ], "previews": [], + "descriptionHTML": "Lists the GitHub Actions caches for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the GitHub Actions caches for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.
To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.
To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Deletes a secret in a repository using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a secret in a repository using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the organizations with access to a self-hosted runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Updates an environment variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Approve or reject pending deployments that are waiting on approval by a required reviewer.
\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Approve or reject pending deployments that are waiting on approval by a required reviewer.
\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No content
" } - ], - "descriptionHTML": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -90123,13 +90123,13 @@ } ], "previews": [], + "descriptionHTML": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -114196,7 +114196,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -117486,7 +117489,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -120882,7 +120888,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -126623,13 +126632,13 @@ } ], "previews": [], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -176496,7 +176505,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -182291,7 +182303,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -183427,7 +183442,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -184144,7 +184162,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -184893,7 +184914,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -185006,7 +185030,10 @@ "type": "object", "properties": { "sha": { - "type": "string", + "type": [ + "string", + "null" + ], "examples": [ "bbcd538c8e72b8c175046e27cc8f907076331401" ] @@ -205280,13 +205307,13 @@ } ], "previews": [], + "descriptionHTML": "Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Note
\n\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Enable a custom deployment protection rule for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The enabled custom deployment protection rule
" } - ], - "descriptionHTML": "Enable a custom deployment protection rule for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -216012,13 +216039,13 @@ } ], "previews": [], + "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
Created
" } - ], - "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
Response when creating a new impersonation OAuth token
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -272192,6 +272219,7 @@ } ], "previews": [], + "descriptionHTML": "List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Resource not found
" } - ], - "descriptionHTML": "List issues across owned and member repositories assigned to the authenticated user.
\nNote
\n\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists all labels for a repository.
", "statusCodes": [ { "httpStatusCode": "200", @@ -305707,8 +305735,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Lists all labels for a repository.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -326986,13 +327013,13 @@ } ], "previews": [], + "descriptionHTML": "Get the octocat as ASCII art
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the octocat as ASCII art
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -332564,6 +332591,7 @@ } ], "previews": [], + "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
", "statusCodes": [ { "httpStatusCode": "204", @@ -332573,8 +332601,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -352515,13 +352542,13 @@ } ], "previews": [], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Response - list of custom role names
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Gets a specific package metadata for a public package owned by a user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package metadata for a public package owned by a user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
No Content
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -451569,13 +451602,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "https://HOSTNAME/api/uploads", @@ -488966,13 +488999,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nFound
" } - ], - "descriptionHTML": "Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
\nDisplays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\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.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\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.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -549070,6 +549103,7 @@ } ], "previews": [], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nif team synchronization is set up
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\n