summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-06-27 12:15:57 +0000
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-06-27 12:15:57 +0000
commit0115ab7f403e7b25a7e66c3f4c309ddd5f37d657 (patch)
treeb123fdb0d75d77e05fc0bdd65470e71276217967 /doc/api
parenta9dbd394a60de76ffd9f5773560c8e9126751d91 (diff)
parentf7fc352b4a54c5b86a47a5e447aefbb40558a2cd (diff)
downloadgitlab-ce-0115ab7f403e7b25a7e66c3f4c309ddd5f37d657.tar.gz
Merge branch '2979-document-2fa-auth-changes' into 'master'
Add notices about disabling auth features for users with 2FA. Related to #2979 - Document the proposed changes to the GitLab authentication system. - This is done because currently, users with 2FA enabled are allowed API access without a 2FA token. # Tasks - [ ] #2979 !xxxx - Document proposed auth changes for 2FA users - [x] Wait for replies on "[potential avenues for documenting the planned changes](https://gitlab.com/gitlab-org/gitlab-ce/issues/2979#note_12591578)" - [x] Update documentation - [ ] CHANGELOG entry? - [ ] Merge conflicts See merge request !4815
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/oauth2.md9
-rw-r--r--doc/api/session.md9
2 files changed, 18 insertions, 0 deletions
diff --git a/doc/api/oauth2.md b/doc/api/oauth2.md
index d416a826f79..31902e145f6 100644
--- a/doc/api/oauth2.md
+++ b/doc/api/oauth2.md
@@ -65,6 +65,13 @@ curl -H "Authorization: Bearer OAUTH-TOKEN" https://localhost:3000/api/v3/user
## Resource Owner Password Credentials
+## Deprecation Notice
+
+1. Starting in GitLab 9.0, the Resource Owner Password Credentials will be *disabled* for users with two-factor authentication turned on.
+2. These users can access the API using [personal access tokens] instead.
+
+---
+
In this flow, a token is requested in exchange for the resource owner credentials (username and password).
The credentials should only be used when there is a high degree of trust between the resource owner and the client (e.g. the
client is part of the device operating system or a highly privileged application), and when other authorization grant types are not
@@ -100,3 +107,5 @@ client = OAuth2::Client.new('the_client_id', 'the_client_secret', :site => "http
access_token = client.password.get_token('user@example.com', 'sekret')
puts access_token.token
```
+
+[personal access tokens]: ./README.md#personal-access-tokens
diff --git a/doc/api/session.md b/doc/api/session.md
index 71e93d0bb0a..066a055702d 100644
--- a/doc/api/session.md
+++ b/doc/api/session.md
@@ -1,5 +1,12 @@
# Session
+## Deprecation Notice
+
+1. Starting in GitLab 9.0, this feature will be *disabled* for users with two-factor authentication turned on.
+2. These users can access the API using [personal access tokens] instead.
+
+---
+
You can login with both GitLab and LDAP credentials in order to obtain the
private token.
@@ -45,3 +52,5 @@ Example response:
"private_token": "9koXpg98eAheJpvBs5tK"
}
```
+
+[personal access tokens]: ./README.md#personal-access-tokens