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

[BUG] Populate user_guide/authentication #853

Open
1 task done
andypbarrett opened this issue Oct 29, 2024 · 3 comments · May be fixed by #862
Open
1 task done

[BUG] Populate user_guide/authentication #853

andypbarrett opened this issue Oct 29, 2024 · 3 comments · May be fixed by #862
Assignees
Labels
impact: documentation Improvements or additions to documentation type: bug Something isn't working

Comments

@andypbarrett
Copy link
Collaborator

Is this issue already tracked somewhere, or is this a new report?

  • I've reviewed existing issues and couldn't find a duplicate for this problem.

Current Behavior

User Guide Authentication page needs populating

Expected Behavior

Contains complete documentation with examples for authenticating using earthaccess

Steps To Reproduce

See https://earthaccess.readthedocs.io/en/latest/user_guide/authenticate/

Environment

- OS:
- Python:

Additional Context

No response

@andypbarrett andypbarrett added the impact: documentation Improvements or additions to documentation label Oct 29, 2024
@andypbarrett andypbarrett self-assigned this Oct 29, 2024
@andypbarrett
Copy link
Collaborator Author

Methods to document as defined in Auth

  • login
    • strategy
    • persist
    • system
  • get_s3_credentials
  • get_fsspec_https_session - this maybe better in access
  • get_requests_https_session - this maybe better in access
  • get_edl_token

@andypbarrett
Copy link
Collaborator Author

@betolink we need to add documentation about refresh_tokens and get_session to the authentication user guide. Do you have any examples for how these would be used?

@betolink
Copy link
Member

refresh_tokens() regenerates EDL bearer tokens, I don't have a lot of examples but the explanatory text can mention that in case a user has not used their EDL account for a while (I think 2 months) the tokens will expire, if no token is available the function will generate at least one token. Only 2 tokens per user are allowed by the API.

get_session() just returns a Python requests session with the bearer token.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact: documentation Improvements or additions to documentation type: bug Something isn't working
Projects
Status: 🆕 New
Development

Successfully merging a pull request may close this issue.

3 participants