Lists all artifacts for a repository.
\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": "Lists all artifacts for a repository.
\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.
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 total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Deletes a GitHub Actions cache for a repository, using a cache ID.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a GitHub Actions cache for a repository, using a cache ID.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"Allowing access to components in a private repository\".
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"Allowing access to components in a private repository\".
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes a secret in an organization 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 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.
No Content
" } - ], - "descriptionHTML": "Deletes a secret in an organization 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 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.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nThe authenticated user must have collaborator 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": "Gets a single repository secret without revealing its encrypted value.
\nThe authenticated user must have collaborator access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all secrets available in an environment without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in an environment without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\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.
OK
" } - ], - "descriptionHTML": "Gets a single environment secret without revealing its encrypted value.
\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 all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists the repositories with 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.
OK
" } - ], - "descriptionHTML": "Lists the repositories with 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.
Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ], - "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Returns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
./config.sh remove --token TOKEN\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Returns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
./config.sh remove --token TOKEN\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Creates an organization 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 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.
Response when creating a variable
" } - ], - "descriptionHTML": "Creates an organization 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 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.
Gets a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\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 a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\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.
Updates an organization 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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
No Content
" } - ], - "descriptionHTML": "Updates an organization 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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Gets a specific variable in a repository.
\nThe authenticated user must have collaborator 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": "Gets a specific variable in a repository.
\nThe authenticated user must have collaborator access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Deletes an environment variable using the variable name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes an environment variable using the variable name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download.
Anyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Found
" } - ], - "descriptionHTML": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download.
Anyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Forbidden
" } - ], - "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for Location: in the response header to find the URL for the download.
Anyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Found
" } - ], - "descriptionHTML": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for Location: in the response header to find the URL for the download.
Anyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\nLocation: in the response header to find the URL for the download.
Anyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Found
" } - ], - "descriptionHTML": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\nLocation: in the response header to find the URL for the download.
Anyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth 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.
List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone 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.
This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.
OK
" } - ], - "descriptionHTML": "List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone 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.
This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.
Gets a specific workflow. You can replace workflow_id with the workflow\nfile name. For example, you could use main.yaml.
Anyone 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": "Gets a specific workflow. You can replace workflow_id with the workflow\nfile name. For example, you could use main.yaml.
Anyone 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.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nThe permissions the installation has are included under the permissions key.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "The permissions the installation has are included under the permissions key.
The permissions the installation has are included under the permissions key.
You must use a JWT to access this endpoint.
" + ] }, { "serverUrl": "https://api.github.com", @@ -90848,6 +90854,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -91573,7 +91585,7 @@ } ], "previews": [], - "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -93692,7 +93704,7 @@ } ], "previews": [], - "descriptionHTML": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.
\nYou must use a JWT to access this endpoint.
", + "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 API or webhook events is blocked for that account.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -96201,6 +96213,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -97288,6 +97306,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -98373,6 +98397,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -100728,6 +100758,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -108743,13 +108779,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.
Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
" + ] }, { "serverUrl": "https://api.github.com", @@ -171216,6 +171252,7 @@ } ], "previews": [], + "descriptionHTML": "Lists all code security configurations available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Lists all code security configurations available in an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Lists the default code security configurations for an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the default code security configurations for an enterprise.
\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.
Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.
\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Accepted
" } - ], - "descriptionHTML": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.
\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.
\nThe authenticated user must be an administrator or security manager 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 all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets an organization development environment secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets an organization development environment secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Deletes a development environment secret in a repository using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.
No Content
" } - ], - "descriptionHTML": "Deletes a development environment secret in a repository using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.
No Content
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "https://api.github.com", @@ -251426,13 +251462,13 @@ } ], "previews": [], + "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org 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.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets a deployment branch or tag policy for an environment.
\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": "Gets a deployment branch or tag policy for an environment.
\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.
Updates a deployment branch or tag policy for an environment.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Updates a deployment branch or tag policy for an environment.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
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.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Default response
" } - ], - "descriptionHTML": "OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Users with push access can unlock an issue's conversation.
", "statusCodes": [ { "httpStatusCode": "204", @@ -303759,8 +303796,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Users with push access can unlock an issue's conversation.
" + ] }, { "serverUrl": "https://api.github.com", @@ -315182,6 +315218,7 @@ } ], "previews": [], + "descriptionHTML": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
\nThis 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": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
\nThis 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.You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
" + ] }, { "serverUrl": "https://api.github.com", @@ -372537,6 +372573,7 @@ } ], "previews": [], + "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw contents of the license.application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.Resource not found
" } - ], - "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw contents of the license.application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.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": "https://api.github.com", @@ -378460,6 +378496,7 @@ } ], "previews": [], + "descriptionHTML": "Initiates the generation of a migration archive.
", "statusCodes": [ { "httpStatusCode": "201", @@ -378473,8 +378510,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Initiates the generation of a migration archive.
" + ] }, { "serverUrl": "https://api.github.com", @@ -389753,13 +389789,13 @@ } ], "previews": [], + "descriptionHTML": "This endpoint allows you to run an embedding request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.
OK
" } - ], - "descriptionHTML": "This endpoint allows you to run an embedding request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.
This endpoint allows you to run an embedding request. The token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.
OK
" } - ], - "descriptionHTML": "This endpoint allows you to run an embedding request. The token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.
Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:read scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:read scope to use this endpoint.
Get API request count statistics for an actor broken down by route within a specified time frame.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get API request count statistics for an actor broken down by route within a specified time frame.
" + ] }, { "serverUrl": "https://api.github.com", @@ -394336,13 +394378,13 @@ } ], "previews": [], + "descriptionHTML": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.
" + ] }, { "serverUrl": "https://api.github.com", @@ -394440,13 +394482,13 @@ } ], "previews": [], + "descriptionHTML": "Get overall statistics of API requests within the organization for a user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get overall statistics of API requests within the organization for a user.
" + ] }, { "serverUrl": "https://api.github.com", @@ -394696,13 +394738,13 @@ } ], "previews": [], + "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.
" + ] }, { "serverUrl": "https://api.github.com", @@ -399751,7 +399793,7 @@ } ], "previews": [], - "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", + "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nIn order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", + "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nThe user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Forbidden
" } - ], - "descriptionHTML": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Lists all hosted compute network configurations configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all hosted compute network configurations configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
Creates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.
Updates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Updates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.
Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets a specific package version in an organization.
\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 version in an organization.
\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.\"
You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ], - "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
" + ] }, { "serverUrl": "https://api.github.com", @@ -436432,13 +436474,13 @@ } ], "previews": [], + "descriptionHTML": "Gets information about a GitHub Pages build.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets information about a GitHub Pages build.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Get the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Get the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
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.
\nList the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
OK
" } - ], - "descriptionHTML": "Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Lists the verified public SSH keys for a user. This is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
" + ] } ], "social-accounts": [ diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 1c847e4685..d89b85e54d 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -989,7 +989,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise administration\" enterprise permissions": "write" @@ -6177,7 +6177,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise administration\" enterprise permissions": "write" @@ -98963,7 +98963,7 @@ ] }, "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", "type": "string", "enum": [ "all", @@ -98997,6 +98997,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -100045,7 +100051,7 @@ ] }, "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", "type": "string", "enum": [ "all", @@ -100079,6 +100085,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -100804,7 +100816,7 @@ } ], "previews": [], - "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -101457,7 +101469,7 @@ }, "schema": { "title": "Installation Token", - "description": "Authentication token for a GitHub App installed on a user or org.", + "description": "Authentication token for a GitHub App installed on a user, org, or enterprise.", "type": "object", "properties": { "token": { @@ -102852,7 +102864,7 @@ } ], "previews": [], - "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.
Optionally, you can use the repositories or repository_ids body parameters to specify individual repositories that the installation access token can access. If you don't use repositories or repository_ids to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.
Optionally, use the permissions body parameter to specify the permissions that the installation access token should have. If permissions is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.
You must use a JWT to access this endpoint.
", + "descriptionHTML": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.
Optionally, you can use the repositories or repository_ids body parameters to specify individual repositories that the installation access token can access. If you don't use repositories or repository_ids to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.
Optionally, use the permissions body parameter to specify the permissions that the installation access token should have. If permissions is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.
Enterprise account installations do not have access to repositories and cannot be scoped down using the permissions parameter.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", @@ -102923,7 +102935,7 @@ } ], "previews": [], - "descriptionHTML": "Suspends a GitHub App on a user, organization, or business 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 Cloud API or webhook events is blocked for that account.
\nYou must use a JWT to access this endpoint.
", + "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 Cloud API or webhook events is blocked for that account.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -105398,7 +105410,7 @@ ] }, "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", "type": "string", "enum": [ "all", @@ -105432,6 +105444,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -106485,7 +106503,7 @@ ] }, "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", "type": "string", "enum": [ "all", @@ -106519,6 +106537,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -107570,7 +107594,7 @@ ] }, "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", "type": "string", "enum": [ "all", @@ -107604,6 +107628,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -109925,7 +109955,7 @@ ] }, "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", "type": "string", "enum": [ "all", @@ -109959,6 +109989,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -281836,7 +281872,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Administration\" organization permissions": "read" @@ -286150,7 +286186,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Custom properties\" enterprise permissions": "read" @@ -286418,7 +286454,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Custom properties\" enterprise permissions": "write" @@ -286658,7 +286694,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Custom properties\" enterprise permissions": "write" @@ -286846,7 +286882,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Custom properties\" enterprise permissions": "read" @@ -287082,7 +287118,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Custom properties\" enterprise permissions": "write" @@ -287280,7 +287316,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Custom properties\" enterprise permissions": "write" @@ -287363,7 +287399,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise administration\" enterprise permissions": "read" @@ -288466,6 +288502,3627 @@ ] } ], + "organization-installations": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/apps/installable_organizations", + "title": "Get enterprise-owned organizations that can have GitHub Apps installed", + "category": "enterprise-admin", + "subcategory": "organization-installations", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise organization installations\" enterprise permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of organizations owned by the enterprise on which the authenticated GitHub App is installed.
", + "example": [ + { + "id": 1, + "login": "github" + }, + { + "id": 2, + "login": "microsoft" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Installable Organization", + "description": "A GitHub organization on which a GitHub App can be installed.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "accessible_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/enterprises/biz-name/apps/organizations/org-login/accessible_repositories" + ] + } + }, + "required": [ + "id", + "login" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of organizations owned by the enterprise on which the authenticated GitHub App is installed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories", + "title": "Get repositories belonging to an enterprise-owned organization", + "category": "enterprise-admin", + "subcategory": "organization-installations", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise organization installation repositories\" enterprise permissions": "read" + }, + { + "\"Enterprise organization installations\" enterprise permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of repositories owned by the enterprise organization on which the authenticated GitHub App is installed.
", + "example": [ + { + "id": 1, + "name": "Hello World", + "full_name": "octocat/Hello-World" + }, + { + "id": 2, + "login": "Goodbye World", + "full_name": "octocat/Goodbye-World" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Accessible Repository", + "description": "A repository that may be made accessible to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + } + }, + "required": [ + "full_name", + "id", + "name" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List the repositories belonging to an enterprise-owned organization that can be made accessible to a GitHub App installed on that organization. This API provides a shallow list of repositories in the organization, allowing the caller to then add or remove those repositories to an installation in that organization.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of repositories owned by the enterprise organization on which the authenticated GitHub App is installed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations", + "title": "List GitHub Apps installed on an enterprise-owned organization", + "category": "enterprise-admin", + "subcategory": "organization-installations", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise organization installations\" enterprise permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of GitHub App installations that have been granted access to the organization
", + "example": [ + { + "value": { + "id": 1, + "app_slug": "monalisa/orbit", + "repository_selection": "selected", + "repositories_url": "https://api.github.com/enterprises/acme-corp/apps/organizations/some-org/installations/1/repositories", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00" + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Enterprise Organization Installation", + "description": "A GitHub App Installation on an enterprise-owned organization", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github/github-actions" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/enterprises/acme-corp/apps/organizations/some-org/installations/1/repositories" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "client_id", + "repository_selection", + "repositories_url", + "permissions", + "created_at", + "updated_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists the GitHub App installations associated with the given enterprise-owned organization. This lists all GitHub Apps that have been installed on the organization, regardless of who owns the application.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of GitHub App installations that have been granted access to the organization
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations", + "title": "Install a GitHub App on an enterprise-owned organization", + "category": "enterprise-admin", + "subcategory": "organization-installations", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "client_id", + "in": "body", + "description": "The Client ID of the GitHub App to install.
", + "isRequired": true + }, + { + "type": "string", + "name": "repository_selection", + "in": "body", + "description": "The repository selection for the GitHub App. Must be one of:
\nall - the installation can access all repositories in the organization.selected - the installation can access only the listed repositories.none - no repository permissions are requested. Only use when the app does not request repository permissions.The names of the repositories to which the installation will be granted access. This is the simple name of the repository, not the full name (e.g., hello-world not octocat/hello-world). This is only required when repository_selection is selected.
A GitHub App installation that was installed previously.
", + "example": { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "repository_selection": "selected", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + }, + "schema": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Installs any valid GitHub App on the specified organization owned by the enterprise. If the app is already installed on the organization, and is suspended, it will be unsuspended.\nIf the app has a pending installation request, they will all be approved.
\nIf the app is already installed and has a pending update request, it will be updated to the latest version. If the app is now requesting repository permissions, it will be given access to the repositories listed in the request or fail if no repository_selection is provided.
This API can only be called by a GitHub App installed on the enterprise that owns the organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A GitHub App installation that was installed previously.
" + }, + { + "httpStatusCode": "201", + "description": "A GitHub App installation.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}", + "title": "Uninstall a GitHub App from an enterprise-owned organization", + "category": "enterprise-admin", + "subcategory": "organization-installations", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise organization installations\" enterprise permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "org": "ORG", + "installation_id": 1 + } + }, + "response": { + "statusCode": "204", + "description": "An empty response indicates that the installation was successfully removed.
" + } + } + ], + "previews": [], + "descriptionHTML": "Uninstall a GitHub App from an organization. Any app installed on the organization can be removed.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "An empty response indicates that the installation was successfully removed.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories", + "title": "Get the repositories accessible to a given GitHub App installation", + "category": "enterprise-admin", + "subcategory": "organization-installations", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise organization installation repositories\" enterprise permissions": "read" + }, + { + "\"Enterprise organization installations\" enterprise permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "org": "ORG", + "installation_id": 1 + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of repositories owned by the enterprise organization to which the installation has access.
", + "example": [ + { + "id": 1, + "name": "Hello World", + "full_name": "octocat/Hello-World" + }, + { + "id": 2, + "login": "Goodbye World", + "full_name": "octocat/Goodbye-World" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Accessible Repository", + "description": "A repository that may be made accessible to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + } + }, + "required": [ + "full_name", + "id", + "name" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of repositories owned by the enterprise organization to which the installation has access.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories", + "title": "Toggle installation repository access between selected and all repositories", + "category": "enterprise-admin", + "subcategory": "organization-installations", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "repository_selection", + "in": "body", + "description": "One of either 'all' or 'selected'
", + "isRequired": true, + "enum": [ + "all", + "selected" + ] + }, + { + "type": "array of strings", + "name": "repositories", + "in": "body", + "description": "The repository names to add to the installation. Only required when repository_selection is 'selected'
" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise organization installation repositories\" enterprise permissions": "write" + }, + { + "\"Enterprise organization installations\" enterprise permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Change the repositories accessible to a GitHub App from 'all repositories' to a specified subset.", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "repository_selection": "selected", + "repositories": [ + "hello-world", + "hello-world-2" + ] + }, + "parameters": { + "enterprise": "ENTERPRISE", + "org": "ORG", + "installation_id": 1 + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "The GitHub App installation that was updated.
", + "example": { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "repository_selection": "selected", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + }, + "schema": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "The GitHub App installation that was updated.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add", + "title": "Grant repository access to an organization installation", + "category": "enterprise-admin", + "subcategory": "organization-installations", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "repositories", + "in": "body", + "description": "The repository names to add to the installation.
", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise organization installation repositories\" enterprise permissions": "write" + }, + { + "\"Enterprise organization installations\" enterprise permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "repositories", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "repositories": [ + "hello-world", + "hello-world-2" + ] + }, + "parameters": { + "enterprise": "ENTERPRISE", + "org": "ORG", + "installation_id": 1 + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of repositories which the authenticated GitHub App should be granted access to.
", + "example": [ + { + "id": 1, + "name": "Hello World", + "full_name": "octocat/Hello-World" + }, + { + "id": 2, + "login": "Goodbye World", + "full_name": "octocat/Goodbye-World" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Accessible Repository", + "description": "A repository that may be made accessible to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + } + }, + "required": [ + "full_name", + "id", + "name" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Grant repository access to an organization installation. You can add up to 50 repositories at a time. If the installation already has access to the repository, it will not be added again.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of repositories which the authenticated GitHub App should be granted access to.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove", + "title": "Remove repository access from an organization installation", + "category": "enterprise-admin", + "subcategory": "organization-installations", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "installation_id", + "description": "The unique identifier of the installation.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "repositories", + "in": "body", + "description": "The repository names to remove from the installation.
", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise organization installation repositories\" enterprise permissions": "write" + }, + { + "\"Enterprise organization installations\" enterprise permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "repositories", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "repositories": [ + "hello-world", + "hello-world-2" + ] + }, + "parameters": { + "enterprise": "ENTERPRISE", + "org": "ORG", + "installation_id": 1 + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of repositories which the authenticated GitHub App has lost access to.
", + "example": [ + { + "id": 1, + "name": "Hello World", + "full_name": "octocat/Hello-World" + }, + { + "id": 2, + "login": "Goodbye World", + "full_name": "octocat/Goodbye-World" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Accessible Repository", + "description": "A repository that may be made accessible to a GitHub App.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + } + }, + "required": [ + "full_name", + "id", + "name" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Remove repository access from a GitHub App installed on an organization. You can remove up to 50 repositories at a time. You cannot remove repositories from an app installed on all repositories, nor can you remove the last repository for an app. If you attempt to do so, the API will return a 422 Unprocessable Entity error.
This API can only be called by a GitHub App installed on the enterprise that owns the organization.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of repositories which the authenticated GitHub App has lost access to.
" + }, + { + "httpStatusCode": "422", + "description": "The request was well-formed but was unable to be followed due to semantic errors. This can happen if you attempt to remove a repository from an installation that has access to all repositories, or if you attempt to remove the last repository from an installation.
Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", + "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nIn order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", + "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nLists 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.
Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
A JSON serialized template for OIDC subject claim customization
" } - ], - "descriptionHTML": "Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org 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.
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
OK
" } - ], - "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all secrets available in an organization without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in an organization without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
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.
Deletes a secret in an organization 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 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.
No Content
" } - ], - "descriptionHTML": "Deletes a secret in an organization 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 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.
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.
Adds an organization to 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": "Adds an organization to 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.
Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Returns a token that you can pass to the config script. The token expires after one hour.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Lists all organization variables.
\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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ], - "descriptionHTML": "Lists all organization variables.
\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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Gets a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\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 a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\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.
Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Response when the visibility of the variable is not set to selected
Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Response when the visibility of the variable is not set to selected
Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists all notifications for the current user in the specified repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists all notifications for the current user in the specified repository.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -92729,6 +92729,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -93811,6 +93817,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -94536,7 +94548,7 @@ } ], "previews": [], - "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -96655,7 +96667,7 @@ } ], "previews": [], - "descriptionHTML": "Suspends a GitHub App on a user, organization, or business 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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -99158,6 +99170,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -100245,6 +100263,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -101330,6 +101354,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -101996,13 +102026,13 @@ } ], "previews": [], + "descriptionHTML": "Enables an authenticated GitHub App to find the user’s installation information.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Enables an authenticated GitHub App to find the user’s installation information.
\nYou must use a JWT to access this endpoint.
" + ] } ], "installations": [ @@ -103685,6 +103715,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -118401,6 +118437,7 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "201", @@ -118426,8 +118463,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "" + ] } ], "branch-protection": [ @@ -185565,13 +185601,13 @@ } ], "previews": [], + "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org 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.
\nOAuth 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.
\nOAuth app 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.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -201236,13 +201272,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -202269,13 +202305,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
Success
" } - ], - "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count field.
Accepted
" } - ], - "descriptionHTML": "" + ] } ], "pre-receive-environments": [ @@ -209702,13 +209738,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210889,7 +210925,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -211249,7 +211285,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -211542,7 +211578,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -211859,7 +211895,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -212399,7 +212435,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -212912,7 +212948,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -213036,7 +213072,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -213577,7 +213613,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -214294,7 +214330,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -214795,7 +214831,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -215233,7 +215269,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -216241,7 +216277,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -293365,13 +293401,13 @@ } ], "previews": [], + "descriptionHTML": "Lists labels for issues in a milestone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists labels for issues in a milestone.
" + ] } ], "milestones": [ @@ -293853,6 +293889,7 @@ } ], "previews": [], + "descriptionHTML": "Lists milestones for a repository.
", "statusCodes": [ { "httpStatusCode": "200", @@ -293862,8 +293899,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Lists milestones for a repository.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -313599,13 +313635,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", @@ -324558,6 +324594,7 @@ } ], "previews": [], + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Resource not found
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
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.
Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", + "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nIn order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", + "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nMembers of an organization can choose to have their membership publicized or not.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -341771,6 +341813,7 @@ } ], "previews": [], + "descriptionHTML": "Check if the provided user is a public member of the organization.
", "statusCodes": [ { "httpStatusCode": "204", @@ -341780,8 +341823,7 @@ "httpStatusCode": "404", "description": "Not Found if user is not a public member
" } - ], - "descriptionHTML": "Check if the provided user is a public member of the organization.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -343774,6 +343816,7 @@ } ], "previews": [], + "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "statusCodes": [ { "httpStatusCode": "204", @@ -343783,8 +343826,7 @@ "httpStatusCode": "422", "description": "Unprocessable Entity if user is a member of the organization
" } - ], - "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
" + ] } ], "personal-access-tokens": [ @@ -355471,13 +355513,13 @@ } ], "previews": [], + "descriptionHTML": "Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OK
" } - ], - "descriptionHTML": "Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.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-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ], - "descriptionHTML": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.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-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.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-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ], - "descriptionHTML": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.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-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.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-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.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": "Creates a review on a specified pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nPull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"
Note
\n\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.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-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.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-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.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": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.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-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Note
\n\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "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/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -424474,6 +424516,7 @@ } ], "previews": [], + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -424483,8 +424526,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "List the reactions to a pull request review comment.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -426174,6 +426216,7 @@ } ], "previews": [], + "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Users with push access to the repository can edit a release.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Users with push access to the repository can edit a release.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -432473,13 +432515,13 @@ } ], "previews": [], + "descriptionHTML": "Users with push access to the repository can delete a release.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Users with push access to the repository can delete a release.
" + ] } ], "assets": [ @@ -465782,13 +465824,13 @@ } ], "previews": [], + "descriptionHTML": "Gets all autolinks that are configured for a repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets all autolinks that are configured for a repository.
\nInformation about autolinks are only available to repository administrators.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -488979,6 +489021,7 @@ } ], "previews": [], + "descriptionHTML": "Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Not modified
" } - ], - "descriptionHTML": "Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -96655,7 +96667,7 @@ } ], "previews": [], - "descriptionHTML": "Suspends a GitHub App on a user, organization, or business 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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -99158,6 +99170,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -100245,6 +100263,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -101330,6 +101354,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -103685,6 +103715,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -210889,7 +210925,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -211249,7 +211285,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -211542,7 +211578,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -211859,7 +211895,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -212399,7 +212435,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -212912,7 +212948,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -213036,7 +213072,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -213577,7 +213613,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -214294,7 +214330,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -214795,7 +214831,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -215233,7 +215269,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -216241,7 +216277,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -335685,6 +335721,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -340459,7 +340501,7 @@ } ], "previews": [], - "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", + "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nIn order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", + "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nUninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -97012,7 +97024,7 @@ } ], "previews": [], - "descriptionHTML": "Suspends a GitHub App on a user, organization, or business 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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -99538,6 +99550,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -100633,6 +100651,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -101726,6 +101750,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -104089,6 +104119,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -213786,7 +213822,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -214146,7 +214182,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -214439,7 +214475,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -214756,7 +214792,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -215296,7 +215332,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -215809,7 +215845,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -215933,7 +215969,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -216474,7 +216510,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -217191,7 +217227,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -217692,7 +217728,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -218130,7 +218166,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -219138,7 +219174,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -339006,6 +339042,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -343788,7 +343830,7 @@ } ], "previews": [], - "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", + "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nIn order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", + "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nGets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
Gets GitHub Actions cache usage policy for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets GitHub Actions cache usage policy for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists self-hosted runners that are in a specific organization group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists self-hosted runners that are in a specific organization group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ], - "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Returns a token that you can pass to the config script. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Returns a token that you can pass to the config script. The token expires after one hour.
For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all organization variables.
\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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ], - "descriptionHTML": "Lists all organization variables.
\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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
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", @@ -93053,6 +93053,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -94151,6 +94157,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -94892,7 +94904,7 @@ } ], "previews": [], - "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -97045,7 +97057,7 @@ } ], "previews": [], - "descriptionHTML": "Suspends a GitHub App on a user, organization, or business 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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -99588,6 +99600,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -100691,6 +100709,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -101792,6 +101816,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -104163,6 +104193,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -126176,13 +126212,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", @@ -196284,13 +196320,13 @@ } ], "previews": [], + "descriptionHTML": "Create a new snapshot of a repository's dependencies.
\nThe authenticated user must have access to the repository.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Create a new snapshot of a repository's dependencies.
\nThe authenticated user must have access to the repository.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -198058,13 +198094,13 @@ } ], "previews": [], + "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Simple filtering of deployments is available via query parameters:
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -212426,13 +212462,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -212891,13 +212927,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.
Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", + "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nIn order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", + "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nGets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -433971,13 +434013,13 @@ } ], "previews": [], + "descriptionHTML": "Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Note
\n\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
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 reactions for a team discussion endpoint.
List the reactions to a team discussion.
\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 reactions for a team discussion endpoint.
List the reactions to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
OK
" } - ], - "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -531654,13 +531696,13 @@ } ], "previews": [], + "descriptionHTML": "Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Get a specific comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
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 Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write: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 Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
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.\"
\nAuthenticated users 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.
Response when updating a secret
" } - ] + ], + "descriptionHTML": "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.\"
\nAuthenticated users 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.
Adds a self-hosted runner to a runner group 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": "Adds a self-hosted runner to a runner group 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.
Adds a repository to the list of 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 tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a repository to the list of 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 tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ] + ], + "descriptionHTML": "Lists all self-hosted runners configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Lists all repositories that can access an organization variable\nthat is available to selected repositories.
\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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Response when the visibility of the variable is not set to selected
Lists all repositories that can access an organization variable\nthat is available to selected repositories.
\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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Lists all environment variables.
\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.
OK
" } - ] + ], + "descriptionHTML": "Lists all environment variables.
\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.
Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -97237,7 +97249,7 @@ } ], "previews": [], - "descriptionHTML": "Suspends a GitHub App on a user, organization, or business 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.
", + "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -99780,6 +99792,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -100883,6 +100901,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -101984,6 +102008,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -103871,13 +103901,13 @@ } ], "previews": [], - "descriptionHTML": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.
\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.
\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -104355,6 +104385,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -167279,7 +167315,6 @@ } ], "previews": [], - "descriptionHTML": "Lists the repositories associated with a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Resource not found
" } - ] + ], + "descriptionHTML": "Lists the repositories associated with a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager 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 all secrets available in an organization without revealing their\nencrypted values.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all secrets available in an organization without revealing their\nencrypted values.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
List of deployment protection rules
" } - ] + ], + "descriptionHTML": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209717,13 +209753,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210110,13 +210146,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210295,13 +210331,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" } ], "announcement": [ @@ -212255,13 +212291,13 @@ } ], "previews": [], - "descriptionHTML": "Deletes an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "The audit log stream configuration was deleted successfully.
" } - ] + ], + "descriptionHTML": "Deletes an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
" } ], "billing": [ @@ -217330,13 +217366,13 @@ } ], "previews": [], - "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
" } ], "orgs": [ @@ -217510,13 +217546,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -218585,13 +218621,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -219683,13 +219719,13 @@ } ], "previews": [], - "descriptionHTML": "Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Responds with effective values inherited from owner and/or global level.
" } - ] + ], + "descriptionHTML": "Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
" } ], "scim": [ @@ -219772,7 +219808,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -220132,7 +220168,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -220425,7 +220461,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -220742,7 +220778,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -221282,7 +221318,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -221795,7 +221831,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -221919,7 +221955,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -222460,7 +222496,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -223177,7 +223213,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "read" @@ -223678,7 +223714,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -224116,7 +224152,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -225124,7 +225160,7 @@ "progAccess": { "userToServerRest": true, "serverToServer": true, - "fineGrainedPat": true, + "fineGrainedPat": false, "permissions": [ { "\"Enterprise SCIM\" enterprise permissions": "write" @@ -342577,7 +342613,6 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", "statusCodes": [ { "httpStatusCode": "200", @@ -342587,7 +342622,8 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -345261,6 +345297,12 @@ 1 ] }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" @@ -350496,7 +350538,7 @@ } ], "previews": [], - "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", + "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nIn order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", + "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
\nNote
\n\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
\nGets a specific package version in an organization.
\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 version in an organization.
\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.\"
Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -504209,13 +504251,13 @@ } ], "previews": [], - "descriptionHTML": "Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.
To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
No Content
" } - ] + ], + "descriptionHTML": "To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.