From 7bffb2aaa7bcf1379c40ede70604e7debab1ae38 Mon Sep 17 00:00:00 2001 From: Matt Finkel Date: Sun, 20 Sep 2020 19:05:56 +0000 Subject: [PATCH] Make basic auth deprecation more clear in README Atlassian has deprecated password-based basic authentication for users of Atlassian Cloud, but it remains useable for users with a self-hosted Jira. Update the README to make this more clear. closes #317 --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 45fbd8a..37e7471 100644 --- a/README.md +++ b/README.md @@ -92,9 +92,11 @@ an `http.Client`. That client can then be passed into the `NewClient` function For convenience, capability for basic and cookie-based authentication is included in the main library. -#### Basic auth example +#### Token (Jira on Atlassian Cloud) -A more thorough, [runnable example](examples/basicauth/main.go) is provided in the examples directory. **It's worth noting that using passwords in basic auth is now deprecated and will be removed.** Jira gives you the ability to [create tokens now.](https://confluence.atlassian.com/cloud/api-tokens-938839638.html) +Token-based authentication uses the basic authentication scheme, with a user-generated API token in place of a user's password. You can generate a token for your user [here](https://id.atlassian.com/manage-profile/security/api-tokens). Additional information about Atlassian Cloud API tokens can be found [here](https://confluence.atlassian.com/cloud/api-tokens-938839638.html). + +A more thorough, [runnable example](examples/basicauth/main.go) is provided in the examples directory. ```go func main() { @@ -111,10 +113,11 @@ func main() { } ``` -#### Authenticate with session cookie [DEPRECATED] +#### Basic (self-hosted Jira) -Jira [deprecated this authentication method.](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-basic-auth-and-cookie-based-auth/) It's not longer available for use. +Password-based API authentication works for self-hosted Jira **only**, and has been [deprecated for users of Atlassian Cloud](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-basic-auth-and-cookie-based-auth/). +The above token authentication example may be used, substituting a user's password for a generated token. #### Authenticate with OAuth