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

Update documentation regarding authentication via Personal Access Tokens #424

Closed
DylanEtris opened this issue Jan 7, 2024 · 0 comments · Fixed by #450
Closed

Update documentation regarding authentication via Personal Access Tokens #424

DylanEtris opened this issue Jan 7, 2024 · 0 comments · Fixed by #450
Labels
Documentation Updates to documentation, how-tos, examples
Milestone

Comments

@DylanEtris
Copy link

Subject of the Issue

The documentation in the README regarding authentication with Personal Access Tokens is misleading. The documentation says "Specifically, the paremeters :username and :password are not needed.", yet the example provided shows the two parameters being used:

options = {
  :site               => 'http://mydomain.atlassian.net:443/',
  :context_path       => '',
  :username           => '<the email you sign-in to JIRA>',
  :password           => api_token,
  :auth_type          => :basic
}

Expected Behavior

In my experience, the options need to be configured as follows to connect with a PAT:

options = {
  :site               => 'http://mydomain.atlassian.net:443/',
  :username           => '<the email you sign-in to Jira>',
  :password           => '',
  :default_headers => { 'Authorization' =>  "Bearer PERSONAL_ACCESS_TOKEN" }
  :auth_type          => :basic
}

The documentation should be updated to include a correct set of options, and the description should be updated to reflect the changes.

I hope this is the right place to raise an issue like this.

@bobbrodie bobbrodie added the Documentation Updates to documentation, how-tos, examples label Apr 1, 2024
@bobbrodie bobbrodie added this to the v3.0.0 milestone Apr 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Updates to documentation, how-tos, examples
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants