{ "openapi": "3.0.3", "info": { "version": "1.1.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, "termsOfService": "https://docs.github.com/articles/github-terms-of-service", "contact": { "name": "Support", "url": "https://support.github.com/contact?tags=dotcom-rest-api" }, "x-github-plan": "api.github.com" }, "tags": [ { "name": "actions", "description": "Endpoints to manage GitHub Actions using the REST API." }, { "name": "activity", "description": "Activity APIs provide access to notifications, subscriptions, and timelines." }, { "name": "apps", "description": "Information for integrations and installations." }, { "name": "billing", "description": "Monitor charges and usage from Actions and Packages." }, { "name": "checks", "description": "Rich interactions with checks run by your integrations." }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." }, { "name": "codes-of-conduct", "description": "Insight into codes of conduct for your communities." }, { "name": "emojis", "description": "List emojis available to use on GitHub." }, { "name": "dependabot", "description": "Endpoints to manage Dependabot." }, { "name": "dependency-graph", "description": "Endpoints to access Dependency Graph features." }, { "name": "gists", "description": "View, modify your gists." }, { "name": "git", "description": "Raw Git functionality." }, { "name": "gitignore", "description": "View gitignore templates" }, { "name": "issues", "description": "Interact with GitHub Issues." }, { "name": "licenses", "description": "View various OSS licenses." }, { "name": "markdown", "description": "Render GitHub flavored markdown" }, { "name": "merge-queue", "description": "Interact with GitHub Merge Queues." }, { "name": "meta", "description": "Endpoints that give information about the API." }, { "name": "migrations", "description": "Move projects to or from GitHub." }, { "name": "oidc", "description": "Endpoints to manage GitHub OIDC configuration using the REST API." }, { "name": "orgs", "description": "Interact with GitHub Orgs." }, { "name": "packages", "description": "Manage packages for authenticated users and organizations." }, { "name": "projects", "description": "Interact with GitHub Projects." }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." }, { "name": "rate-limit", "description": "Check your current rate limit status" }, { "name": "reactions", "description": "Interact with reactions to various GitHub entities." }, { "name": "repos", "description": "Interact with GitHub Repos." }, { "name": "search", "description": "Look for stuff on GitHub." }, { "name": "secret-scanning", "description": "Retrieve secret scanning alerts from a repository." }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", "description": "Interact with and view information about users and also current user." }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." }, { "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, { "name": "security-advisories", "description": "Manage security advisories." }, { "name": "interactions", "description": "Owner or admin management of users interactions." }, { "name": "classroom", "description": "Interact with GitHub Classroom." }, { "name": "desktop", "description": "Desktop specific endpoints." }, { "name": "enterprise-teams", "description": "Endpoints to manage GitHub Enterprise Teams." }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." }, { "name": "private-registries", "description": "Manage private registry configurations." }, { "name": "hosted-compute", "description": "Manage hosted compute networking resources." } ], "servers": [ { "url": "https://api.github.com" } ], "externalDocs": { "description": "GitHub v3 REST API", "url": "https://docs.github.com/rest/" }, "paths": { "/": { "get": { "summary": "GitHub API Root", "description": "Get Hypermedia links to resources accessible in GitHub's REST API", "tags": [ "meta" ], "operationId": "meta/root", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "current_user_url": { "type": "string", "format": "uri-template" }, "current_user_authorizations_html_url": { "type": "string", "format": "uri-template" }, "authorizations_url": { "type": "string", "format": "uri-template" }, "code_search_url": { "type": "string", "format": "uri-template" }, "commit_search_url": { "type": "string", "format": "uri-template" }, "emails_url": { "type": "string", "format": "uri-template" }, "emojis_url": { "type": "string", "format": "uri-template" }, "events_url": { "type": "string", "format": "uri-template" }, "feeds_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri-template" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "hub_url": { "type": "string", "format": "uri-template", "deprecated": true }, "issue_search_url": { "type": "string", "format": "uri-template" }, "issues_url": { "type": "string", "format": "uri-template" }, "keys_url": { "type": "string", "format": "uri-template" }, "label_search_url": { "type": "string", "format": "uri-template" }, "notifications_url": { "type": "string", "format": "uri-template" }, "organization_url": { "type": "string", "format": "uri-template" }, "organization_repositories_url": { "type": "string", "format": "uri-template" }, "organization_teams_url": { "type": "string", "format": "uri-template" }, "public_gists_url": { "type": "string", "format": "uri-template" }, "rate_limit_url": { "type": "string", "format": "uri-template" }, "repository_url": { "type": "string", "format": "uri-template" }, "repository_search_url": { "type": "string", "format": "uri-template" }, "current_user_repositories_url": { "type": "string", "format": "uri-template" }, "starred_url": { "type": "string", "format": "uri-template" }, "starred_gists_url": { "type": "string", "format": "uri-template" }, "topic_search_url": { "type": "string", "format": "uri-template" }, "user_url": { "type": "string", "format": "uri-template" }, "user_organizations_url": { "type": "string", "format": "uri-template" }, "user_repositories_url": { "type": "string", "format": "uri-template" }, "user_search_url": { "type": "string", "format": "uri-template" } }, "required": [ "current_user_url", "current_user_authorizations_html_url", "authorizations_url", "code_search_url", "commit_search_url", "emails_url", "emojis_url", "events_url", "feeds_url", "followers_url", "following_url", "gists_url", "issue_search_url", "issues_url", "keys_url", "label_search_url", "notifications_url", "organization_url", "organization_repositories_url", "organization_teams_url", "public_gists_url", "rate_limit_url", "repository_url", "repository_search_url", "current_user_repositories_url", "starred_url", "starred_gists_url", "user_url", "user_organizations_url", "user_repositories_url", "user_search_url" ] }, "examples": { "default": { "value": { "current_user_url": "https://api.github.com/user", "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}", "authorizations_url": "https://api.github.com/authorizations", "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}", "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}", "emails_url": "https://api.github.com/user/emails", "emojis_url": "https://api.github.com/emojis", "events_url": "https://api.github.com/events", "feeds_url": "https://api.github.com/feeds", "followers_url": "https://api.github.com/user/followers", "following_url": "https://api.github.com/user/following{/target}", "gists_url": "https://api.github.com/gists{/gist_id}", "hub_url": "https://api.github.com/hub", "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}", "issues_url": "https://api.github.com/issues", "keys_url": "https://api.github.com/user/keys", "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}", "notifications_url": "https://api.github.com/notifications", "organization_url": "https://api.github.com/orgs/{org}", "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}", "organization_teams_url": "https://api.github.com/orgs/{org}/teams", "public_gists_url": "https://api.github.com/gists/public", "rate_limit_url": "https://api.github.com/rate_limit", "repository_url": "https://api.github.com/repos/{owner}/{repo}", "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}", "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}", "starred_url": "https://api.github.com/user/starred{/owner}{/repo}", "starred_gists_url": "https://api.github.com/gists/starred", "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}", "user_url": "https://api.github.com/users/{user}", "user_organizations_url": "https://api.github.com/user/orgs", "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}", "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "meta", "subcategory": "meta" }, "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/meta/meta#github-api-root" } } }, "/advisories": { "get": { "summary": "List global security advisories", "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", "tags": [ "security-advisories" ], "operationId": "security-advisories/list-global-advisories", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories" }, "parameters": [ { "name": "ghsa_id", "in": "query", "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.", "schema": { "type": "string", "enum": [ "reviewed", "malware", "unreviewed" ], "default": "reviewed" } }, { "name": "cve_id", "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.", "in": "query", "schema": { "type": "string" } }, { "name": "ecosystem", "in": "query", "description": "If specified, only advisories for these ecosystems will be returned.", "schema": { "type": "string", "description": "The package's language or package management ecosystem.", "enum": [ "rubygems", "npm", "pip", "maven", "nuget", "composer", "go", "rust", "erlang", "actions", "pub", "other", "swift" ] } }, { "name": "severity", "in": "query", "description": "If specified, only advisories with these severities will be returned.", "schema": { "type": "string", "enum": [ "unknown", "low", "medium", "high", "critical" ] } }, { "name": "cwes", "in": "query", "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`", "schema": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "is_withdrawn", "in": "query", "description": "Whether to only return advisories that have been withdrawn.", "schema": { "type": "boolean" } }, { "name": "affects", "in": "query", "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", "schema": { "oneOf": [ { "type": "string" }, { "type": "array", "maxItems": 1000, "items": { "type": "string" } } ] } }, { "name": "published", "in": "query", "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { "type": "string" } }, { "name": "modified", "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "in": "query", "schema": { "type": "string" } }, { "name": "epss_percentage", "in": "query", "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", "schema": { "type": "string" } }, { "name": "epss_percentile", "in": "query", "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", "schema": { "type": "string" } }, { "name": "before", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "direction", "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } }, { "name": "sort", "description": "The property to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "updated", "published", "epss_percentage", "epss_percentile" ], "default": "published" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "A GitHub Security Advisory.", "type": "object", "properties": { "ghsa_id": { "type": "string", "description": "The GitHub Security Advisory ID.", "readOnly": true }, "cve_id": { "type": "string", "description": "The Common Vulnerabilities and Exposures (CVE) ID.", "nullable": true, "readOnly": true }, "url": { "type": "string", "description": "The API URL for the advisory.", "readOnly": true }, "html_url": { "type": "string", "format": "uri", "description": "The URL for the advisory.", "readOnly": true }, "repository_advisory_url": { "type": "string", "format": "uri", "description": "The API URL for the repository advisory.", "readOnly": true, "nullable": true }, "summary": { "type": "string", "description": "A short summary of the advisory.", "maxLength": 1024 }, "description": { "type": "string", "description": "A detailed description of what the advisory entails.", "maxLength": 65535, "nullable": true }, "type": { "type": "string", "description": "The type of advisory.", "readOnly": true, "enum": [ "reviewed", "unreviewed", "malware" ] }, "severity": { "type": "string", "description": "The severity of the advisory.", "enum": [ "critical", "high", "medium", "low", "unknown" ] }, "source_code_location": { "type": "string", "format": "uri", "description": "The URL of the advisory's source code.", "nullable": true }, "identifiers": { "type": "array", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of identifier.", "enum": [ "CVE", "GHSA" ] }, "value": { "type": "string", "description": "The identifier value." } }, "required": [ "type", "value" ] } }, "references": { "type": "array", "nullable": true, "items": { "type": "string", "description": "URLs with more information regarding the advisory." } }, "published_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was published, in ISO 8601 format.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", "readOnly": true }, "github_reviewed_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", "readOnly": true, "nullable": true }, "nvd_published_at": { "type": "string", "format": "date-time", "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", "readOnly": true, "nullable": true }, "withdrawn_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", "readOnly": true, "nullable": true }, "vulnerabilities": { "type": "array", "description": "The products and respective version ranges affected by the advisory.", "nullable": true, "items": { "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", "type": "object", "properties": { "package": { "description": "The name of the package affected by the vulnerability.", "type": "object", "nullable": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "enum": [ "rubygems", "npm", "pip", "maven", "nuget", "composer", "go", "rust", "erlang", "actions", "pub", "other", "swift" ] }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "nullable": true } }, "required": [ "ecosystem", "name" ] }, "vulnerable_version_range": { "type": "string", "description": "The range of the package versions affected by the vulnerability.", "nullable": true }, "first_patched_version": { "type": "string", "description": "The package version that resolves the vulnerability.", "nullable": true }, "vulnerable_functions": { "type": "array", "description": "The functions in the package that are affected by the vulnerability.", "nullable": true, "readOnly": true, "items": { "type": "string" } } }, "required": [ "package", "vulnerable_version_range", "first_patched_version", "vulnerable_functions" ] } }, "cvss": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS vector.", "nullable": true }, "score": { "type": "number", "description": "The CVSS score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_severities": { "type": "object", "nullable": true, "properties": { "cvss_v3": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 3 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 3 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_v4": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 4 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 4 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] } } }, "epss": { "type": "object", "nullable": true, "readOnly": true, "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", "properties": { "percentage": { "type": "number", "minimum": 0, "maximum": 100 }, "percentile": { "type": "number", "minimum": 0, "maximum": 100 } } }, "cwes": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "cwe_id": { "type": "string", "description": "The Common Weakness Enumeration (CWE) identifier." }, "name": { "type": "string", "description": "The name of the CWE.", "readOnly": true } }, "required": [ "cwe_id", "name" ] } }, "credits": { "type": "array", "description": "The users who contributed to the advisory.", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ] }, "type": { "type": "string", "description": "The type of credit the user is receiving.", "enum": [ "analyst", "finder", "reporter", "coordinator", "remediation_developer", "remediation_reviewer", "remediation_verifier", "tool", "sponsor", "other" ] } }, "required": [ "user", "type" ] } } }, "required": [ "ghsa_id", "cve_id", "url", "html_url", "repository_advisory_url", "summary", "description", "type", "severity", "source_code_location", "identifiers", "references", "published_at", "updated_at", "github_reviewed_at", "nvd_published_at", "withdrawn_at", "vulnerabilities", "cvss", "cwes", "credits" ], "additionalProperties": false } }, "examples": { "default": { "value": [ { "id": 1, "ghsa_id": "GHSA-abcd-1234-efgh", "cve_id": "CVE-2050-00000", "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", "summary": "Heartbleed security advisory", "description": "This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.", "type": "reviewed", "severity": "high", "source_code_location": "https://github.com/project/a-package", "identifiers": [ { "type": "GHSA", "value": "GHSA-abcd-1234-efgh" }, { "type": "CVE", "value": "CVE-2050-00000" } ], "references": [ "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" ], "published_at": "2023-03-23T02:30:56Z", "updated_at": "2023-03-24T02:30:56Z", "github_reviewed_at": "2023-03-23T02:30:56Z", "nvd_published_at": "2023-03-25T02:30:56Z", "withdrawn_at": null, "vulnerabilities": [ { "package": { "ecosystem": "npm", "name": "a-package" }, "first_patched_version": "1.0.3", "vulnerable_version_range": "<=1.0.2", "vulnerable_functions": [ "a_function" ] } ], "cvss": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, "cvss_v4": { "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", "score": 9.3 } }, "cwes": [ { "cwe_id": "CWE-400", "name": "Uncontrolled Resource Consumption" } ], "epss": [ { "percentage": 0.00045, "percentile": "0.16001e0" } ], "credits": [ { "user": { "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 }, "type": "analyst" } ] } ] } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "security-advisories", "subcategory": "global-advisories" } } }, "/advisories/{ghsa_id}": { "get": { "summary": "Get a global security advisory", "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", "tags": [ "security-advisories" ], "operationId": "security-advisories/get-global-advisory", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory" }, "parameters": [ { "name": "ghsa_id", "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "description": "A GitHub Security Advisory.", "type": "object", "properties": { "ghsa_id": { "type": "string", "description": "The GitHub Security Advisory ID.", "readOnly": true }, "cve_id": { "type": "string", "description": "The Common Vulnerabilities and Exposures (CVE) ID.", "nullable": true, "readOnly": true }, "url": { "type": "string", "description": "The API URL for the advisory.", "readOnly": true }, "html_url": { "type": "string", "format": "uri", "description": "The URL for the advisory.", "readOnly": true }, "repository_advisory_url": { "type": "string", "format": "uri", "description": "The API URL for the repository advisory.", "readOnly": true, "nullable": true }, "summary": { "type": "string", "description": "A short summary of the advisory.", "maxLength": 1024 }, "description": { "type": "string", "description": "A detailed description of what the advisory entails.", "maxLength": 65535, "nullable": true }, "type": { "type": "string", "description": "The type of advisory.", "readOnly": true, "enum": [ "reviewed", "unreviewed", "malware" ] }, "severity": { "type": "string", "description": "The severity of the advisory.", "enum": [ "critical", "high", "medium", "low", "unknown" ] }, "source_code_location": { "type": "string", "format": "uri", "description": "The URL of the advisory's source code.", "nullable": true }, "identifiers": { "type": "array", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of identifier.", "enum": [ "CVE", "GHSA" ] }, "value": { "type": "string", "description": "The identifier value." } }, "required": [ "type", "value" ] } }, "references": { "type": "array", "nullable": true, "items": { "type": "string", "description": "URLs with more information regarding the advisory." } }, "published_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was published, in ISO 8601 format.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", "readOnly": true }, "github_reviewed_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", "readOnly": true, "nullable": true }, "nvd_published_at": { "type": "string", "format": "date-time", "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", "readOnly": true, "nullable": true }, "withdrawn_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", "readOnly": true, "nullable": true }, "vulnerabilities": { "type": "array", "description": "The products and respective version ranges affected by the advisory.", "nullable": true, "items": { "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", "type": "object", "properties": { "package": { "description": "The name of the package affected by the vulnerability.", "type": "object", "nullable": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "enum": [ "rubygems", "npm", "pip", "maven", "nuget", "composer", "go", "rust", "erlang", "actions", "pub", "other", "swift" ] }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "nullable": true } }, "required": [ "ecosystem", "name" ] }, "vulnerable_version_range": { "type": "string", "description": "The range of the package versions affected by the vulnerability.", "nullable": true }, "first_patched_version": { "type": "string", "description": "The package version that resolves the vulnerability.", "nullable": true }, "vulnerable_functions": { "type": "array", "description": "The functions in the package that are affected by the vulnerability.", "nullable": true, "readOnly": true, "items": { "type": "string" } } }, "required": [ "package", "vulnerable_version_range", "first_patched_version", "vulnerable_functions" ] } }, "cvss": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS vector.", "nullable": true }, "score": { "type": "number", "description": "The CVSS score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_severities": { "type": "object", "nullable": true, "properties": { "cvss_v3": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 3 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 3 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_v4": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 4 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 4 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] } } }, "epss": { "type": "object", "nullable": true, "readOnly": true, "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", "properties": { "percentage": { "type": "number", "minimum": 0, "maximum": 100 }, "percentile": { "type": "number", "minimum": 0, "maximum": 100 } } }, "cwes": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "cwe_id": { "type": "string", "description": "The Common Weakness Enumeration (CWE) identifier." }, "name": { "type": "string", "description": "The name of the CWE.", "readOnly": true } }, "required": [ "cwe_id", "name" ] } }, "credits": { "type": "array", "description": "The users who contributed to the advisory.", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ] }, "type": { "type": "string", "description": "The type of credit the user is receiving.", "enum": [ "analyst", "finder", "reporter", "coordinator", "remediation_developer", "remediation_reviewer", "remediation_verifier", "tool", "sponsor", "other" ] } }, "required": [ "user", "type" ] } } }, "required": [ "ghsa_id", "cve_id", "url", "html_url", "repository_advisory_url", "summary", "description", "type", "severity", "source_code_location", "identifiers", "references", "published_at", "updated_at", "github_reviewed_at", "nvd_published_at", "withdrawn_at", "vulnerabilities", "cvss", "cwes", "credits" ], "additionalProperties": false }, "examples": { "default": { "value": { "ghsa_id": "GHSA-abcd-1234-efgh", "cve_id": "CVE-2050-00000", "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", "summary": "A short summary of the advisory.", "description": "A detailed description of what the advisory entails.", "type": "reviewed", "severity": "high", "source_code_location": "https://github.com/project/a-package", "identifiers": [ { "type": "GHSA", "value": "GHSA-abcd-1234-efgh" }, { "type": "CVE", "value": "CVE-2050-00000" } ], "references": [ "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" ], "published_at": "2023-03-23T02:30:56Z", "updated_at": "2023-03-24T02:30:56Z", "github_reviewed_at": "2023-03-23T02:30:56Z", "nvd_published_at": "2023-03-25T02:30:56Z", "withdrawn_at": null, "vulnerabilities": [ { "package": { "ecosystem": "npm", "name": "a-package" }, "first_patched_version": "1.0.3", "vulnerable_version_range": "<=1.0.2", "vulnerable_functions": [ "a_function" ] } ], "cvss": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, "cvss_v4": { "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", "score": 9.3 } }, "cwes": [ { "cwe_id": "CWE-400", "name": "Uncontrolled Resource Consumption" } ], "credits": [ { "user": { "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 }, "type": "analyst" } ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "security-advisories", "subcategory": "global-advisories" } } }, "/app": { "get": { "summary": "Get the authenticated app", "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-authenticated", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#get-the-authenticated-app" }, "parameters": [ ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "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" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app", "example": 5, "type": "integer" }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" }, "webhook_secret": { "type": "string", "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"", "nullable": true }, "pem": { "type": "string", "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "examples": { "default": { "value": { "id": 1, "slug": "octoapp", "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "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 }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" } } }, "/app-manifests/{code}/conversions": { "post": { "summary": "Create a GitHub App from a manifest", "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", "tags": [ "apps" ], "operationId": "apps/create-from-manifest", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest" }, "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "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" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app", "example": 5, "type": "integer" }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" }, "webhook_secret": { "type": "string", "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"", "nullable": true }, "pem": { "type": "string", "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, { "type": "object", "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "webhook_secret": { "type": "string", "nullable": true }, "pem": { "type": "string" } }, "required": [ "client_id", "client_secret", "webhook_secret", "pem" ], "additionalProperties": true } ] }, "examples": { "default": { "value": { "id": 1, "slug": "octoapp", "node_id": "MDxOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "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", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ], "client_id": "Iv1.8a61f9b3a7aba766", "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8", "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa", "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" } } }, "/app/hook/config": { "get": { "summary": "Get a webhook configuration for an app", "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-config-for-app", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "example": "\"0\"" }, { "type": "number" } ] } } }, "examples": { "default": { "value": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" } }, "patch": { "summary": "Update a webhook configuration for an app", "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/update-webhook-config-for-app", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "example": "\"0\"" }, { "type": "number" } ] } } }, "examples": { "default": { "value": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, "secret": { "type": "string", "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "example": "\"0\"" }, { "type": "number" } ] } } }, "examples": { "default": { "value": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" } } }, "/app/hook/deliveries": { "get": { "summary": "List deliveries for an app webhook", "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "cursor", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple webhook delivery", "description": "Delivery made by a webhook, without request and response information.", "type": "object", "properties": { "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", "example": 42 }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" }, "delivered_at": { "description": "Time when the webhook delivery occurred.", "type": "string", "format": "date-time", "example": "2021-05-12T20:33:44Z" }, "redelivery": { "description": "Whether the webhook delivery is a redelivery.", "type": "boolean", "example": false }, "duration": { "description": "Time spent delivering.", "type": "number", "example": 0.03 }, "status": { "description": "Describes the response returned after attempting the delivery.", "type": "string", "example": "failed to connect" }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "example": 502 }, "event": { "description": "The event that triggered the delivery.", "type": "string", "example": "issues" }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": "string", "example": "opened", "nullable": true }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", "example": 123, "nullable": true }, "throttled_at": { "description": "Time when the webhook delivery was throttled.", "type": "string", "format": "date-time", "example": "2021-05-12T20:33:44Z", "nullable": true } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id" ] } }, "examples": { "default": { "value": [ { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "throttled_at": "2019-06-03T00:57:16Z" }, { "id": 123456789, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-04T00:57:16Z", "redelivery": true, "duration": 0.28, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "throttled_at": null } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" } } }, "/app/hook/deliveries/{delivery_id}": { "get": { "summary": "Get a delivery for an app webhook", "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-delivery", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" }, "parameters": [ { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Webhook delivery", "description": "Delivery made by a webhook.", "type": "object", "properties": { "id": { "description": "Unique identifier of the delivery.", "type": "integer", "example": 42 }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" }, "delivered_at": { "description": "Time when the delivery was delivered.", "type": "string", "format": "date-time", "example": "2021-05-12T20:33:44Z" }, "redelivery": { "description": "Whether the delivery is a redelivery.", "type": "boolean", "example": false }, "duration": { "description": "Time spent delivering.", "type": "number", "example": 0.03 }, "status": { "description": "Description of the status of the attempted delivery", "type": "string", "example": "failed to connect" }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "example": 502 }, "event": { "description": "The event that triggered the delivery.", "type": "string", "example": "issues" }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": "string", "example": "opened", "nullable": true }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", "example": 123, "nullable": true }, "throttled_at": { "description": "Time when the webhook delivery was throttled.", "type": "string", "format": "date-time", "example": "2021-05-12T20:33:44Z", "nullable": true }, "url": { "description": "The URL target of the delivery.", "type": "string", "example": "https://www.example.com" }, "request": { "type": "object", "properties": { "headers": { "description": "The request headers sent with the webhook delivery.", "type": "object", "nullable": true, "additionalProperties": true }, "payload": { "description": "The webhook payload.", "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "headers", "payload" ] }, "response": { "type": "object", "properties": { "headers": { "description": "The response headers received when the delivery was made.", "type": "object", "nullable": true, "additionalProperties": true }, "payload": { "description": "The response payload received.", "type": "string", "nullable": true, "additionalProperties": true } }, "required": [ "headers", "payload" ] } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id", "request", "response" ] }, "examples": { "default": { "value": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", "throttled_at": "2019-06-03T00:57:16Z", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "Accept": "*/*", "X-GitHub-Hook-ID": "42", "User-Agent": "GitHub-Hookshot/b8c71d8", "X-GitHub-Event": "issues", "X-GitHub-Hook-Installation-Target-ID": "123", "X-GitHub-Hook-Installation-Target-Type": "repository", "content-type": "application/json", "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" }, "payload": { "action": "opened", "issue": { "body": "foo" }, "repository": { "id": 123 } } }, "response": { "headers": { "Content-Type": "text/html;charset=utf-8" }, "payload": "ok" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" } } }, "/app/hook/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an app webhook", "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" }, "parameters": [ { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "default": { "value": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" } } }, "/app/installation-requests": { "get": { "summary": "List installation requests for the authenticated app", "description": "Lists all the pending installation requests for the authenticated GitHub App.", "tags": [ "apps" ], "operationId": "apps/list-installation-requests-for-authenticated-app", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/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](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "List of integration installation requests", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Integration Installation Request", "description": "Request to install an integration on a target", "type": "object", "properties": { "id": { "description": "Unique identifier of the request installation.", "type": "integer", "example": 42 }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "account": { "anyOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "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" ] } ] }, "requester": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ] }, "created_at": { "type": "string", "format": "date-time", "example": "2022-07-08T16:18:44-04:00" } }, "required": [ "id", "account", "requester", "created_at" ] } }, "examples": { "exampleKey1": { "value": [ { "id": 25381, "node_id": "MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA==", "account": { "login": "octo-org", "id": 6811672, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octo-org", "html_url": "https://github.com/octo-org", "followers_url": "https://api.github.com/users/octo-org/followers", "following_url": "https://api.github.com/users/octo-org/following{/other_user}", "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", "organizations_url": "https://api.github.com/users/octo-org/orgs", "repos_url": "https://api.github.com/users/octo-org/repos", "events_url": "https://api.github.com/users/octo-org/events{/privacy}", "received_events_url": "https://api.github.com/users/octo-org/received_events", "type": "Organization", "site_admin": false }, "requester": { "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 }, "created_at": "2022-07-08T16:18:44-04:00" } ] } } } } }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" } } }, "/app/installations": { "get": { "summary": "List installations for the authenticated app", "description": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-installations", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/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](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "since", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "outdated", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The permissions the installation has are included under the `permissions` key.", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "example": 1 }, "account": { "nullable": true, "anyOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "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" ] } ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "access_tokens_url": { "type": "string", "format": "uri", "example": "https://api.github.com/app/installations/1/access_tokens" }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/installation/repositories" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/organizations/github/settings/installations/1" }, "app_id": { "type": "integer", "example": 1 }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "example": "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 leve 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", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "app_slug": { "type": "string", "example": "github-actions" }, "suspended_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ], "nullable": true }, "suspended_at": { "type": "string", "format": "date-time", "nullable": true }, "contact_email": { "type": "string", "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", "nullable": true } }, "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" ] } }, "examples": { "default": { "value": [ { "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 } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" } } }, "/app/installations/{installation_id}": { "get": { "summary": "Get an installation for the authenticated app", "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-installation", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "example": 1 }, "account": { "nullable": true, "anyOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "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" ] } ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "access_tokens_url": { "type": "string", "format": "uri", "example": "https://api.github.com/app/installations/1/access_tokens" }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/installation/repositories" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/organizations/github/settings/installations/1" }, "app_id": { "type": "integer", "example": 1 }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "example": "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 leve 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", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "app_slug": { "type": "string", "example": "github-actions" }, "suspended_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ], "nullable": true }, "suspended_at": { "type": "string", "format": "date-time", "nullable": true }, "contact_email": { "type": "string", "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", "nullable": true } }, "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" ] }, "examples": { "default": { "value": { "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 } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" } }, "delete": { "summary": "Delete an installation for the authenticated app", "description": "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](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/delete-installation", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "responses": { "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" } } }, "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", "description": "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.\n\nOptionally, 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.\n\nOptionally, 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.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/create-installation-access-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "repositories": { "description": "List of repository names that the token should have access to", "type": "array", "items": { "type": "string", "example": "rails" } }, "repository_ids": { "description": "List of repository IDs that the token should have access to", "example": [ 1 ], "type": "array", "items": { "type": "integer" } }, "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 leve 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" } } } }, "examples": { "default": { "value": { "repositories": [ "Hello-World" ], "permissions": { "issues": "write", "contents": "read" } } } } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "title": "Installation Token", "description": "Authentication token for a GitHub App installed on a user or org.", "type": "object", "properties": { "token": { "type": "string" }, "expires_at": { "type": "string" }, "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 leve 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" } }, "repository_selection": { "type": "string", "enum": [ "all", "selected" ] }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": "string", "example": "README.md" }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] } }, "required": [ "token", "expires_at" ] }, "examples": { "default": { "value": { "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", "expires_at": "2016-07-11T22:14:10Z", "permissions": { "issues": "write", "contents": "read" }, "repository_selection": "selected", "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "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 }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" } } }, "/app/installations/{installation_id}/suspended": { "put": { "summary": "Suspend an app installation", "description": "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.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/suspend-installation", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#suspend-an-app-installation" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "responses": { "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" } }, "delete": { "summary": "Unsuspend an app installation", "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/unsuspend-installation", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "responses": { "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" } } }, "/applications/{client_id}/grant": { "delete": { "summary": "Delete an app authorization", "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "operationId": "apps/delete-authorization", "tags": [ "apps" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } }, "required": [ "access_token" ] }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" } } } } } }, "responses": { "204": { "description": "Response" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "oauth-applications" } } }, "/applications/{client_id}/token": { "post": { "summary": "Check a token", "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/check-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/oauth-applications#check-a-token" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "access_token": { "description": "The access_token of the OAuth or GitHub application.", "type": "string" } }, "required": [ "access_token" ], "type": "object" }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Authorization", "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string", "format": "uri" }, "scopes": { "description": "A list of scopes that this authorization is in.", "type": "array", "items": { "type": "string" }, "nullable": true }, "token": { "type": "string" }, "token_last_eight": { "type": "string", "nullable": true }, "hashed_token": { "type": "string", "nullable": true }, "app": { "type": "object", "properties": { "client_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "client_id", "name", "url" ] }, "note": { "type": "string", "nullable": true }, "note_url": { "type": "string", "format": "uri", "nullable": true }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ], "nullable": true }, "installation": { "title": "Scoped Installation", "type": "object", "properties": { "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 leve 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" } }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "single_file_name": { "type": "string", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "account": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ] } }, "required": [ "permissions", "repository_selection", "single_file_name", "repositories_url", "account" ], "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "app", "id", "note", "note_url", "scopes", "token", "hashed_token", "token_last_eight", "fingerprint", "url", "created_at", "updated_at", "expires_at" ] }, "examples": { "default": { "value": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo", "user" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "Iv1.8a61f9b3a7aba766" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "fingerprint": "jklmnop12345678", "expires_at": "2011-09-08T17:26:27Z", "user": { "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 } } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "oauth-applications" } }, "patch": { "summary": "Reset a token", "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/reset-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/oauth-applications#reset-a-token" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "access_token": { "description": "The access_token of the OAuth or GitHub application.", "type": "string" } }, "required": [ "access_token" ], "type": "object" }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Authorization", "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string", "format": "uri" }, "scopes": { "description": "A list of scopes that this authorization is in.", "type": "array", "items": { "type": "string" }, "nullable": true }, "token": { "type": "string" }, "token_last_eight": { "type": "string", "nullable": true }, "hashed_token": { "type": "string", "nullable": true }, "app": { "type": "object", "properties": { "client_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "client_id", "name", "url" ] }, "note": { "type": "string", "nullable": true }, "note_url": { "type": "string", "format": "uri", "nullable": true }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ], "nullable": true }, "installation": { "title": "Scoped Installation", "type": "object", "properties": { "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 leve 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" } }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "single_file_name": { "type": "string", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "account": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ] } }, "required": [ "permissions", "repository_selection", "single_file_name", "repositories_url", "account" ], "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "app", "id", "note", "note_url", "scopes", "token", "hashed_token", "token_last_eight", "fingerprint", "url", "created_at", "updated_at", "expires_at" ] }, "examples": { "default": { "value": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo", "user" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "Iv1.8a61f9b3a7aba766" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "fingerprint": "jklmnop12345678", "expires_at": "2011-09-08T17:26:27Z", "user": { "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 } } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "oauth-applications" } }, "delete": { "summary": "Delete an app token", "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", "tags": [ "apps" ], "operationId": "apps/delete-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } }, "required": [ "access_token" ] }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" } } } } } }, "responses": { "204": { "description": "Response" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "oauth-applications" } } }, "/applications/{client_id}/token/scoped": { "post": { "summary": "Create a scoped access token", "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/scope-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#create-a-scoped-access-token" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The access token used to authenticate to the GitHub API.", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a" }, "target": { "description": "The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified.", "type": "string", "example": "octocat" }, "target_id": { "description": "The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified.", "example": 1, "type": "integer" }, "repositories": { "description": "The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified.", "type": "array", "items": { "type": "string", "example": "rails" } }, "repository_ids": { "description": "The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified.", "example": [ 1 ], "type": "array", "items": { "type": "integer" } }, "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 leve 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" } } }, "required": [ "access_token" ] }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", "target": "octocat", "permissions": { "metadata": "read", "issues": "write", "contents": "read" } } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Authorization", "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string", "format": "uri" }, "scopes": { "description": "A list of scopes that this authorization is in.", "type": "array", "items": { "type": "string" }, "nullable": true }, "token": { "type": "string" }, "token_last_eight": { "type": "string", "nullable": true }, "hashed_token": { "type": "string", "nullable": true }, "app": { "type": "object", "properties": { "client_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "client_id", "name", "url" ] }, "note": { "type": "string", "nullable": true }, "note_url": { "type": "string", "format": "uri", "nullable": true }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ], "nullable": true }, "installation": { "title": "Scoped Installation", "type": "object", "properties": { "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 leve 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" } }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "single_file_name": { "type": "string", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "account": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ] } }, "required": [ "permissions", "repository_selection", "single_file_name", "repositories_url", "account" ], "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "app", "id", "note", "note_url", "scopes", "token", "hashed_token", "token_last_eight", "fingerprint", "url", "created_at", "updated_at", "expires_at" ] }, "examples": { "default": { "value": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "Iv1.8a61f9b3a7aba766" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "fingerprint": "jklmnop12345678", "expires_at": "2011-09-08T17:26:27Z", "user": { "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 }, "installation": { "permissions": { "metadata": "read", "issues": "write", "contents": "read" }, "repository_selection": "selected", "single_file_name": ".github/workflow.yml", "repositories_url": "https://api.github.com/user/repos", "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 }, "has_multiple_single_files": false, "single_file_paths": [ ] } } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" } } }, "/apps/{app_slug}": { "get": { "summary": "Get an app", "description": "> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", "tags": [ "apps" ], "operationId": "apps/get-by-slug", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#get-an-app" }, "parameters": [ { "name": "app_slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "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" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app", "example": 5, "type": "integer" }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" }, "webhook_secret": { "type": "string", "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"", "nullable": true }, "pem": { "type": "string", "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "examples": { "default": { "value": { "id": 1, "slug": "octoapp", "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "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 }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" } } }, "/assignments/{assignment_id}": { "get": { "summary": "Get an assignment", "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" }, "parameters": [ { "name": "assignment_id", "description": "The unique identifier of the classroom assignment.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Classroom Assignment", "description": "A GitHub Classroom assignment", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository.", "type": "integer", "example": 42 }, "public_repo": { "description": "Whether an accepted assignment creates a public repository.", "type": "boolean", "example": true }, "title": { "description": "Assignment title.", "type": "string", "example": "Intro to Binaries" }, "type": { "description": "Whether it's a group assignment or individual assignment.", "type": "string", "example": "individual", "enum": [ "individual", "group" ] }, "invite_link": { "description": "The link that a student can use to accept the assignment.", "type": "string", "example": "https://classroom.github.com/a/Lx7jiUgx" }, "invitations_enabled": { "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", "type": "boolean", "example": true }, "slug": { "description": "Sluggified name of the assignment.", "type": "string", "example": "intro-to-binaries" }, "students_are_repo_admins": { "description": "Whether students are admins on created repository when a student accepts the assignment.", "type": "boolean", "example": true }, "feedback_pull_requests_enabled": { "description": "Whether feedback pull request will be created when a student accepts the assignment.", "type": "boolean", "example": true }, "max_teams": { "description": "The maximum allowable teams for the assignment.", "nullable": true, "type": "integer", "example": 0 }, "max_members": { "description": "The maximum allowable members per team.", "nullable": true, "type": "integer", "example": 0 }, "editor": { "description": "The selected editor for the assignment.", "type": "string", "example": "codespaces" }, "accepted": { "description": "The number of students that have accepted the assignment.", "type": "integer", "example": 25 }, "submitted": { "description": "The number of students that have submitted the assignment.", "type": "integer", "example": 10 }, "passing": { "description": "The number of students that have passed the assignment.", "type": "integer", "example": 10 }, "language": { "description": "The programming language used in the assignment.", "type": "string", "example": "elixir" }, "deadline": { "description": "The time at which the assignment is due.", "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "starter_code_repository": { "title": "Simple Classroom Repository", "description": "A GitHub repository view for Classroom", "type": "object", "properties": { "id": { "type": "integer", "example": 1296269, "description": "A unique identifier of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique name of the repository." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "default_branch": { "type": "string", "example": "main", "description": "The default branch for the repository." } }, "required": [ "id", "full_name", "html_url", "node_id", "private", "default_branch" ] }, "classroom": { "title": "Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Whether classroom is archived.", "type": "boolean", "example": false }, "organization": { "title": "Organization Simple for Classroom", "description": "A GitHub organization.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "login": { "type": "string", "example": "github" }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/github" }, "name": { "type": "string", "example": "Github - Code thigns happen here", "nullable": true }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" } }, "required": [ "id", "login", "node_id", "html_url", "name", "avatar_url" ] }, "url": { "description": "The URL of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "organization", "url" ] } }, "required": [ "id", "public_repo", "title", "type", "invite_link", "invitations_enabled", "slug", "students_are_repo_admins", "feedback_pull_requests_enabled", "max_teams", "max_members", "editor", "accepted", "submitted", "passing", "language", "deadline", "starter_code_repository", "classroom" ] }, "examples": { "default": { "value": { "id": "12,", "public_repo": "false,", "title": "Intro to Binaries", "type": "individual", "invite_link": "https://classroom.github.com/a/Lx7jiUgx", "invitations_enabled": "true,", "slug": "intro-to-binaries", "students_are_repo_admins": false, "feedback_pull_requests_enabled": true, "max_teams": 0, "max_members": 0, "editor": "codespaces", "accepted": 100, "submitted": 40, "passing": 10, "language": "ruby", "deadline": "2011-01-26T19:06:43Z", "stater_code_repository": { "id": 1296269, "full_name": "octocat/Hello-World", "html_url": "https://github.com/octocat/Hello-World", "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "private": false, "default_branch": "main" }, "classroom": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" } } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { "summary": "List accepted assignments for an assignment", "description": "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.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" }, "parameters": [ { "name": "assignment_id", "description": "The unique identifier of the classroom assignment.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Classroom Accepted Assignment", "description": "A GitHub Classroom accepted assignment", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository.", "type": "integer", "example": 42 }, "submitted": { "description": "Whether an accepted assignment has been submitted.", "type": "boolean", "example": true }, "passing": { "description": "Whether a submission passed.", "type": "boolean", "example": true }, "commit_count": { "description": "Count of student commits.", "type": "integer", "example": 5 }, "grade": { "description": "Most recent grade.", "type": "string", "example": "10/10" }, "students": { "type": "array", "items": { "title": "Simple Classroom User", "description": "A GitHub user simplified for Classroom.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "login": { "type": "string", "example": "octocat" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" } }, "required": [ "id", "login", "avatar_url", "html_url" ] } }, "repository": { "title": "Simple Classroom Repository", "description": "A GitHub repository view for Classroom", "type": "object", "properties": { "id": { "type": "integer", "example": 1296269, "description": "A unique identifier of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique name of the repository." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "default_branch": { "type": "string", "example": "main", "description": "The default branch for the repository." } }, "required": [ "id", "full_name", "html_url", "node_id", "private", "default_branch" ] }, "assignment": { "title": "Simple Classroom Assignment", "description": "A GitHub Classroom assignment", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository.", "type": "integer", "example": 42 }, "public_repo": { "description": "Whether an accepted assignment creates a public repository.", "type": "boolean", "example": true }, "title": { "description": "Assignment title.", "type": "string", "example": "Intro to Binaries" }, "type": { "description": "Whether it's a Group Assignment or Individual Assignment.", "type": "string", "example": "individual", "enum": [ "individual", "group" ] }, "invite_link": { "description": "The link that a student can use to accept the assignment.", "type": "string", "example": "https://classroom.github.com/a/Lx7jiUgx" }, "invitations_enabled": { "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", "type": "boolean", "example": true }, "slug": { "description": "Sluggified name of the assignment.", "type": "string", "example": "intro-to-binaries" }, "students_are_repo_admins": { "description": "Whether students are admins on created repository on accepted assignment.", "type": "boolean", "example": true }, "feedback_pull_requests_enabled": { "description": "Whether feedback pull request will be created on assignment acceptance.", "type": "boolean", "example": true }, "max_teams": { "description": "The maximum allowable teams for the assignment.", "nullable": true, "type": "integer", "example": 0 }, "max_members": { "description": "The maximum allowable members per team.", "nullable": true, "type": "integer", "example": 0 }, "editor": { "description": "The selected editor for the assignment.", "type": "string", "example": "codespaces" }, "accepted": { "description": "The number of students that have accepted the assignment.", "type": "integer", "example": 25 }, "submitted": { "description": "The number of students that have submitted the assignment.", "type": "integer", "example": 10 }, "passing": { "description": "The number of students that have passed the assignment.", "type": "integer", "example": 10 }, "language": { "description": "The programming language used in the assignment.", "type": "string", "example": "elixir" }, "deadline": { "description": "The time at which the assignment is due.", "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "classroom": { "title": "Simple Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Returns whether classroom is archived or not.", "type": "boolean", "example": false }, "url": { "description": "The url of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "url" ] } }, "required": [ "id", "public_repo", "title", "type", "invite_link", "invitations_enabled", "slug", "students_are_repo_admins", "feedback_pull_requests_enabled", "editor", "accepted", "submitted", "passing", "language", "deadline", "classroom" ] } }, "required": [ "id", "submitted", "passing", "commit_count", "grade", "students", "repository", "assignment" ] } }, "examples": { "default": { "value": { "id": "12,", "submitted": "false,", "passing": "false,", "commit_count": 5, "grade": "5/10", "students": [ { "id": 1, "login": "octocat", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "html_url": "https://github.com/octocat" } ], "repository": { "id": 1296269, "full_name": "octocat/Hello-World", "html_url": "https://github.com/octocat/Hello-World", "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "private": false, "default_branch": "main" }, "assignment": { "id": "12,", "public_repo": "false,", "title": "Intro to Binaries", "type": "individual", "invite_link": "https://classroom.github.com/a/Lx7jiUgx", "invitations_enabled": "true,", "slug": "intro-to-binaries", "students_are_repo_admins": false, "feedback_pull_requests_enabled": true, "max_teams": 0, "max_members": 0, "editor": "codespaces", "accepted": 100, "submitted": 40, "passing": 10, "language": "ruby", "classroom": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" } } }, "/assignments/{assignment_id}/grades": { "get": { "summary": "Get assignment grades", "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" }, "parameters": [ { "name": "assignment_id", "description": "The unique identifier of the classroom assignment.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Classroom Assignment Grade", "description": "Grade for a student or groups GitHub Classroom assignment", "type": "object", "properties": { "assignment_name": { "description": "Name of the assignment", "type": "string" }, "assignment_url": { "description": "URL of the assignment", "type": "string" }, "starter_code_url": { "description": "URL of the starter code for the assignment", "type": "string" }, "github_username": { "description": "GitHub username of the student", "type": "string" }, "roster_identifier": { "description": "Roster identifier of the student", "type": "string" }, "student_repository_name": { "description": "Name of the student's assignment repository", "type": "string" }, "student_repository_url": { "description": "URL of the student's assignment repository", "type": "string" }, "submission_timestamp": { "description": "Timestamp of the student's assignment submission", "type": "string" }, "points_awarded": { "description": "Number of points awarded to the student", "type": "integer" }, "points_available": { "description": "Number of points available for the assignment", "type": "integer" }, "group_name": { "description": "If a group assignment, name of the group the student is in", "type": "string" } }, "required": [ "assignment_name", "assignment_url", "starter_code_url", "github_username", "roster_identifier", "student_repository_name", "student_repository_url", "submission_timestamp", "points_awarded", "points_available" ] } }, "examples": { "default": { "value": [ { "assignment_name": "Introduction to Strings", "assignment_url": "https://classroom.github.com/classrooms/1337/assignments/1337", "starter_code_url": "", "github_username": "octocat", "roster_identifier": "octocat@github.com", "student_repository_name": "intro-to-strings-1337-octocat", "student_repository_url": "https://github.com/timeforschool/intro-to-strings-1337-octocat", "submission_timestamp": "2018-11-12 01:02", "points_awarded": 10, "points_available": 15, "group_name": "octocat-and-friends" }, { "assignment_name": "Introduction to Strings", "assignment_url": "https://classroom.github.com/classrooms/1337/assignments/1337", "starter_code_url": "", "github_username": "monalisa", "roster_identifier": "monalisa@github.com", "student_repository_name": "intro-to-strings-1337-monalisa", "student_repository_url": "https://github.com/timeforschool/intro-to-strings-1337-monalisa", "submission_timestamp": "2018-11-12 01:11", "points_awarded": 15, "points_available": 15, "group_name": "monalisa-and-friends" } ] } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" } } }, "/classrooms": { "get": { "summary": "List classrooms", "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" }, "parameters": [ { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Returns whether classroom is archived or not.", "type": "boolean", "example": false }, "url": { "description": "The url of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "url" ] } }, "examples": { "default": { "value": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" } } }, "/classrooms/{classroom_id}": { "get": { "summary": "Get a classroom", "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" }, "parameters": [ { "name": "classroom_id", "description": "The unique identifier of the classroom.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Whether classroom is archived.", "type": "boolean", "example": false }, "organization": { "title": "Organization Simple for Classroom", "description": "A GitHub organization.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "login": { "type": "string", "example": "github" }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/github" }, "name": { "type": "string", "example": "Github - Code thigns happen here", "nullable": true }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" } }, "required": [ "id", "login", "node_id", "html_url", "name", "avatar_url" ] }, "url": { "description": "The URL of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "organization", "url" ] }, "examples": { "default": { "value": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "organization": { "id": 1, "login": "programming-elixir", "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "html_url": "https://github.com/programming-elixir", "name": "Learn how to build fault tolerant applications", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4" }, "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" } } }, "/classrooms/{classroom_id}/assignments": { "get": { "summary": "List assignments for a classroom", "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" }, "parameters": [ { "name": "classroom_id", "description": "The unique identifier of the classroom.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple Classroom Assignment", "description": "A GitHub Classroom assignment", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository.", "type": "integer", "example": 42 }, "public_repo": { "description": "Whether an accepted assignment creates a public repository.", "type": "boolean", "example": true }, "title": { "description": "Assignment title.", "type": "string", "example": "Intro to Binaries" }, "type": { "description": "Whether it's a Group Assignment or Individual Assignment.", "type": "string", "example": "individual", "enum": [ "individual", "group" ] }, "invite_link": { "description": "The link that a student can use to accept the assignment.", "type": "string", "example": "https://classroom.github.com/a/Lx7jiUgx" }, "invitations_enabled": { "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", "type": "boolean", "example": true }, "slug": { "description": "Sluggified name of the assignment.", "type": "string", "example": "intro-to-binaries" }, "students_are_repo_admins": { "description": "Whether students are admins on created repository on accepted assignment.", "type": "boolean", "example": true }, "feedback_pull_requests_enabled": { "description": "Whether feedback pull request will be created on assignment acceptance.", "type": "boolean", "example": true }, "max_teams": { "description": "The maximum allowable teams for the assignment.", "nullable": true, "type": "integer", "example": 0 }, "max_members": { "description": "The maximum allowable members per team.", "nullable": true, "type": "integer", "example": 0 }, "editor": { "description": "The selected editor for the assignment.", "type": "string", "example": "codespaces" }, "accepted": { "description": "The number of students that have accepted the assignment.", "type": "integer", "example": 25 }, "submitted": { "description": "The number of students that have submitted the assignment.", "type": "integer", "example": 10 }, "passing": { "description": "The number of students that have passed the assignment.", "type": "integer", "example": 10 }, "language": { "description": "The programming language used in the assignment.", "type": "string", "example": "elixir" }, "deadline": { "description": "The time at which the assignment is due.", "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "classroom": { "title": "Simple Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Returns whether classroom is archived or not.", "type": "boolean", "example": false }, "url": { "description": "The url of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "url" ] } }, "required": [ "id", "public_repo", "title", "type", "invite_link", "invitations_enabled", "slug", "students_are_repo_admins", "feedback_pull_requests_enabled", "editor", "accepted", "submitted", "passing", "language", "deadline", "classroom" ] } }, "examples": { "default": { "value": { "id": "12,", "public_repo": "false,", "title": "Intro to Binaries", "type": "individual", "invite_link": "https://classroom.github.com/a/Lx7jiUgx", "invitations_enabled": "true,", "slug": "intro-to-binaries", "students_are_repo_admins": false, "feedback_pull_requests_enabled": true, "max_teams": 0, "max_members": 0, "editor": "codespaces", "accepted": 100, "submitted": 40, "passing": 10, "language": "ruby", "deadline": "2020-01-11T11:59:22Z", "classroom": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" } } }, "/codes_of_conduct": { "get": { "summary": "Get all codes of conduct", "description": "Returns array of all GitHub's codes of conduct.", "tags": [ "codes-of-conduct" ], "operationId": "codes-of-conduct/get-all-codes-of-conduct", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" }, "parameters": [ ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] } }, "examples": { "default": { "value": [ { "key": "citizen_code_of_conduct", "name": "Citizen Code of Conduct", "url": "https://api.github.com/codes_of_conduct/citizen_code_of_conduct", "html_url": "http://citizencodeofconduct.org/" }, { "key": "contributor_covenant", "name": "Contributor Covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant", "html_url": "https://www.contributor-covenant.org/version/2/0/code_of_conduct/" } ] } } } } }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "codes-of-conduct", "subcategory": "codes-of-conduct" } } }, "/codes_of_conduct/{key}": { "get": { "summary": "Get a code of conduct", "description": "Returns information about the specified GitHub code of conduct.", "tags": [ "codes-of-conduct" ], "operationId": "codes-of-conduct/get-conduct-code", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" }, "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "examples": { "default": { "value": { "key": "contributor_covenant", "name": "Contributor Covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant", "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n", "html_url": "http://contributor-covenant.org/version/1/4/" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "codes-of-conduct", "subcategory": "codes-of-conduct" } } }, "/emojis": { "get": { "summary": "Get emojis", "description": "Lists all the emojis available to use on GitHub.", "operationId": "emojis/get", "tags": [ "emojis" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/emojis/emojis#get-emojis" }, "parameters": [ ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "default": { "value": { "+1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", "-1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", "100": "https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8", "1234": "https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8", "1st_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8", "2nd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8", "3rd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8", "8ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8", "a": "https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8", "ab": "https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8", "abacus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8", "abc": "https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8", "abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8", "accept": "https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8", "accessibility": "https://github.githubassets.com/images/icons/emoji/accessibility.png?v8", "accordion": "https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8", "adhesive_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8", "adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8", "aerial_tramway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8", "afghanistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8", "airplane": "https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8", "aland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8", "alarm_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8", "albania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8", "alembic": "https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8", "algeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8", "alien": "https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8", "ambulance": "https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8", "american_samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8", "amphora": "https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8", "anatomical_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8", "anchor": "https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8", "andorra": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8", "angel": "https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8", "anger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8", "angola": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8", "angry": "https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8", "anguilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8", "anguished": "https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8", "ant": "https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8", "antarctica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8", "antigua_barbuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8", "apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8", "aquarius": "https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8", "argentina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8", "aries": "https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8", "armenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8", "arrow_backward": "https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8", "arrow_double_down": "https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8", "arrow_double_up": "https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8", "arrow_down": "https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8", "arrow_down_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8", "arrow_forward": "https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8", "arrow_heading_down": "https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8", "arrow_heading_up": "https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8", "arrow_left": "https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8", "arrow_lower_left": "https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8", "arrow_lower_right": "https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8", "arrow_right": "https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8", "arrow_right_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8", "arrow_up": "https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8", "arrow_up_down": "https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8", "arrow_up_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8", "arrow_upper_left": "https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8", "arrow_upper_right": "https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8", "arrows_clockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8", "arrows_counterclockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8", "art": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8", "articulated_lorry": "https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8", "artificial_satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8", "artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8", "aruba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8", "ascension_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8", "asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8", "astonished": "https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8", "astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8", "athletic_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8", "atm": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8", "atom": "https://github.githubassets.com/images/icons/emoji/atom.png?v8", "atom_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8", "australia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8", "austria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8", "auto_rickshaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8", "avocado": "https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8", "axe": "https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8", "azerbaijan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8", "b": "https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8", "baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8", "baby_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8", "baby_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8", "baby_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8", "back": "https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8", "bacon": "https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8", "badger": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8", "badminton": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8", "bagel": "https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8", "baggage_claim": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8", "baguette_bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8", "bahamas": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8", "bahrain": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8", "balance_scale": "https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8", "bald_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8", "bald_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8", "ballet_shoes": "https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8", "balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8", "ballot_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8", "ballot_box_with_check": "https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8", "bamboo": "https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8", "banana": "https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8", "bangbang": "https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8", "bangladesh": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8", "banjo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8", "bank": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8", "bar_chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8", "barbados": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8", "barber": "https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8", "baseball": "https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8", "basecamp": "https://github.githubassets.com/images/icons/emoji/basecamp.png?v8", "basecampy": "https://github.githubassets.com/images/icons/emoji/basecampy.png?v8", "basket": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8", "basketball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8", "basketball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", "basketball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", "bat": "https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8", "bath": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8", "bathtub": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8", "battery": "https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8", "beach_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8", "bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8", "bearded_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8", "beaver": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8", "bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8", "bee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", "beer": "https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8", "beers": "https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8", "beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8", "beginner": "https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8", "belarus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8", "belgium": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8", "belize": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8", "bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8", "bell_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8", "bellhop_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8", "benin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8", "bento": "https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8", "bermuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8", "beverage_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8", "bhutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8", "bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8", "bike": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8", "biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8", "biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8", "bikini": "https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8", "billed_cap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8", "biohazard": "https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8", "bird": "https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8", "birthday": "https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8", "bison": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8", "black_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8", "black_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8", "black_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8", "black_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8", "black_joker": "https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8", "black_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8", "black_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8", "black_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8", "black_nib": "https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8", "black_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8", "black_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8", "blond_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8", "blond_haired_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8", "blond_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", "blonde_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", "blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8", "blowfish": "https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8", "blue_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8", "blue_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8", "blue_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8", "blue_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8", "blueberries": "https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8", "blush": "https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8", "boar": "https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8", "boat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", "bolivia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8", "bomb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8", "bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8", "book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", "bookmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8", "bookmark_tabs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8", "books": "https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8", "boom": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", "boomerang": "https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8", "boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8", "bosnia_herzegovina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8", "botswana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8", "bouncing_ball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", "bouncing_ball_person": "https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8", "bouncing_ball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", "bouquet": "https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8", "bouvet_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8", "bow": "https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8", "bow_and_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8", "bowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8", "bowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8", "bowl_with_spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8", "bowling": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8", "bowtie": "https://github.githubassets.com/images/icons/emoji/bowtie.png?v8", "boxing_glove": "https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8", "boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8", "brain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8", "brazil": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8", "bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8", "breast_feeding": "https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8", "bricks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8", "bride_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", "bridge_at_night": "https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8", "briefcase": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8", "british_indian_ocean_territory": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8", "british_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8", "broccoli": "https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8", "broken_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8", "broom": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8", "brown_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8", "brown_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8", "brown_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8", "brunei": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8", "bubble_tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8", "bucket": "https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8", "bug": "https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8", "building_construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8", "bulb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8", "bulgaria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8", "bullettrain_front": "https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8", "bullettrain_side": "https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8", "burkina_faso": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8", "burrito": "https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8", "burundi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8", "bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8", "business_suit_levitating": "https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8", "busstop": "https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8", "bust_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8", "busts_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8", "butter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8", "butterfly": "https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8", "cactus": "https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8", "cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8", "calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8", "call_me_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8", "calling": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8", "cambodia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8", "camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8", "camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8", "camera_flash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8", "cameroon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8", "camping": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8", "canada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8", "canary_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8", "cancer": "https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8", "candle": "https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8", "candy": "https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8", "canned_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8", "canoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8", "cape_verde": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8", "capital_abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8", "capricorn": "https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8", "car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", "card_file_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8", "card_index": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8", "card_index_dividers": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8", "caribbean_netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8", "carousel_horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8", "carpentry_saw": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8", "carrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8", "cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8", "cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8", "cat2": "https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8", "cayman_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8", "cd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8", "central_african_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8", "ceuta_melilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8", "chad": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8", "chains": "https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8", "chair": "https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8", "champagne": "https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8", "chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8", "chart_with_downwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8", "chart_with_upwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8", "checkered_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8", "cheese": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8", "cherries": "https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8", "cherry_blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8", "chess_pawn": "https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8", "chestnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8", "chicken": "https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8", "child": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8", "children_crossing": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8", "chile": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8", "chipmunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8", "chocolate_bar": "https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8", "chopsticks": "https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8", "christmas_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8", "christmas_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8", "church": "https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8", "cinema": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8", "circus_tent": "https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8", "city_sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8", "city_sunset": "https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8", "cityscape": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8", "cl": "https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8", "clamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8", "clap": "https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8", "clapper": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8", "classical_building": "https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8", "climbing": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8", "climbing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8", "climbing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8", "clinking_glasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8", "clipboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8", "clipperton_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8", "clock1": "https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8", "clock10": "https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8", "clock1030": "https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8", "clock11": "https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8", "clock1130": "https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8", "clock12": "https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8", "clock1230": "https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8", "clock130": "https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8", "clock2": "https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8", "clock230": "https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8", "clock3": "https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8", "clock330": "https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8", "clock4": "https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8", "clock430": "https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8", "clock5": "https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8", "clock530": "https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8", "clock6": "https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8", "clock630": "https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8", "clock7": "https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8", "clock730": "https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8", "clock8": "https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8", "clock830": "https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8", "clock9": "https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8", "clock930": "https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8", "closed_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8", "closed_lock_with_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8", "closed_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8", "cloud": "https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8", "cloud_with_lightning": "https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8", "cloud_with_lightning_and_rain": "https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8", "cloud_with_rain": "https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8", "cloud_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8", "clown_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8", "clubs": "https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8", "cn": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8", "coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8", "cockroach": "https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8", "cocktail": "https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8", "coconut": "https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8", "cocos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8", "coffee": "https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8", "coffin": "https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8", "coin": "https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8", "cold_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8", "cold_sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8", "collision": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", "colombia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8", "comet": "https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8", "comoros": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8", "compass": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8", "computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8", "computer_mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8", "confetti_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8", "confounded": "https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8", "confused": "https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8", "congo_brazzaville": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8", "congo_kinshasa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8", "congratulations": "https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8", "construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8", "construction_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8", "construction_worker_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8", "construction_worker_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8", "control_knobs": "https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8", "convenience_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8", "cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8", "cook_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8", "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", "cote_divoire": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8", "couch_and_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8", "couple": "https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8", "couple_with_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8", "couple_with_heart_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8", "couple_with_heart_woman_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8", "couple_with_heart_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8", "couplekiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8", "couplekiss_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8", "couplekiss_man_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8", "couplekiss_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8", "cow": "https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8", "cow2": "https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8", "cowboy_hat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8", "crab": "https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8", "crayon": "https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8", "credit_card": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8", "crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8", "cricket": "https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8", "cricket_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8", "croatia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8", "crocodile": "https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8", "croissant": "https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8", "crossed_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8", "crossed_flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8", "crossed_swords": "https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8", "crown": "https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8", "cry": "https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8", "crying_cat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8", "crystal_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8", "cuba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8", "cucumber": "https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8", "cup_with_straw": "https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8", "cupcake": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8", "cupid": "https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8", "curacao": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8", "curling_stone": "https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8", "curly_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8", "curly_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8", "curly_loop": "https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8", "currency_exchange": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8", "curry": "https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8", "cursing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8", "custard": "https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8", "customs": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8", "cut_of_meat": "https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8", "cyclone": "https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8", "cyprus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8", "czech_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8", "dagger": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8", "dancer": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", "dancers": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8", "dancing_men": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8", "dancing_women": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8", "dango": "https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8", "dark_sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8", "dart": "https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8", "dash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8", "date": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8", "de": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8", "deaf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8", "deaf_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8", "deaf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8", "deciduous_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8", "deer": "https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8", "denmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8", "department_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8", "dependabot": "https://github.githubassets.com/images/icons/emoji/dependabot.png?v8", "derelict_house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8", "desert": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8", "desert_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8", "desktop_computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8", "detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8", "diamond_shape_with_a_dot_inside": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8", "diamonds": "https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8", "diego_garcia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8", "disappointed": "https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8", "disappointed_relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8", "disguised_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8", "diving_mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8", "diya_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8", "dizzy": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8", "dizzy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8", "djibouti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8", "dna": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8", "do_not_litter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8", "dodo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8", "dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8", "dog2": "https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8", "dollar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8", "dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8", "dolphin": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", "dominica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8", "dominican_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8", "door": "https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8", "doughnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8", "dove": "https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8", "dragon": "https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8", "dragon_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8", "dress": "https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8", "dromedary_camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8", "drooling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8", "drop_of_blood": "https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8", "droplet": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8", "drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8", "duck": "https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8", "dumpling": "https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8", "dvd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8", "e-mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", "eagle": "https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8", "ear": "https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8", "ear_of_rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8", "ear_with_hearing_aid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8", "earth_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8", "earth_americas": "https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8", "earth_asia": "https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8", "ecuador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8", "egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8", "eggplant": "https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8", "egypt": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8", "eight": "https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8", "eight_pointed_black_star": "https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8", "eight_spoked_asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8", "eject_button": "https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8", "el_salvador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8", "electric_plug": "https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8", "electron": "https://github.githubassets.com/images/icons/emoji/electron.png?v8", "elephant": "https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8", "elevator": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8", "elf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8", "elf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8", "elf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8", "email": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", "end": "https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8", "england": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8", "envelope": "https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8", "envelope_with_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8", "equatorial_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8", "eritrea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8", "es": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8", "estonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8", "ethiopia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8", "eu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", "euro": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8", "european_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8", "european_post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8", "european_union": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", "evergreen_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8", "exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", "exploding_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8", "expressionless": "https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8", "eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8", "eye_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8", "eyeglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8", "eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8", "face_exhaling": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8", "face_in_clouds": "https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8", "face_with_head_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8", "face_with_spiral_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8", "face_with_thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8", "facepalm": "https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8", "facepunch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", "factory": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8", "factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8", "fairy": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8", "fairy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8", "fairy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8", "falafel": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8", "falkland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8", "fallen_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8", "family": "https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8", "family_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8", "family_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8", "family_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8", "family_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8", "family_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8", "family_man_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8", "family_man_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8", "family_man_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8", "family_man_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8", "family_man_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8", "family_man_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8", "family_man_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8", "family_man_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8", "family_man_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8", "family_man_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8", "family_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8", "family_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8", "family_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8", "family_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8", "family_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8", "family_woman_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8", "family_woman_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8", "family_woman_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8", "family_woman_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8", "family_woman_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8", "farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8", "faroe_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8", "fast_forward": "https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8", "fax": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8", "fearful": "https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8", "feather": "https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8", "feelsgood": "https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8", "feet": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", "female_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8", "female_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8", "ferris_wheel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8", "ferry": "https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8", "field_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8", "fiji": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8", "file_cabinet": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8", "file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8", "film_projector": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8", "film_strip": "https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8", "finland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8", "finnadie": "https://github.githubassets.com/images/icons/emoji/finnadie.png?v8", "fire": "https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8", "fire_engine": "https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8", "fire_extinguisher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8", "firecracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8", "firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8", "fireworks": "https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8", "first_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8", "first_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8", "fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8", "fish_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8", "fishsticks": "https://github.githubassets.com/images/icons/emoji/fishsticks.png?v8", "fishing_pole_and_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8", "fist": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", "fist_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8", "fist_oncoming": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", "fist_raised": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", "fist_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8", "five": "https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8", "flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8", "flamingo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8", "flashlight": "https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8", "flat_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8", "flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8", "fleur_de_lis": "https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8", "flight_arrival": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8", "flight_departure": "https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8", "flipper": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", "floppy_disk": "https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8", "flower_playing_cards": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8", "flushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8", "fly": "https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8", "flying_disc": "https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8", "flying_saucer": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8", "fog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8", "foggy": "https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8", "fondue": "https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8", "foot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8", "football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8", "footprints": "https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8", "fork_and_knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8", "fortune_cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8", "fountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8", "fountain_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8", "four": "https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8", "four_leaf_clover": "https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8", "fox_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8", "fr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8", "framed_picture": "https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8", "free": "https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8", "french_guiana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8", "french_polynesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8", "french_southern_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8", "fried_egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8", "fried_shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8", "fries": "https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8", "frog": "https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8", "frowning": "https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8", "frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8", "frowning_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8", "frowning_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8", "frowning_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8", "fu": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", "fuelpump": "https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8", "full_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8", "full_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8", "funeral_urn": "https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8", "gabon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8", "gambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8", "game_die": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8", "garlic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8", "gb": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", "gear": "https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8", "gem": "https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8", "gemini": "https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8", "genie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8", "genie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8", "genie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8", "georgia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8", "ghana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8", "ghost": "https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8", "gibraltar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8", "gift": "https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8", "gift_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8", "giraffe": "https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8", "girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8", "globe_with_meridians": "https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8", "gloves": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8", "goal_net": "https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8", "goat": "https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8", "goberserk": "https://github.githubassets.com/images/icons/emoji/goberserk.png?v8", "godmode": "https://github.githubassets.com/images/icons/emoji/godmode.png?v8", "goggles": "https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8", "golf": "https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8", "golfing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8", "golfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8", "golfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8", "gorilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8", "grapes": "https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8", "greece": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8", "green_apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8", "green_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8", "green_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8", "green_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8", "green_salad": "https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8", "green_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8", "greenland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8", "grenada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8", "grey_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8", "grey_question": "https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8", "grimacing": "https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8", "grin": "https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8", "grinning": "https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8", "guadeloupe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8", "guam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8", "guard": "https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8", "guardsman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8", "guardswoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8", "guatemala": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8", "guernsey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8", "guide_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8", "guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8", "guinea_bissau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8", "guitar": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8", "gun": "https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8", "guyana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8", "haircut": "https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8", "haircut_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8", "haircut_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8", "haiti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8", "hamburger": "https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8", "hammer": "https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8", "hammer_and_pick": "https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8", "hammer_and_wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8", "hamster": "https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8", "hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", "hand_over_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8", "handbag": "https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8", "handball_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8", "handshake": "https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8", "hankey": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", "hash": "https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8", "hatched_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8", "hatching_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8", "headphones": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8", "headstone": "https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8", "health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8", "hear_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8", "heard_mcdonald_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8", "heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8", "heart_decoration": "https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8", "heart_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8", "heart_eyes_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8", "heart_on_fire": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8", "heartbeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8", "heartpulse": "https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8", "hearts": "https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8", "heavy_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8", "heavy_division_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8", "heavy_dollar_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8", "heavy_exclamation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", "heavy_heart_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8", "heavy_minus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8", "heavy_multiplication_x": "https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8", "heavy_plus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8", "hedgehog": "https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8", "helicopter": "https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8", "herb": "https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8", "hibiscus": "https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8", "high_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8", "high_heel": "https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8", "hiking_boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8", "hindu_temple": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8", "hippopotamus": "https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8", "hocho": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", "hole": "https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8", "honduras": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8", "honey_pot": "https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8", "honeybee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", "hong_kong": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8", "hook": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8", "horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8", "horse_racing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8", "hospital": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8", "hot_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8", "hot_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8", "hotdog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8", "hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8", "hotsprings": "https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8", "hourglass": "https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8", "hourglass_flowing_sand": "https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8", "house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8", "house_with_garden": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8", "houses": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8", "hugs": "https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8", "hungary": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8", "hurtrealbad": "https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8", "hushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8", "hut": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8", "ice_cream": "https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8", "ice_cube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8", "ice_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8", "ice_skate": "https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8", "icecream": "https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8", "iceland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8", "id": "https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8", "ideograph_advantage": "https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8", "imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8", "inbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8", "incoming_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8", "india": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8", "indonesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8", "infinity": "https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8", "information_desk_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", "information_source": "https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8", "innocent": "https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8", "interrobang": "https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8", "iphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8", "iran": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8", "iraq": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8", "ireland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8", "isle_of_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8", "israel": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8", "it": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8", "izakaya_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", "jack_o_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8", "jamaica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8", "japan": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8", "japanese_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8", "japanese_goblin": "https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8", "japanese_ogre": "https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8", "jeans": "https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8", "jersey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8", "jigsaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8", "jordan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8", "joy": "https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8", "joy_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8", "joystick": "https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8", "jp": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8", "judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8", "juggling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8", "kangaroo": "https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8", "kazakhstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8", "kenya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8", "key": "https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8", "keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8", "keycap_ten": "https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8", "kick_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8", "kimono": "https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8", "kiribati": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8", "kiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8", "kissing": "https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8", "kissing_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8", "kissing_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8", "kissing_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8", "kissing_smiling_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8", "kite": "https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8", "kiwi_fruit": "https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8", "kneeling_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8", "kneeling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8", "kneeling_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8", "knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", "knot": "https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8", "koala": "https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8", "koko": "https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8", "kosovo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8", "kr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8", "kuwait": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8", "kyrgyzstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8", "lab_coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8", "label": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8", "lacrosse": "https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8", "ladder": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8", "lady_beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8", "lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", "laos": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8", "large_blue_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8", "large_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8", "large_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8", "last_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8", "last_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8", "latin_cross": "https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8", "latvia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8", "laughing": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", "leafy_green": "https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8", "leaves": "https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8", "lebanon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8", "ledger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8", "left_luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8", "left_right_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8", "left_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8", "leftwards_arrow_with_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8", "leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8", "lemon": "https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8", "leo": "https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8", "leopard": "https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8", "lesotho": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8", "level_slider": "https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8", "liberia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8", "libra": "https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8", "libya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8", "liechtenstein": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8", "light_rail": "https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8", "link": "https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8", "lion": "https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8", "lips": "https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8", "lipstick": "https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8", "lithuania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8", "lizard": "https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8", "llama": "https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8", "lobster": "https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8", "lock": "https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8", "lock_with_ink_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8", "lollipop": "https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8", "long_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8", "loop": "https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8", "lotion_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8", "lotus_position": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8", "lotus_position_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8", "lotus_position_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8", "loud_sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8", "loudspeaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8", "love_hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8", "love_letter": "https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8", "love_you_gesture": "https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8", "low_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8", "luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8", "lungs": "https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8", "luxembourg": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8", "lying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8", "m": "https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8", "macau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8", "macedonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8", "madagascar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8", "mag": "https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8", "mag_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8", "mage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8", "mage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8", "mage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8", "magic_wand": "https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8", "magnet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8", "mahjong": "https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8", "mailbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8", "mailbox_closed": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8", "mailbox_with_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8", "mailbox_with_no_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8", "malawi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8", "malaysia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8", "maldives": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8", "male_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8", "male_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8", "mali": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8", "malta": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8", "mammoth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8", "man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8", "man_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8", "man_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8", "man_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8", "man_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8", "man_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8", "man_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8", "man_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8", "man_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8", "man_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8", "man_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8", "man_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8", "man_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8", "man_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8", "man_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8", "man_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8", "man_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8", "man_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8", "man_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8", "man_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8", "man_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8", "man_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8", "man_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8", "man_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8", "man_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8", "man_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8", "man_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8", "man_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8", "man_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8", "man_with_gua_pi_mao": "https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8", "man_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8", "man_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8", "man_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8", "mandarin": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", "mango": "https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8", "mans_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", "mantelpiece_clock": "https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8", "manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8", "maple_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8", "marshall_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8", "martial_arts_uniform": "https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8", "martinique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8", "mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8", "massage": "https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8", "massage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8", "massage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8", "mate": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8", "mauritania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8", "mauritius": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8", "mayotte": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8", "meat_on_bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8", "mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8", "mechanical_arm": "https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8", "mechanical_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8", "medal_military": "https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8", "medal_sports": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8", "medical_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8", "mega": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8", "melon": "https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8", "memo": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", "men_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8", "mending_heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8", "menorah": "https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8", "mens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8", "mermaid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8", "merman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8", "merperson": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8", "metal": "https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8", "metro": "https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8", "mexico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8", "microbe": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8", "micronesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8", "microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8", "microscope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8", "middle_finger": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", "military_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8", "milk_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8", "milky_way": "https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8", "minibus": "https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8", "minidisc": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8", "mirror": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8", "mobile_phone_off": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8", "moldova": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8", "monaco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8", "money_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8", "money_with_wings": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8", "moneybag": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8", "mongolia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8", "monkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8", "monkey_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8", "monocle_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8", "monorail": "https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8", "montenegro": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8", "montserrat": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8", "moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", "moon_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8", "morocco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8", "mortar_board": "https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8", "mosque": "https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8", "mosquito": "https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8", "motor_boat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8", "motor_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8", "motorcycle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8", "motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8", "motorway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8", "mount_fuji": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8", "mountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8", "mountain_bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8", "mountain_biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8", "mountain_biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8", "mountain_cableway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8", "mountain_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8", "mountain_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8", "mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8", "mouse2": "https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8", "mouse_trap": "https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8", "movie_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8", "moyai": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8", "mozambique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8", "mrs_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8", "muscle": "https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8", "mushroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8", "musical_keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8", "musical_note": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8", "musical_score": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8", "mute": "https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8", "mx_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8", "myanmar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8", "nail_care": "https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8", "name_badge": "https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8", "namibia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8", "national_park": "https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8", "nauru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8", "nauseated_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8", "nazar_amulet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8", "neckbeard": "https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8", "necktie": "https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8", "negative_squared_cross_mark": "https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8", "nepal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8", "nerd_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8", "nesting_dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8", "netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8", "neutral_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8", "new": "https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8", "new_caledonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8", "new_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8", "new_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8", "new_zealand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8", "newspaper": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8", "newspaper_roll": "https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8", "next_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8", "ng": "https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8", "ng_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", "ng_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", "nicaragua": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8", "niger": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8", "nigeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8", "night_with_stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8", "nine": "https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8", "ninja": "https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8", "niue": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8", "no_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8", "no_bicycles": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8", "no_entry": "https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8", "no_entry_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8", "no_good": "https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8", "no_good_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", "no_good_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", "no_mobile_phones": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8", "no_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8", "no_pedestrians": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8", "no_smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8", "non-potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8", "norfolk_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8", "north_korea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8", "northern_mariana_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8", "norway": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8", "nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8", "notebook": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8", "notebook_with_decorative_cover": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8", "notes": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8", "nut_and_bolt": "https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8", "o": "https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8", "o2": "https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8", "ocean": "https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8", "octocat": "https://github.githubassets.com/images/icons/emoji/octocat.png?v8", "octopus": "https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8", "oden": "https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8", "office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8", "office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8", "oil_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8", "ok": "https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8", "ok_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8", "ok_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8", "ok_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8", "ok_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8", "old_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8", "older_adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8", "older_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8", "older_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8", "olive": "https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8", "om": "https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8", "oman": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8", "on": "https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8", "oncoming_automobile": "https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8", "oncoming_bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8", "oncoming_police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8", "oncoming_taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8", "one": "https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8", "one_piece_swimsuit": "https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8", "onion": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8", "open_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", "open_file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8", "open_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8", "open_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8", "open_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8", "ophiuchus": "https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8", "orange": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", "orange_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8", "orange_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8", "orange_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8", "orange_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8", "orangutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8", "orthodox_cross": "https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8", "otter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8", "outbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8", "owl": "https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8", "ox": "https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8", "oyster": "https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8", "package": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8", "page_facing_up": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8", "page_with_curl": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8", "pager": "https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8", "paintbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8", "pakistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8", "palau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8", "palestinian_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8", "palm_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8", "palms_up_together": "https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8", "panama": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8", "pancakes": "https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8", "panda_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8", "paperclip": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8", "paperclips": "https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8", "papua_new_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8", "parachute": "https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8", "paraguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8", "parasol_on_ground": "https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8", "parking": "https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8", "parrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8", "part_alternation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8", "partly_sunny": "https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8", "partying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8", "passenger_ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8", "passport_control": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8", "pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8", "paw_prints": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", "peace_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8", "peach": "https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8", "peacock": "https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8", "peanuts": "https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8", "pear": "https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8", "pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8", "pencil": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", "pencil2": "https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8", "penguin": "https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8", "pensive": "https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8", "people_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8", "people_hugging": "https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8", "performing_arts": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8", "persevere": "https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8", "person_bald": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8", "person_curly_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8", "person_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8", "person_fencing": "https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8", "person_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8", "person_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8", "person_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8", "person_red_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8", "person_white_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8", "person_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8", "person_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8", "person_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8", "peru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8", "petri_dish": "https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8", "philippines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8", "phone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", "pick": "https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8", "pickup_truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8", "pie": "https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8", "pig": "https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8", "pig2": "https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8", "pig_nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8", "pill": "https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8", "pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8", "pinata": "https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8", "pinched_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8", "pinching_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8", "pineapple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8", "ping_pong": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8", "pirate_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8", "pisces": "https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8", "pitcairn_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8", "pizza": "https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8", "placard": "https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8", "place_of_worship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8", "plate_with_cutlery": "https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8", "play_or_pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8", "pleading_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8", "plunger": "https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8", "point_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8", "point_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8", "point_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8", "point_up": "https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8", "point_up_2": "https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8", "poland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8", "polar_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8", "police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8", "police_officer": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", "policeman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8", "policewoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8", "poodle": "https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8", "poop": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", "popcorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8", "portugal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8", "post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8", "postal_horn": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8", "postbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8", "potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8", "potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8", "potted_plant": "https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8", "pouch": "https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8", "poultry_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8", "pound": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8", "pout": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", "pouting_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8", "pouting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8", "pouting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8", "pouting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8", "pray": "https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8", "prayer_beads": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8", "pregnant_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8", "pretzel": "https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8", "previous_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8", "prince": "https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8", "princess": "https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8", "printer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8", "probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8", "puerto_rico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8", "punch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", "purple_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8", "purple_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8", "purple_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8", "purse": "https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8", "pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8", "put_litter_in_its_place": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8", "qatar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8", "question": "https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8", "rabbit": "https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8", "rabbit2": "https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8", "raccoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8", "racehorse": "https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8", "racing_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8", "radio": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8", "radio_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8", "radioactive": "https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8", "rage": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", "rage1": "https://github.githubassets.com/images/icons/emoji/rage1.png?v8", "rage2": "https://github.githubassets.com/images/icons/emoji/rage2.png?v8", "rage3": "https://github.githubassets.com/images/icons/emoji/rage3.png?v8", "rage4": "https://github.githubassets.com/images/icons/emoji/rage4.png?v8", "railway_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8", "railway_track": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8", "rainbow": "https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8", "rainbow_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8", "raised_back_of_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8", "raised_eyebrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8", "raised_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", "raised_hand_with_fingers_splayed": "https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8", "raised_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8", "raising_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8", "raising_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8", "raising_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8", "ram": "https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8", "ramen": "https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8", "rat": "https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8", "razor": "https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8", "receipt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8", "record_button": "https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8", "recycle": "https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8", "red_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", "red_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8", "red_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8", "red_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8", "red_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8", "red_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8", "registered": "https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8", "relaxed": "https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8", "relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8", "reminder_ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8", "repeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8", "repeat_one": "https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8", "rescue_worker_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8", "restroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8", "reunion": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8", "revolving_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8", "rewind": "https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8", "rhinoceros": "https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8", "ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8", "rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8", "rice_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8", "rice_cracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8", "rice_scene": "https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8", "right_anger_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8", "ring": "https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8", "ringed_planet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8", "robot": "https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8", "rock": "https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8", "rocket": "https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8", "rofl": "https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8", "roll_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8", "roll_of_paper": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8", "roller_coaster": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8", "roller_skate": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8", "romania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8", "rooster": "https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8", "rose": "https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8", "rosette": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8", "rotating_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8", "round_pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8", "rowboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8", "rowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8", "rowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8", "ru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8", "rugby_football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8", "runner": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", "running": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", "running_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8", "running_shirt_with_sash": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8", "running_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8", "rwanda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8", "sa": "https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8", "safety_pin": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8", "safety_vest": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8", "sagittarius": "https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8", "sailboat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", "sake": "https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8", "salt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8", "samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8", "san_marino": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8", "sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8", "sandwich": "https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8", "santa": "https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8", "sao_tome_principe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8", "sari": "https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8", "sassy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", "sassy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", "satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8", "satisfied": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", "saudi_arabia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8", "sauna_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8", "sauna_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8", "sauna_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8", "sauropod": "https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8", "saxophone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8", "scarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8", "school": "https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8", "school_satchel": "https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8", "scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8", "scissors": "https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8", "scorpion": "https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8", "scorpius": "https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8", "scotland": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8", "scream": "https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8", "scream_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8", "screwdriver": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8", "scroll": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8", "seal": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8", "seat": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8", "secret": "https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8", "see_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8", "seedling": "https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8", "selfie": "https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8", "senegal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8", "serbia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8", "service_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8", "seven": "https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8", "sewing_needle": "https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8", "seychelles": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8", "shallow_pan_of_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8", "shamrock": "https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8", "shark": "https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8", "shaved_ice": "https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8", "sheep": "https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8", "shell": "https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8", "shield": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8", "shinto_shrine": "https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8", "ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8", "shipit": "https://github.githubassets.com/images/icons/emoji/shipit.png?v8", "shirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", "shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", "shopping": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8", "shopping_cart": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8", "shorts": "https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8", "shower": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8", "shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8", "shrug": "https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8", "shushing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8", "sierra_leone": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8", "signal_strength": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8", "singapore": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8", "singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8", "sint_maarten": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8", "six": "https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8", "six_pointed_star": "https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8", "skateboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8", "ski": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8", "skier": "https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8", "skull": "https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8", "skull_and_crossbones": "https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8", "skunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8", "sled": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8", "sleeping": "https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8", "sleeping_bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8", "sleepy": "https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8", "slightly_frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8", "slightly_smiling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8", "slot_machine": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8", "sloth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8", "slovakia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8", "slovenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8", "small_airplane": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8", "small_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8", "small_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8", "small_red_triangle": "https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8", "small_red_triangle_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8", "smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8", "smile_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8", "smiley": "https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8", "smiley_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8", "smiling_face_with_tear": "https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8", "smiling_face_with_three_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8", "smiling_imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8", "smirk": "https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8", "smirk_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8", "smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8", "snail": "https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8", "snake": "https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8", "sneezing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8", "snowboarder": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8", "snowflake": "https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8", "snowman": "https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8", "snowman_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8", "soap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8", "sob": "https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8", "soccer": "https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8", "socks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8", "softball": "https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8", "solomon_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8", "somalia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8", "soon": "https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8", "sos": "https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8", "sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8", "south_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8", "south_georgia_south_sandwich_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8", "south_sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8", "space_invader": "https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8", "spades": "https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8", "spaghetti": "https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8", "sparkle": "https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8", "sparkler": "https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8", "sparkles": "https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8", "sparkling_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8", "speak_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8", "speaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8", "speaking_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8", "speech_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8", "speedboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8", "spider": "https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8", "spider_web": "https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8", "spiral_calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8", "spiral_notepad": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8", "sponge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8", "spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8", "squid": "https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8", "sri_lanka": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8", "st_barthelemy": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8", "st_helena": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8", "st_kitts_nevis": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8", "st_lucia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8", "st_martin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8", "st_pierre_miquelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8", "st_vincent_grenadines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8", "stadium": "https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8", "standing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8", "standing_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8", "standing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8", "star": "https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8", "star2": "https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8", "star_and_crescent": "https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8", "star_of_david": "https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8", "star_struck": "https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8", "stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8", "station": "https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8", "statue_of_liberty": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8", "steam_locomotive": "https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8", "stethoscope": "https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8", "stew": "https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8", "stop_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8", "stop_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8", "stopwatch": "https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8", "straight_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8", "strawberry": "https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8", "stuck_out_tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8", "stuck_out_tongue_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8", "stuck_out_tongue_winking_eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8", "student": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8", "studio_microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8", "stuffed_flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8", "sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8", "sun_behind_large_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8", "sun_behind_rain_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8", "sun_behind_small_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8", "sun_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8", "sunflower": "https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8", "sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8", "sunny": "https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8", "sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8", "sunrise_over_mountains": "https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8", "superhero": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8", "superhero_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8", "superhero_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8", "supervillain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8", "supervillain_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8", "supervillain_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8", "surfer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8", "surfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8", "surfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8", "suriname": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8", "sushi": "https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8", "suspect": "https://github.githubassets.com/images/icons/emoji/suspect.png?v8", "suspension_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8", "svalbard_jan_mayen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8", "swan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8", "swaziland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8", "sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8", "sweat_drops": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8", "sweat_smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8", "sweden": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8", "sweet_potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8", "swim_brief": "https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8", "swimmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8", "swimming_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8", "swimming_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8", "switzerland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8", "symbols": "https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8", "synagogue": "https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8", "syria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8", "syringe": "https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8", "t-rex": "https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8", "taco": "https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8", "tada": "https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8", "taiwan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8", "tajikistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8", "takeout_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8", "tamale": "https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8", "tanabata_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8", "tangerine": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", "tanzania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8", "taurus": "https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8", "taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8", "tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8", "teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8", "teapot": "https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8", "technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8", "teddy_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8", "telephone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", "telephone_receiver": "https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8", "telescope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8", "tennis": "https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8", "tent": "https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8", "test_tube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8", "thailand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8", "thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8", "thinking": "https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8", "thong_sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8", "thought_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8", "thread": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8", "three": "https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8", "thumbsdown": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", "thumbsup": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", "ticket": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8", "tickets": "https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8", "tiger": "https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8", "tiger2": "https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8", "timer_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8", "timor_leste": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8", "tipping_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", "tipping_hand_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", "tipping_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", "tired_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8", "tm": "https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8", "togo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8", "toilet": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8", "tokelau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8", "tokyo_tower": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8", "tomato": "https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8", "tonga": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8", "tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8", "toolbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8", "tooth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8", "toothbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8", "top": "https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8", "tophat": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8", "tornado": "https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8", "tr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8", "trackball": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8", "tractor": "https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8", "traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8", "train": "https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8", "train2": "https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8", "tram": "https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8", "transgender_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8", "transgender_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8", "triangular_flag_on_post": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8", "triangular_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8", "trident": "https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8", "trinidad_tobago": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8", "tristan_da_cunha": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8", "triumph": "https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8", "trolleybus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8", "trollface": "https://github.githubassets.com/images/icons/emoji/trollface.png?v8", "trophy": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8", "tropical_drink": "https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8", "tropical_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8", "truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8", "trumpet": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8", "tshirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", "tulip": "https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8", "tumbler_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8", "tunisia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8", "turkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8", "turkmenistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8", "turks_caicos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8", "turtle": "https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8", "tuvalu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8", "tv": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8", "twisted_rightwards_arrows": "https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8", "two": "https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8", "two_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8", "two_men_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8", "two_women_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8", "u5272": "https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8", "u5408": "https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8", "u55b6": "https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8", "u6307": "https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8", "u6708": "https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8", "u6709": "https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8", "u6e80": "https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8", "u7121": "https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8", "u7533": "https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8", "u7981": "https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8", "u7a7a": "https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8", "uganda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8", "uk": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", "ukraine": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8", "umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8", "unamused": "https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8", "underage": "https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8", "unicorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8", "united_arab_emirates": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8", "united_nations": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8", "unlock": "https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8", "up": "https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8", "upside_down_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8", "uruguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8", "us": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8", "us_outlying_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8", "us_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8", "uzbekistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8", "v": "https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8", "vampire": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8", "vampire_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8", "vampire_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8", "vanuatu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8", "vatican_city": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8", "venezuela": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8", "vertical_traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8", "vhs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8", "vibration_mode": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8", "video_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8", "video_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8", "vietnam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8", "violin": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8", "virgo": "https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8", "volcano": "https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8", "volleyball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8", "vomiting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8", "vs": "https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8", "vulcan_salute": "https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8", "waffle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8", "wales": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8", "walking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8", "walking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8", "walking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8", "wallis_futuna": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8", "waning_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8", "waning_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8", "warning": "https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8", "wastebasket": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8", "watch": "https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8", "water_buffalo": "https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8", "water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8", "watermelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8", "wave": "https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8", "wavy_dash": "https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8", "waxing_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8", "waxing_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", "wc": "https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8", "weary": "https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8", "wedding": "https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8", "weight_lifting": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8", "weight_lifting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8", "weight_lifting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8", "western_sahara": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8", "whale": "https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8", "whale2": "https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8", "wheel_of_dharma": "https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8", "wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8", "white_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8", "white_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8", "white_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8", "white_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8", "white_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8", "white_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8", "white_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8", "white_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8", "white_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8", "white_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8", "white_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8", "white_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8", "wilted_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8", "wind_chime": "https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8", "wind_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8", "window": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8", "wine_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8", "wink": "https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8", "wolf": "https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8", "woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8", "woman_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8", "woman_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8", "woman_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8", "woman_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8", "woman_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8", "woman_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", "woman_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8", "woman_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8", "woman_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8", "woman_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8", "woman_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8", "woman_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8", "woman_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8", "woman_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8", "woman_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8", "woman_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8", "woman_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8", "woman_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8", "woman_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8", "woman_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8", "woman_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8", "woman_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8", "woman_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8", "woman_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8", "woman_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8", "woman_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8", "woman_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8", "woman_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8", "woman_with_headscarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8", "woman_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8", "woman_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8", "woman_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", "womans_clothes": "https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8", "womans_hat": "https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8", "women_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8", "womens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8", "wood": "https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8", "woozy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8", "world_map": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8", "worm": "https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8", "worried": "https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8", "wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8", "wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8", "writing_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8", "x": "https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8", "yarn": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8", "yawning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8", "yellow_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8", "yellow_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8", "yellow_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8", "yemen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8", "yen": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8", "yin_yang": "https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8", "yo_yo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8", "yum": "https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8", "zambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8", "zany_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8", "zap": "https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8", "zebra": "https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8", "zero": "https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8", "zimbabwe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8", "zipper_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8", "zombie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8", "zombie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8", "zombie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8", "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" } } } } }, "description": "Response" }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "emojis", "subcategory": "emojis" } } }, "/enterprises/{enterprise}/code-security/configurations": { "get": { "summary": "Get code security configurations for an enterprise", "description": "Lists all code security configurations available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "code-security" ], "operationId": "code-security/get-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" }, "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", "in": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "required": false, "schema": { "type": "integer", "default": 30 } }, { "name": "before", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "examples": { "default": { "value": [ { "id": 17, "target_type": "global", "name": "GitHub recommended", "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view", "created_at": "2023-12-04T15:58:07Z", "updated_at": "2023-12-04T15:58:07Z" }, { "id": 1326, "target_type": "enterprise", "name": "High risk settings", "description": "This is a code security configuration for octo-enterprise high risk repositories", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "enabled", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326", "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit", "created_at": "2024-05-10T00:00:00Z", "updated_at": "2024-05-10T00:00:00Z" } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" } }, "post": { "summary": "Create a code security configuration for an enterprise", "description": "Creates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "code-security" ], "operationId": "code-security/create-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise" }, "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" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the enterprise." }, "description": { "type": "string", "description": "A description of the code security configuration", "maxLength": 255 }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled" ], "default": "disabled" }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ], "default": "enabled" }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", "default": false } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." } } }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non provider patterns", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ], "default": "enforced" } }, "required": [ "name", "description" ] }, "examples": { "default": { "summary": "Example for a code security configuration", "value": { "name": "High rish settings", "description": "This is a code security configuration for octo-enterprise", "advanced_security": "enabled", "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "secret_scanning": "enabled" } } } } } }, "responses": { "201": { "description": "Successfully created code security configuration", "content": { "application/json": { "schema": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "examples": { "default": { "value": { "id": 1325, "target_type": "enterprise", "name": "High risk settings", "description": "This is a code security configuration for octo-enterprise", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" } } }, "/enterprises/{enterprise}/code-security/configurations/defaults": { "get": { "summary": "Get default code security configurations for an enterprise", "description": "Lists the default code security configurations for an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "code-security" ], "operationId": "code-security/get-default-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise" }, "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" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "description": "A list of default code security configurations", "items": { "type": "object", "properties": { "default_for_new_repos": { "enum": [ "public", "private_and_internal", "all" ], "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" }, "configuration": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "examples": { "default": { "value": [ { "default_for_new_repos": "public", "configuration": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", "secret_scanning_delegated_bypass_options": { "reviewers": [ { "security_configuration_id": 1325, "reviewer_id": 5678, "reviewer_type": "TEAM" } ] }, "secret_scanning_validity_checks": "enabled", "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } }, { "default_for_new_repos": "private_and_internal", "configuration": { "id": 17, "target_type": "global", "name": "GitHub recommended", "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", "updated_at": "2023-12-04T15:58:07Z" } } ] } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" } } }, "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { "get": { "summary": "Retrieve a code security configuration of an enterprise", "description": "Gets a code security configuration available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "code-security" ], "operationId": "code-security/get-single-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise" }, "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": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "examples": { "default": { "value": { "id": 1325, "target_type": "enterprise", "name": "High risk settings", "description": "This is a code security configuration for octo-enterprise", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" } }, "patch": { "summary": "Update a custom code security configuration for an enterprise", "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "code-security" ], "operationId": "code-security/update-enterprise-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" }, "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": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the code security configuration. Must be unique across the enterprise." }, "description": { "type": "string", "description": "A description of the code security configuration", "maxLength": 255 }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings.", "enum": [ "enabled", "disabled" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." } } }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] } } }, "examples": { "default": { "summary": "Example for updating a code security configuration", "value": { "name": "octo-enterprise recommended settings v2", "secret_scanning": "disabled", "code_scanning_default_setup": "enabled" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "examples": { "default": { "value": { "id": 1325, "target_type": "enterprise", "name": "High risk settings", "description": "This is a code security configuration for octo-enterprise", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" } }, "delete": { "summary": "Delete a code security configuration for an enterprise", "description": "Deletes a code security configuration from an enterprise.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "code-security" ], "operationId": "code-security/delete-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise" }, "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": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "A header with no content is returned." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" } } }, "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { "post": { "summary": "Attach an enterprise configuration to repositories", "description": "Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "code-security" ], "operationId": "code-security/attach-enterprise-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories" }, "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": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "scope": { "type": "string", "description": "The type of repositories to attach the configuration to.", "enum": [ "all", "all_without_configurations" ] } }, "required": [ "scope" ] }, "examples": { "default": { "summary": "Example for attaching a configuration to some repositories", "value": { "scope": "all" } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "default": { "value": null } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" } } }, "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { "put": { "summary": "Set a code security configuration as a default for an enterprise", "description": "Sets a code security configuration as a default to be applied to new repositories in your enterprise.\n\nThis configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "code-security" ], "operationId": "code-security/set-configuration-as-default-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise" }, "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": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "default_for_new_repos": { "type": "string", "description": "Specify which types of repository this security configuration should be applied to by default.", "enum": [ "all", "none", "private_and_internal", "public" ] } } }, "examples": { "default": { "summary": "Set this configuration to be enabled by default on all new repositories.", "value": { "default_for_new_repos": "all" } } } } } }, "responses": { "200": { "description": "Default successfully changed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "default_for_new_repos": { "type": "string", "description": "Specifies which types of repository this security configuration is applied to by default.", "enum": [ "all", "none", "private_and_internal", "public" ] }, "configuration": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } }, "examples": { "default": { "value": { "default_for_new_repos": "all", "configuration": { "value": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" } } }, "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { "get": { "summary": "Get repositories associated with an enterprise code security configuration", "description": "Lists the repositories associated with an enterprise code security configuration in an organization.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "code-security" ], "operationId": "code-security/get-repositories-for-enterprise-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration" }, "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": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "integer", "default": 30 } }, { "name": "before", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", "in": "query", "required": false, "schema": { "type": "string", "default": "all" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Repositories associated with a code security configuration and attachment status", "properties": { "status": { "type": "string", "description": "The attachment status of the code security configuration on the repository.", "enum": [ "attached", "attaching", "detached", "removed", "enforced", "failed", "updating", "removed_by_enterprise" ] }, "repository": { "title": "Simple Repository", "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", "example": "Hello-World", "description": "The name of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "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" ] }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", "nullable": true, "description": "The repository description." }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World", "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/contributors", "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/deployments", "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/downloads", "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/events", "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/forks", "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/languages", "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/merges", "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscription", "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/tags", "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/teams", "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/hooks", "description": "The API URL to list the hooks on the repository." } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } }, "examples": { "default": { "summary": "Example of code security configuration repositories", "value": [ { "status": "attached", "repository": { "value": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "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 }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } } } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" } } }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" }, "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": "state", "in": "query", "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", "schema": { "type": "string" } }, { "name": "ecosystem", "in": "query", "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", "schema": { "type": "string" } }, { "name": "package", "in": "query", "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", "schema": { "type": "string" } }, { "name": "epss_percentage", "in": "query", "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", "schema": { "type": "string" } }, { "name": "scope", "in": "query", "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", "schema": { "type": "string", "enum": [ "development", "runtime" ] } }, { "name": "sort", "in": "query", "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", "schema": { "type": "string", "enum": [ "created", "updated", "epss_percentage" ], "default": "created" } }, { "name": "direction", "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "before", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "first", "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } }, { "name": "last", "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "A Dependabot alert.", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "state": { "type": "string", "description": "The state of the Dependabot alert.", "readOnly": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, "dependency": { "type": "object", "description": "Details for the vulnerable dependency.", "readOnly": true, "properties": { "package": { "type": "object", "description": "Details for the vulnerable package.", "readOnly": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "readOnly": true }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "readOnly": true } }, "required": [ "ecosystem", "name" ], "additionalProperties": false }, "manifest_path": { "type": "string", "description": "The full path to the dependency manifest file, relative to the root of the repository.", "readOnly": true }, "scope": { "type": "string", "description": "The execution scope of the vulnerable dependency.", "readOnly": true, "nullable": true, "enum": [ "development", "runtime" ] } } }, "security_advisory": { "type": "object", "description": "Details for the GitHub Security Advisory.", "readOnly": true, "properties": { "ghsa_id": { "type": "string", "description": "The unique GitHub Security Advisory ID assigned to the advisory.", "readOnly": true }, "cve_id": { "type": "string", "description": "The unique CVE ID assigned to the advisory.", "readOnly": true, "nullable": true }, "summary": { "type": "string", "description": "A short, plain text summary of the advisory.", "readOnly": true, "maxLength": 1024 }, "description": { "type": "string", "description": "A long-form Markdown-supported description of the advisory.", "readOnly": true }, "vulnerabilities": { "type": "array", "description": "Vulnerable version range information for the advisory.", "readOnly": true, "items": { "type": "object", "description": "Details pertaining to one vulnerable version range for the advisory.", "readOnly": true, "properties": { "package": { "type": "object", "description": "Details for the vulnerable package.", "readOnly": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "readOnly": true }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "readOnly": true } }, "required": [ "ecosystem", "name" ], "additionalProperties": false }, "severity": { "type": "string", "description": "The severity of the vulnerability.", "readOnly": true, "enum": [ "low", "medium", "high", "critical" ] }, "vulnerable_version_range": { "type": "string", "description": "Conditions that identify vulnerable versions of this vulnerability's package.", "readOnly": true }, "first_patched_version": { "type": "object", "description": "Details pertaining to the package version that patches this vulnerability.", "readOnly": true, "nullable": true, "properties": { "identifier": { "type": "string", "description": "The package version that patches this vulnerability.", "readOnly": true } }, "required": [ "identifier" ], "additionalProperties": false } }, "required": [ "package", "severity", "vulnerable_version_range", "first_patched_version" ], "additionalProperties": false } }, "severity": { "type": "string", "description": "The severity of the advisory.", "readOnly": true, "enum": [ "low", "medium", "high", "critical" ] }, "cvss": { "type": "object", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", "readOnly": true, "properties": { "score": { "type": "number", "description": "The overall CVSS score of the advisory.", "minimum": 0, "maximum": 10, "readOnly": true }, "vector_string": { "type": "string", "description": "The full CVSS vector string for the advisory.", "readOnly": true, "nullable": true } }, "required": [ "score", "vector_string" ], "additionalProperties": false }, "cvss_severities": { "type": "object", "nullable": true, "properties": { "cvss_v3": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 3 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 3 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_v4": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 4 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 4 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] } } }, "epss": { "type": "object", "nullable": true, "readOnly": true, "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", "properties": { "percentage": { "type": "number", "minimum": 0, "maximum": 100 }, "percentile": { "type": "number", "minimum": 0, "maximum": 100 } } }, "cwes": { "type": "array", "description": "Details for the advisory pertaining to Common Weakness Enumeration.", "readOnly": true, "items": { "type": "object", "description": "A CWE weakness assigned to the advisory.", "readOnly": true, "properties": { "cwe_id": { "type": "string", "description": "The unique CWE ID.", "readOnly": true }, "name": { "type": "string", "description": "The short, plain text name of the CWE.", "readOnly": true }