Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing examples in "Authenticating with a GitHub App on behalf of a user" #31006

Open
1 task done
NatoBoram opened this issue Jan 9, 2024 · 2 comments
Open
1 task done
Labels
content This issue or pull request belongs to the Docs Content team github apps Content related to GitHub Apps help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@NatoBoram
Copy link

NatoBoram commented Jan 9, 2024

Code of Conduct

What article on docs.github.com is affected?

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

Authenticating with a GitHub App on behalf of a user is missing an example for how to do this with cURL. It's also missing an example on how to do this with Octokit.js.

Generating a user access token for a GitHub App#Generating a user access token when a user installs your app is missing examples for how to login after you've obtained the token.

There's no way to tell how to do this by looking at octokit/authentication-strategies.js#GitHub App or installation authentication since it redirects to Web application flow, which doesn't mention refresh tokens.

Speaking of refresh tokens, Refreshing user access tokens#Refreshing a user access token with a refresh token is missing an example on how to do this with Octokit.js.

Additional information

The previous page, "Authenticating as a GitHub App installation", has examples on how to do it with both cURL and Octokit.js.

@NatoBoram NatoBoram added the content This issue or pull request belongs to the Docs Content team label Jan 9, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 9, 2024
@nguyenalex836 nguyenalex836 added help wanted Anyone is welcome to open a pull request to fix this issue github apps Content related to GitHub Apps and removed triage Do not begin working on this issue until triaged by the team labels Jan 9, 2024
@docs-bot docs-bot added this to Help wanted in Docs open source board Jan 9, 2024
@nguyenalex836
Copy link
Contributor

@NatoBoram Thanks so much for opening this issue! You, or anyone else, are welcome to submit a PR for updating these docs with examples 💛

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Mar 11, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 18, 2024
Docs open source board automation moved this from Help wanted to Done Mar 18, 2024
@nguyenalex836 nguyenalex836 reopened this Mar 18, 2024
@nguyenalex836 nguyenalex836 removed the stale There is no recent activity on this issue or pull request label Mar 18, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 18, 2024
@nguyenalex836 nguyenalex836 removed the triage Do not begin working on this issue until triaged by the team label Mar 18, 2024
@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label May 20, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 28, 2024
@nguyenalex836 nguyenalex836 reopened this May 28, 2024
@nguyenalex836 nguyenalex836 removed the stale There is no recent activity on this issue or pull request label May 28, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 28, 2024
@nguyenalex836 nguyenalex836 removed the triage Do not begin working on this issue until triaged by the team label May 28, 2024
@GR7-4444

This comment was marked as spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team github apps Content related to GitHub Apps help wanted Anyone is welcome to open a pull request to fix this issue
3 participants