群组服务账号 API

使用此 API 与您的群组的服务帐户进行交互。有关更多信息，请参阅 Service accounts。

前提条件：

• 您必须具有实例的管理员访问权限，或者拥有极狐GitLab.com 群组的所有者角色。

列出所有服务帐户用户#

列出指定顶级群组中的所有服务帐户用户。

使用 page 和 per_page 分页参数过滤结果。

plaintext
GET /groups/:id/service_accounts

参数：

示例请求：

shell
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/345/service_accounts"

示例响应：

json
1[
2
3  {
4    "id": 57,
5    "username": "service_account_group_345_<random_hash>",
6    "name": "Service account user",
7    "email": "service_account_group_345_<random_hash>@noreply.gitlab.example.com"
8  },
9  {
10    "id": 58,
11    "username": "service_account_group_346_<random_hash>",
12    "name": "Service account user",
13    "email": "service_account_group_346_<random_hash>@noreply.gitlab.example.com"
14  }
15]

创建一个服务帐户用户#

在给定的顶级群组中创建一个服务帐户用户。

plaintext
POST /groups/:id/service_accounts

支持的属性：

示例请求：

shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/345/service_accounts" --data "email=custom_email@example.com"

示例响应：

json
1{
2  "id": 57,
3  "username": "service_account_group_345_6018816a18e515214e0c34c2b33523fc",
4  "name": "Service account user",
5  "email": "custom_email@example.com"
6}

更新一个服务帐户用户#

更新给定顶级群组中的服务帐户用户。

plaintext
PATCH /groups/:id/service_accounts/:user_id

参数：

示例请求：

shell
curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/345/service_accounts/57" --data "name=Updated Service Account"

示例响应：

json
1{
2  "id": 57,
3  "username": "service_account_group_345_6018816a18e515214e0c34c2b33523fc",
4  "name": "Updated Service Account",
5  "email": "service_account_group_345_<random_hash>@noreply.gitlab.example.com"
6}

删除一个服务帐户用户#

从给定的顶级群组中删除服务帐户用户。

plaintext
DELETE /groups/:id/service_accounts/:user_id

参数：

示例请求：

shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/345/service_accounts/181"

列出服务帐户用户的所有个人访问令牌#

列出顶级群组中服务帐户用户的所有个人访问令牌。

plaintext
GET /groups/:id/service_accounts/:user_id/personal_access_tokens

支持的属性：

示例请求：

shell
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/187/service_accounts/195/personal_access_tokens?sort=id_desc&search=token2b&created_before=2025-03-27"

示例响应：

json
1[
2    {
3        "id": 187,
4        "name": "service_accounts_token2b",
5        "revoked": false,
6        "created_at": "2025-03-26T14:42:51.084Z",
7        "description": null,
8        "scopes": [
9            "api"
10        ],
11        "user_id": 195,
12        "last_used_at": null,
13        "active": true,
14        "expires_at": null
15    }
16]

不成功响应的示例：

• 401: Unauthorized
• 404 Group Not Found

为服务帐户用户创建个人访问令牌#

为给定顶级群组中的现有服务帐户用户创建个人访问令牌。

plaintext
POST /groups/:id/service_accounts/:user_id/personal_access_tokens

参数：

示例请求：

shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/35/service_accounts/71/personal_access_tokens" --data "scopes[]=api,read_user,read_repository" --data "name=service_accounts_token"

示例响应：

json
1{
2  "id":6,
3  "name":"service_accounts_token",
4  "revoked":false,
5  "created_at":"2023-06-13T07:47:13.900Z",
6  "scopes":["api"],
7  "user_id":71,
8  "last_used_at":null,
9  "active":true,
10  "expires_at":"2024-06-12",
11  "token":"<token_value>"
12}

吊销服务帐户用户的个人访问令牌#

为给定顶级群组中的现有服务帐户用户吊销个人访问令牌。

plaintext
DELETE /groups/:id/service_accounts/:user_id/personal_access_tokens/:token_id

参数：

示例请求：

shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/35/service_accounts/71/personal_access_tokens/6"

如果成功，返回 204: No Content。

其他可能的响应：

• 400: Bad Request 如果未成功吊销。
• 401: Unauthorized 如果请求未被授权。
• 403: Forbidden 如果请求不被允许。
• 404: Not Found 如果访问令牌不存在。

旋转服务帐户用户的个人访问令牌#

为给定顶级群组中的现有服务帐户用户旋转个人访问令牌。这将创建一个有效期为一周的新令牌，并吊销所有现有令牌。

plaintext
POST /groups/:id/service_accounts/:user_id/personal_access_tokens/:token_id/rotate

参数：

示例请求：

shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/35/service_accounts/71/personal_access_tokens/6/rotate"

示例响应：

json
1{
2  "id":7,
3  "name":"service_accounts_token",
4  "revoked":false,
5  "created_at":"2023-06-13T07:54:49.962Z",
6  "scopes":["api"],
7  "user_id":71,
8  "last_used_at":null,
9  "active":true,
10  "expires_at":"2023-06-20",
11  "token":"<token_value>"
12}