summaryrefslogtreecommitdiff
path: root/doc/api/README.md
diff options
context:
space:
mode:
authorNick Thomas <nick@gitlab.com>2016-09-19 12:49:12 +0100
committerNick Thomas <nick@gitlab.com>2016-09-19 12:49:12 +0100
commit5d1b616eba6040a9a51fee057c2edc24a5be9832 (patch)
tree09ab887b8630e235b9c56303ceb4828d386312f0 /doc/api/README.md
parent48d563a3e4250de5afefa54f5c35cd7ca50d542d (diff)
downloadgitlab-ce-5d1b616eba6040a9a51fee057c2edc24a5be9832.tar.gz
Update API documentation to mention rails session cookies
[ci skip]
Diffstat (limited to 'doc/api/README.md')
-rw-r--r--doc/api/README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index 7661e1eea02..6e3295e0e0c 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -55,11 +55,12 @@ The following documentation is for the [internal CI API](ci/README.md):
## Authentication
-All API requests require authentication via a token. There are three types of tokens
-available: private tokens, OAuth 2 tokens, and personal access tokens.
+All API requests require authentication via a session cookie or token. There are
+three types of tokens available: private tokens, OAuth 2 tokens, and personal
+access tokens.
-If a token is invalid or omitted, an error message will be returned with
-status code `401`:
+If authentication information is invalid or omitted, an error message will be
+returned with status code `401`:
```json
{
@@ -98,6 +99,13 @@ that needs access to the GitLab API.
Once you have your token, pass it to the API using either the `private_token`
parameter or the `PRIVATE-TOKEN` header.
+
+### Session cookie
+
+When signing in to GitLab as an ordinary user, a `_gitlab_session` cookie is
+set. The API will use this cookie for authentication if it is present, but using
+the API to generate a new session cookie is currently not supported.
+
## Basic Usage
API requests should be prefixed with `api` and the API version. The API version