Create a public SSH key for the authenticated user mentions wrong personal access token scope

[gotsport-ci]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/users/keys?apiVersion=2022-11-28#create-a-public-ssh-key-for-the-authenticated-user

What part(s) of the article would you like to see updated?

The docs currently say

OAuth app tokens and personal access tokens (classic) need the write:gpg_key scope to use this endpoint. I'm 99% sure it should be write:public_key.

Additional information

No response

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[STACKBYTESQUAD]

``import os
import requests
import json

--- CONFIGURATION ---

Replace with your GitHub Personal Access Token

It's highly recommended to use environment variables for sensitive information.

e.g., os.environ.get('GITHUB_TOKEN')

GITHUB_TOKEN = "YOUR_GITHUB_PERSONAL_ACCESS_TOKEN"

Replace with the title you want for your GPG key

KEY_TITLE = "My GPG Key"

Replace with your actual GPG public key content, including the -----BEGIN PGP PUBLIC KEY BLOCK----- and -----END PGP PUBLIC KEY BLOCK----- headers.

You can get this by running 'gpg --armor --export YOUR_KEY_ID' in your terminal.

GPG_PUBLIC_KEY = """
-----BEGIN PGP PUBLIC KEY BLOCK-----

-----END PGP PUBLIC KEY BLOCK-----
"""

GitHub API endpoint for GPG keys

API_URL = "https://api.github.com/user/gpg_keys"

--- API REQUEST ---

def add_gpg_key_to_github():
"""Adds a GPG public key to the authenticated GitHub user's account."""
if not GITHUB_TOKEN or not GPG_PUBLIC_KEY:
print("Error: GITHUB_TOKEN or GPG_PUBLIC_KEY is missing.")
return

headers = {
    "Authorization": f"token {GITHUB_TOKEN}",
    "Accept": "application/vnd.github.v3+json"
}

payload = {
    "armored_public_key": GPG_PUBLIC_KEY,
    "title": KEY_TITLE
}

print(f"Attempting to add GPG key with title: '{KEY_TITLE}'...")

try:
    response = requests.post(API_URL, headers=headers, data=json.dumps(payload))
    
    # Check if the request was successful
    if response.status_code == 201:
        print("Success! GPG key added to your GitHub account.")
        print("Response:")
        print(json.dumps(response.json(), indent=2))
    else:
        print(f"Error: Failed to add GPG key. Status code: {response.status_code}")
        print("Response:")
        print(json.dumps(response.json(), indent=2))
        
except requests.exceptions.RequestException as e:
    print(f"An error occurred: {e}")

if name == "main":
add_gpg_key_to_github()

[Sharra-writes]

@gotsport-ci Thanks for opening an issue! A lot of REST content is auto-generated and has to be fixed internally, which this does. I'm going to transfer this issue internally and then notify the relevant team to review the possible inaccuracy. Thanks again for flagging it for us!

[docs-bot]

Thank you for opening this issue! Updates to this documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.