summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvan Read <eread@gitlab.com>2019-08-18 23:15:22 +0000
committerEvan Read <eread@gitlab.com>2019-08-18 23:15:22 +0000
commitb714a6bf881db6d9158a23510ad7a86339822b3c (patch)
treee1f7a79043aa4fcd1b2090e44752a111b1f3cf78
parent1068483f7260e5866c7d54f1f09b716dbf463c80 (diff)
parent5ba8716dda99a8c60af906f6e0a4540bec27395c (diff)
downloadgitlab-ce-b714a6bf881db6d9158a23510ad7a86339822b3c.tar.gz
Merge branch 'docs-api-ci-auth' into 'master'
add GitLab CI job token API authentication section See merge request gitlab-org/gitlab-ce!30698
-rw-r--r--doc/api/README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index b7ee710b87a..9156d719e11 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -77,11 +77,12 @@ authentication is not provided. For
those cases where it is not required, this will be mentioned in the documentation
for each individual endpoint. For example, the [`/projects/:id` endpoint](projects.md).
-There are three ways to authenticate with the GitLab API:
+There are four ways to authenticate with the GitLab API:
1. [OAuth2 tokens](#oauth2-tokens)
1. [Personal access tokens](#personal-access-tokens)
1. [Session cookie](#session-cookie)
+1. [GitLab CI job token](#gitlab-ci-job-token-premium) **(PREMIUM)**
For admins who want to authenticate with the API as a specific user, or who want to build applications or scripts that do so, two options are available:
@@ -151,6 +152,14 @@ The primary user of this authentication method is the web frontend of GitLab its
which can use the API as the authenticated user to get a list of their projects,
for example, without needing to explicitly pass an access token.
+### GitLab CI job token **(PREMIUM)**
+
+With a few API endpoints you can use a [GitLab CI job token](../user/project/new_ci_build_permissions_model.md#job-token)
+to authenticate with the API:
+
+* [Get job artifacts](jobs.md#get-job-artifacts)
+* [Pipeline triggers](pipeline_triggers.md)
+
### Impersonation tokens
> [Introduced][ce-9099] in GitLab 9.0. Needs admin permissions.