|
3240 | 3240 | } |
3241 | 3241 | ], |
3242 | 3242 | "summary": "Create a scoped access token", |
3243 | | - "description": "Exchanges a non-repository scoped user-to-server OAuth access token for a repository scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", |
| 3243 | + "description": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", |
3244 | 3244 | "tags": [ |
3245 | 3245 | "apps" |
3246 | 3246 | ], |
|
3257 | 3257 | "properties": { |
3258 | 3258 | "access_token": { |
3259 | 3259 | "type": "string", |
3260 | | - "description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>", |
| 3260 | + "description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>", |
3261 | 3261 | "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", |
3262 | 3262 | "name": "access_token", |
3263 | 3263 | "in": "body", |
3264 | 3264 | "rawType": "string", |
3265 | | - "rawDescription": "**Required.** The OAuth access token used to authenticate to the GitHub API.", |
| 3265 | + "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", |
3266 | 3266 | "childParamsGroups": [] |
3267 | 3267 | }, |
3268 | 3268 | "target": { |
|
4138 | 4138 | "subcategory": "oauth-applications", |
4139 | 4139 | "subcategoryLabel": "Oauth applications", |
4140 | 4140 | "notes": [], |
4141 | | - "descriptionHTML": "<p>Exchanges a non-repository scoped user-to-server OAuth access token for a repository scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>", |
| 4141 | + "descriptionHTML": "<p>Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>", |
4142 | 4142 | "responses": [ |
4143 | 4143 | { |
4144 | 4144 | "httpStatusCode": "200", |
4145 | 4145 | "httpStatusMessage": "OK", |
4146 | 4146 | "description": "Response", |
4147 | | - "payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/authorizations/1\"</span>,\n <span class=\"hljs-attr\">\"scopes\"</span>: [\n <span class=\"hljs-string\">\"public_repo\"</span>\n ],\n <span class=\"hljs-attr\">\"token\"</span>: <span class=\"hljs-string\">\"abcdefgh12345678\"</span>,\n <span class=\"hljs-attr\">\"token_last_eight\"</span>: <span class=\"hljs-string\">\"12345678\"</span>,\n <span class=\"hljs-attr\">\"hashed_token\"</span>: <span class=\"hljs-string\">\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\"</span>,\n <span class=\"hljs-attr\">\"app\"</span>: {\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"http://my-github-app.com\"</span>,\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"my github app\"</span>,\n <span class=\"hljs-attr\">\"client_id\"</span>: <span class=\"hljs-string\">\"abcde12345fghij67890\"</span>\n },\n <span class=\"hljs-attr\">\"note\"</span>: <span class=\"hljs-string\">\"optional note\"</span>,\n <span class=\"hljs-attr\">\"note_url\"</span>: <span class=\"hljs-string\">\"http://optional/note/url\"</span>,\n <span class=\"hljs-attr\">\"updated_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T20:39:23Z\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T17:26:27Z\"</span>,\n <span class=\"hljs-attr\">\"fingerprint\"</span>: <span class=\"hljs-string\">\"jklmnop12345678\"</span>,\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n },\n <span class=\"hljs-attr\">\"installation\"</span>: {\n <span class=\"hljs-attr\">\"permissions\"</span>: {\n <span class=\"hljs-attr\">\"metadata\"</span>: <span class=\"hljs-string\">\"read\"</span>,\n <span class=\"hljs-attr\">\"issues\"</span>: <span class=\"hljs-string\">\"write\"</span>,\n <span class=\"hljs-attr\">\"contents\"</span>: <span class=\"hljs-string\">\"read\"</span>\n },\n <span class=\"hljs-attr\">\"repository_selection\"</span>: <span class=\"hljs-string\">\"selected\"</span>,\n <span class=\"hljs-attr\">\"single_file_name\"</span>: <span class=\"hljs-string\">\".github/workflow.yml\"</span>,\n <span class=\"hljs-attr\">\"repositories_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/user/repos\"</span>,\n <span class=\"hljs-attr\">\"account\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n },\n <span class=\"hljs-attr\">\"has_multiple_single_files\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"single_file_paths\"</span>: []\n }\n}\n</code></pre>" |
| 4147 | + "payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/authorizations/1\"</span>,\n <span class=\"hljs-attr\">\"scopes\"</span>: [],\n <span class=\"hljs-attr\">\"token\"</span>: <span class=\"hljs-string\">\"abcdefgh12345678\"</span>,\n <span class=\"hljs-attr\">\"token_last_eight\"</span>: <span class=\"hljs-string\">\"12345678\"</span>,\n <span class=\"hljs-attr\">\"hashed_token\"</span>: <span class=\"hljs-string\">\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\"</span>,\n <span class=\"hljs-attr\">\"app\"</span>: {\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"http://my-github-app.com\"</span>,\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"my github app\"</span>,\n <span class=\"hljs-attr\">\"client_id\"</span>: <span class=\"hljs-string\">\"abcde12345fghij67890\"</span>\n },\n <span class=\"hljs-attr\">\"note\"</span>: <span class=\"hljs-string\">\"optional note\"</span>,\n <span class=\"hljs-attr\">\"note_url\"</span>: <span class=\"hljs-string\">\"http://optional/note/url\"</span>,\n <span class=\"hljs-attr\">\"updated_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T20:39:23Z\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T17:26:27Z\"</span>,\n <span class=\"hljs-attr\">\"fingerprint\"</span>: <span class=\"hljs-string\">\"jklmnop12345678\"</span>,\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n },\n <span class=\"hljs-attr\">\"installation\"</span>: {\n <span class=\"hljs-attr\">\"permissions\"</span>: {\n <span class=\"hljs-attr\">\"metadata\"</span>: <span class=\"hljs-string\">\"read\"</span>,\n <span class=\"hljs-attr\">\"issues\"</span>: <span class=\"hljs-string\">\"write\"</span>,\n <span class=\"hljs-attr\">\"contents\"</span>: <span class=\"hljs-string\">\"read\"</span>\n },\n <span class=\"hljs-attr\">\"repository_selection\"</span>: <span class=\"hljs-string\">\"selected\"</span>,\n <span class=\"hljs-attr\">\"single_file_name\"</span>: <span class=\"hljs-string\">\".github/workflow.yml\"</span>,\n <span class=\"hljs-attr\">\"repositories_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/user/repos\"</span>,\n <span class=\"hljs-attr\">\"account\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n },\n <span class=\"hljs-attr\">\"has_multiple_single_files\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"single_file_paths\"</span>: []\n }\n}\n</code></pre>" |
4148 | 4148 | }, |
4149 | 4149 | { |
4150 | 4150 | "httpStatusCode": "401", |
|
4170 | 4170 | "bodyParameters": [ |
4171 | 4171 | { |
4172 | 4172 | "type": "string", |
4173 | | - "description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>", |
| 4173 | + "description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>", |
4174 | 4174 | "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", |
4175 | 4175 | "name": "access_token", |
4176 | 4176 | "in": "body", |
4177 | 4177 | "rawType": "string", |
4178 | | - "rawDescription": "**Required.** The OAuth access token used to authenticate to the GitHub API.", |
| 4178 | + "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", |
4179 | 4179 | "childParamsGroups": [] |
4180 | 4180 | }, |
4181 | 4181 | { |
|
0 commit comments