Skip to content

Commit

Permalink
Update docs/user_guide/authenticate.md
Browse files Browse the repository at this point in the history
make method summary a bulleted list with links

Co-authored-by: Matt Fisher <[email protected]>
  • Loading branch information
andypbarrett and mfisher87 authored Nov 4, 2024
1 parent bb44a8e commit e76af26
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/user_guide/authenticate.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ an Earthdata Login account. You can register for a free Earthdata Login (EDL) a

Once you have an Earthdata Login account, you may use the `earthaccess.login` method to manage Earthdata Login credentials and, when you are working with cloud-hosted data, cloud credentials.

`earthaccess.login` offers three methods of logging in (or authenticating) using EDL: [a manual login method](#login-manually), where you enter EDL username and password manually; and two automatic login methods using EDL credentials stored in a [`.netrc`](#login-using-a-netrc) file or in [environment variables](#login-using-environment-variables). By default, `earthaccess.login()` will look for a `.netrc` or environment variables first. If neither of these are found, it will prompt you to enter your username and password. The three methods are described in detail below.
`earthaccess.login` offers three methods of logging in (or authenticating) using EDL:

* [a manual login method](#login-manually), where you enter EDL username and password manually
* an automatic login method using EDL credentials stored in a [`.netrc`](#login-using-a-netrc) file
* an automatic login method using EDL credentials stored in [environment variables](#login-using-environment-variables).

By default, `earthaccess.login()` will look for a `.netrc` or environment variables first. If neither of these are found, it will prompt you to enter your username and password. The three methods are described in detail below.

`earthaccess.login` can also be used to login to [different endpoints](#accessing-different-endpoints) and [get S3 credentials](#using-earthaccess-to-get-credentials).

Expand Down

0 comments on commit e76af26

Please sign in to comment.