-
Notifications
You must be signed in to change notification settings - Fork 175
procedures: add Device Auth Tokens documentation #3168
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
Open
tolusha
wants to merge
3
commits into
main
Choose a base branch
from
docs-device-auth-tokens
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
73 changes: 73 additions & 0 deletions
73
modules/end-user-guide/pages/connecting-to-github-using-device-authorization.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| :_content-type: PROCEDURE | ||
| :description: Connect your GitHub account to {prod-short} using the device authorization flow directly from the Dashboard. | ||
| :keywords: user-guide, github, device-authorization, device-auth, token, oauth | ||
| :navtitle: Connecting to GitHub using device authorization | ||
|
|
||
| [id="connecting-to-github-using-device-authorization"] | ||
| = Connecting to GitHub using device authorization | ||
|
|
||
| [role="_abstract"] | ||
| Connect your GitHub account to {prod-short} using the device authorization flow directly from the Dashboard. Device Auth Tokens are GitHub OAuth tokens stored as {kubernetes} Secrets. They enable Git operations in your workspaces without requiring a personal access token. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * Your administrator has configured a GitHub OAuth App with Device Flow enabled as described in xref:administration-guide:configuring-oauth-2-for-github.adoc[Configuring OAuth 2.0 for GitHub]. | ||
| + | ||
| NOTE: This feature requires the GitHub OAuth App configuration. It is not available when GitHub authentication is configured using a GitHub App. | ||
|
|
||
| .Procedure | ||
|
|
||
| . In the {prod-short} dashboard, go to *User Preferences > Device Auth Tokens*. | ||
|
|
||
| . Click *Connect to GitHub*. | ||
| + | ||
| A modal opens displaying a one-time code. | ||
|
|
||
| . Click the copy button next to the code to copy it to your clipboard. | ||
|
|
||
| . Click link:https://github.com/login/device[github.com/login/device] to open the GitHub device activation page. | ||
| + | ||
| NOTE: For GitHub Enterprise Server, replace `github.com` with your instance hostname. | ||
|
|
||
| . Paste the one-time code on the GitHub page and click *Continue*. | ||
|
|
||
| . Authorize the application when prompted by GitHub. | ||
| + | ||
| NOTE: The permissions granted are determined by the OAuth App configuration set by your administrator. | ||
| + | ||
| After successful authorization, the modal closes and the new token appears in the *Device Auth Tokens* table. | ||
|
|
||
| .Verification | ||
|
|
||
| * Verify that the new token is listed in the *Device Auth Tokens* table with a valid status. | ||
|
|
||
| [id="deleting-device-auth-tokens"] | ||
| == Deleting device auth tokens | ||
|
|
||
| Deleting a device auth token removes the {kubernetes} Secret and revokes the GitHub authorization. Device Auth Tokens do not expire automatically. To disconnect your GitHub account, delete the token from this page or revoke access from your GitHub account settings. | ||
|
|
||
| .Procedure | ||
|
olexii4 marked this conversation as resolved.
|
||
|
|
||
| . To delete a single token: | ||
| .. Click the actions menu (*⋮*) on the token row. | ||
| .. Click *Delete*. | ||
| .. Select the confirmation checkbox and click *Delete*. | ||
|
|
||
| . To delete multiple tokens: | ||
| .. Select the checkboxes next to the tokens you want to delete. | ||
| .. Click *Delete* in the toolbar. | ||
| .. Select the confirmation checkbox and click *Delete*. | ||
|
|
||
| .Verification | ||
|
|
||
| * Verify that the deleted token no longer appears in the *Device Auth Tokens* table. | ||
|
|
||
| [id="troubleshooting-device-auth-tokens"] | ||
| == Troubleshooting | ||
|
|
||
| If the one-time code expires before you complete the authorization on GitHub (codes expire after approximately 15 minutes), close the modal and click *Connect to GitHub* again to start a new device authorization flow. | ||
|
|
||
| .Additional resources | ||
|
|
||
| * xref:administration-guide:configuring-oauth-2-for-github.adoc[] | ||
| * For an alternative Git authentication method, see xref:get-started-user:using-a-git-provider-access-token.adoc[]. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.