Skip to content

docs: adjust order of options in external-auth #16943

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

Merged
merged 1 commit into from
Mar 14, 2025

Conversation

EdwardAngert
Copy link
Contributor

@EdwardAngert EdwardAngert commented Mar 14, 2025

from @NickSquangler

($customer) noticed when setting up external auth with Gitlab that the command listed in the docs is in the incorrect order, as coder external-auth <USER_DEFINED_ID> access-token should be coder external-auth access-token <USER_DEFINED_ID>

preview

coder external-auth access-token --help
coder external-auth access-token --help
coder v2.20.0+03b5012

USAGE:
  coder external-auth access-token [flags] <provider>

  Print auth for an external provider

  Print an access-token for an external auth provider. The access-token will be validated and sent
  to stdout with exit code 0. If a valid access-token cannot be obtained, the URL to authenticate
  will be sent to stdout with exit code 1
    - Ensure that the user is authenticated with GitHub before cloning.:

        $ #!/usr/bin/env sh

  OUTPUT=$(coder external-auth access-token github)
  if [ $? -eq 0 ]; then
    echo "Authenticated with GitHub"
  else
    echo "Please authenticate with GitHub:"
    echo $OUTPUT
  fi


    - Obtain an extra property of an access token for additional metadata.:

        $ coder external-auth access-token slack --extra "authed_user.id"


OPTIONS:
      --extra string
          Extract a field from the "extra" properties of the OAuth token.

———
Run `coder --help` for a list of global options.

@EdwardAngert EdwardAngert added docs Area: coder.com/docs customer-reported Bugs reported by enterprise customers. Only humans may set this. labels Mar 14, 2025
@EdwardAngert EdwardAngert self-assigned this Mar 14, 2025
@EdwardAngert EdwardAngert merged commit ffd336b into main Mar 14, 2025
34 checks passed
@EdwardAngert EdwardAngert deleted the external-auth-access-token branch March 14, 2025 21:17
@github-actions github-actions bot locked and limited conversation to collaborators Mar 14, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
customer-reported Bugs reported by enterprise customers. Only humans may set this. docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants