gitlab api Authentication接口身份认证

Love The Way You Lie 2023-09-28 21:08 3阅读 0赞

### Authentication ###

大多数 API 请求都需要身份验证，或者仅在不提供身份验证时才返回公共数据. 对于不需要的情况，将在文档中针对每个端点进行提及. 例如， [`/projects/:id`端点][projects_id] .

使用 GitLab API 进行身份验证的方法有几种：

1.  [OAuth2 tokens][]
2.  [Personal access tokens][]
3.  [Project access tokens][]
4.  [Session cookie][]
5.  [GitLab CI/CD job token][GitLab CI_CD job token]**（仅特定端点）**

对于想要以特定用户身份向 API 进行身份验证的管理员，或者想要构建执行此操作的应用程序或脚本的管理员，可以使用以下两种方法：

1.  [Impersonation tokens][]
2.  [Sudo][]

如果身份验证信息无效或被忽略，将返回一条错误消息，状态码为`401` ：

{  "message":  "401 Unauthorized"  }

#### OAuth2 tokens ####

您可以通过在`access_token`参数或`Authorization`标头中传递[OAuth2 令牌][OAuth2]来对 API 进行身份验证.

在参数中使用 OAuth2 令牌的示例：

curl "https://gitlab.example.com/api/v4/projects?access_token=OAUTH-TOKEN"

在标头中使用 OAuth2 令牌的示例：

curl --header "Authorization: Bearer OAUTH-TOKEN" "https://gitlab.example.com/api/v4/projects"

阅读有关[GitLab 作为 OAuth2 提供程序的][OAuth2]更多信息.

#### Personal/project access tokens ####

Access tokens can be used to authenticate with the API by passing it in either the `private_token` parameter or the `Private-Token` header.

在参数中使用个人/项目访问令牌的示例：

curl "https://gitlab.example.com/api/v4/projects?private_token=<your_access_token>"

在标头中使用个人/项目访问令牌的示例：

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects"

您还可以将个人/项目访问令牌与 OAuth 兼容标头一起使用：

curl --header "Authorization: Bearer <your_access_token>" "https://gitlab.example.com/api/v4/projects"

--------------------

[参考链接：https://static.kancloud.cn/apachecn/gitlab-doc-zh/1948860][https_static.kancloud.cn_apachecn_gitlab-doc-zh_1948860]

[projects_id]: https://static.kancloud.cn/apachecn/gitlab-doc-zh/projects.html#get-single-project
[OAuth2 tokens]: https://static.kancloud.cn/apachecn/gitlab-doc-zh/v3_to_v4.html#oauth2-tokens
[Personal access tokens]: https://static.kancloud.cn/apachecn/user/profile/personal_access_tokens.html
[Project access tokens]: https://static.kancloud.cn/apachecn/user/project/settings/project_access_tokens.html
[Session cookie]: https://static.kancloud.cn/apachecn/gitlab-doc-zh/v3_to_v4.html#session-cookie
[GitLab CI_CD job token]: https://static.kancloud.cn/apachecn/gitlab-doc-zh/v3_to_v4.html#gitlab-ci-job-token
[Impersonation tokens]: https://static.kancloud.cn/apachecn/gitlab-doc-zh/v3_to_v4.html#impersonation-tokens
[Sudo]: https://static.kancloud.cn/apachecn/gitlab-doc-zh/v3_to_v4.html#sudo
[OAuth2]: https://static.kancloud.cn/apachecn/gitlab-doc-zh/oauth2.html
[https_static.kancloud.cn_apachecn_gitlab-doc-zh_1948860]: https://static.kancloud.cn/apachecn/gitlab-doc-zh/1948860