Skip to content

Commit 9284c73

Browse files
committed
docs: add bitbucket app password requirements
Highlight the permissions requirements for users attempting to authenticate to Bitbucket with an App Password. Also fix a few typos in the Basic Authentication section, since we're already making changes with the App Password information.
1 parent 75f4e7d commit 9284c73

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

docs/bitbucket-development.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,22 @@ processes.
6262

6363
### Basic Authentication
6464

65+
:rotating_light: Requirements for App Passwords :rotating_light:
66+
67+
If you are planning to use an [App Password][app-password] for basic
68+
authentication, it must at a minimum have _Account Read_ permissions (as shown
69+
below). If your App Password does not have these permissions, you will be
70+
re-prompted for credentials on every interaction with the server.
71+
72+
![][app-password-example]
73+
6574
If the GCM needs to prompt the user for credentials they will always be shown an
6675
initial dialog where they can enter a username and password. If the `username`
6776
parameter was passed into the GCM it is used to pre-populate the username field,
6877
although it can be overridden. When username and password credentials are
69-
submitted the GCM will use them to attempt to retrieve a token, for Basic
70-
Authentication this token is in effect the password the user just entered. The
71-
GCM retrieves this `token` by checking the password can be used to successfully
78+
submitted GCM will use them to attempt to retrieve a token, for Basic
79+
Authentication this token is in effect the password the user just entered. GCM
80+
retrieves this `token` by checking the password can be used to successfully
7281
retrieve the User profile via the Bitbucket REST API.
7382

7483
If the username and password credentials sent as Basic Authentication
@@ -82,7 +91,7 @@ stored and nothing is returned to Git.
8291

8392
However if the request fails with a 403 (Forbidden) return code, this indicates
8493
that the username and password are valid but 2FA is enabled on the Bitbucket
85-
Account. When this occurs the user it prompted to complete the OAuth
94+
Account. When this occurs the user is prompted to complete the OAuth
8695
authentication process.
8796

8897
### OAuth
@@ -194,6 +203,8 @@ require configuration in the form:
194203
❯ git config --global credential.https://example.com:7990/bitbucket.usehttppath true
195204

196205
[additional-info]:https://confluence.atlassian.com/display/BITBUCKET/App+passwords
206+
[app-password]: https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/
207+
[app-password-example]: img/app-password.png
197208
[atlas-run-standalone]: https://developer.atlassian.com/server/framework/atlassian-sdk/atlas-run-standalone/
198209
[bitbucket]: https://bitbucket.org
199210
[2fa-impl]: https://confluence.atlassian.com/bitbucket/two-step-verification-777023203.html

docs/img/app-password.png

60.5 KB
Loading

0 commit comments

Comments
 (0)