Skip to content

Commit a140437

Browse files
authored
Merge pull request #320 from fffinkel/master
Make basic auth deprecation more clear in README
2 parents 72160de + 7bffb2a commit a140437

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,11 @@ an `http.Client`. That client can then be passed into the `NewClient` function
9292

9393
For convenience, capability for basic and cookie-based authentication is included in the main library.
9494

95-
#### Basic auth example
95+
#### Token (Jira on Atlassian Cloud)
9696

97-
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)
97+
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).
98+
99+
A more thorough, [runnable example](examples/basicauth/main.go) is provided in the examples directory.
98100

99101
```go
100102
func main() {
@@ -111,10 +113,11 @@ func main() {
111113
}
112114
```
113115

114-
#### Authenticate with session cookie [DEPRECATED]
116+
#### Basic (self-hosted Jira)
115117

116-
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.
118+
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/).
117119

120+
The above token authentication example may be used, substituting a user's password for a generated token.
118121

119122
#### Authenticate with OAuth
120123

0 commit comments

Comments
 (0)