Help us learn about your current experience with the documentation. Take the survey.

CI/CD 作业令牌范围 API

  • Tier: 免费版、高级版、旗舰版
  • Offering: GitLab.com、GitLab 自托管、GitLab 专用

使用此 API 与 CI/CD 作业令牌 范围进行交互。

所有对 CI/CD 作业令牌范围 API 端点的请求都必须进行 认证。 认证用户必须至少拥有项目的 Maintainer 角色。

获取项目的 CI/CD 作业令牌访问设置

获取项目的 CI/CD 作业令牌访问设置（作业令牌范围）。

GET /projects/:id/job_token_scope

支持的属性：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或 URL 编码路径。

如果成功，返回 200 和以下响应属性：

属性 类型 描述
inbound_enabled boolean 指示是否启用了 限制对此项目的访问 设置。如果禁用，则 所有项目都可以访问。
outbound_enabled boolean 指示在此项目中生成的 CI/CD 作业令牌是否可以访问其他项目。已弃用，计划在 GitLab 18.0 中移除。

示例请求：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/job_token_scope"

示例响应：

{
  "inbound_enabled": true,
  "outbound_enabled": false
}

更新项目的 CI/CD 作业令牌访问设置

更新项目的 授权的组和项目 设置（作业令牌范围）。

PATCH /projects/:id/job_token_scope

支持的属性：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或 URL 编码路径。
enabled boolean 是 要选择的 授权的组和项目 设置 的状态。设置为 true 选择 此项目以及允许列表中的任何组和项目 选项，设置为 false 选择 所有组和项目 选项。

如果成功，返回 204 且无响应体。

示例请求：

curl --request PATCH \
  --url "https://gitlab.example.com/api/v4/projects/1/job_token_scope" \
  --header 'PRIVATE-TOKEN: <your_access_token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": false }'

获取项目的 CI/CD 作业令牌入站允许列表

获取项目的 CI/CD 作业令牌入站允许列表（作业令牌范围）。

GET /projects/:id/job_token_scope/allowlist

支持的属性：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或 URL 编码路径。

此端点支持 基于偏移的分页。

如果成功，返回 200 和一个包含有限字段的项目列表。

示例请求：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/job_token_scope/allowlist"

示例响应：

[
  {
    "id": 4,
    "description": null,
    "name": "Diaspora Client",
    "name_with_namespace": "Diaspora / Diaspora Client",
    "path": "diaspora-client",
    "path_with_namespace": "diaspora/diaspora-client",
    "created_at": "2013-09-30T13:46:02Z",
    "default_branch": "main",
    "tag_list": [
      "example",
      "disapora client"
    ],
    "topics": [
      "example",
      "disapora client"
    ],
    "ssh_url_to_repo": "git@gitlab.example.com:diaspora/diaspora-client.git",
    "http_url_to_repo": "https://gitlab.example.com/diaspora/diaspora-client.git",
    "web_url": "https://gitlab.example.com/diaspora/diaspora-client",
    "avatar_url": "https://gitlab.example.com/uploads/project/avatar/4/uploads/avatar.png",
    "star_count": 0,
    "last_activity_at": "2013-09-30T13:46:02Z",
    "namespace": {
      "id": 2,
      "name": "Diaspora",
      "path": "diaspora",
      "kind": "group",
      "full_path": "diaspora",
      "parent_id": null,
      "avatar_url": null,
      "web_url": "https://gitlab.example.com/diaspora"
    }
  },
  {
    ...
  }

将项目添加到 CI/CD 作业令牌入站允许列表

将项目添加到项目的 CI/CD 作业令牌入站允许列表 中。

POST /projects/:id/job_token_scope/allowlist

支持的属性：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或 URL 编码路径。
target_project_id integer 是 添加到 CI/CD 作业令牌入站允许列表中的项目 ID。

如果成功，返回 201 和以下响应属性：

属性 类型 描述
source_project_id integer 要更新的包含 CI/CD 作业令牌入站允许列表的项目 ID。
target_project_id integer 添加到源项目入站允许列表中的项目 ID。

示例请求：

curl --request POST \
  --url "https://gitlab.example.com/api/v4/projects/1/job_token_scope/allowlist" \
  --header 'PRIVATE-TOKEN: <your_access_token>' \
  --header 'Content-Type: application/json' \
  --data '{ "target_project_id": 2 }'

示例响应：

{
  "source_project_id": 1,
  "target_project_id": 2
}

从 CI/CD 作业令牌入站允许列表中移除项目

从项目的 CI/CD 作业令牌入站允许列表 中移除项目。

DELETE /projects/:id/job_token_scope/allowlist/:target_project_id

支持的属性：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或 URL 编码路径。
target_project_id integer 是 从 CI/CD 作业令牌入站允许列表中移除的项目 ID。

如果成功，返回 204 且无响应体。

示例请求：

curl --request DELETE \
  --url "https://gitlab.example.com/api/v4/projects/1/job_token_scope/allowlist/2" \
  --header 'PRIVATE-TOKEN: <your_access_token>' \
  --header 'Content-Type: application/json'

获取项目的 CI/CD 作业令牌组允许列表

获取项目的 CI/CD 作业令牌组允许列表（作业令牌范围）。

GET /projects/:id/job_token_scope/groups_allowlist

支持的属性：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或 URL 编码路径。

此端点支持 基于偏移的分页。

如果成功，返回 200 和一个包含有限字段的组列表。

示例请求：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/job_token_scope/groups_allowlist"

示例响应：

[
  {
    "id": 4,
    "web_url": "https://gitlab.example.com/groups/diaspora/diaspora-group",
    "name": "namegroup"
  },
  {
    ...
  }
]

将组添加到 CI/CD 作业令牌允许列表

将组添加到项目的 CI/CD 作业令牌允许列表中。

POST /projects/:id/job_token_scope/groups_allowlist

支持的属性：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或 URL 编码路径。
target_group_id integer 是 添加到 CI/CD 作业令牌组允许列表中的组 ID。

如果成功，返回 201 和以下响应属性：

属性 类型 描述
source_project_id integer 要更新的包含 CI/CD 作业令牌入站允许列表的项目 ID。
target_group_id integer 添加到源项目组允许列表中的组 ID。

示例请求：

curl --request POST \
  --url "https://gitlab.example.com/api/v4/projects/1/job_token_scope/groups_allowlist" \
  --header 'PRIVATE-TOKEN: <your_access_token>' \
  --header 'Content-Type: application/json' \
  --data '{ "target_group_id": 2 }'

示例响应：

{
  "source_project_id": 1,
  "target_group_id": 2
}

从 CI/CD 作业令牌允许列表中移除组

从项目的 CI/CD 作业令牌允许列表中移除组。

DELETE /projects/:id/job_token_scope/groups_allowlist/:target_group_id

支持的属性：

属性 类型 必需 描述
id integer/string 是 项目的 ID 或 URL 编码路径。
target_group_id integer 是 从 CI/CD 作业令牌组允许列表中移除的组 ID。

如果成功，返回 204 且无响应体。

示例请求：

curl --request DELETE \
  --url "https://gitlab.example.com/api/v4/projects/1/job_token_scope/groups_allowlist/2" \
  --header 'PRIVATE-TOKEN: <your_access_token>' \
  --header 'Content-Type: application/json'