프로젝트 CI/CD 작업 토큰 범위 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

CI/CD 작업 토큰에 대해 더 읽어보세요.

note
CI/CD 작업 토큰 범위 API 엔드포인트로의 모든 요청은 인증되어야 합니다. 인증된 사용자는 프로젝트의 유지자(Maintainer) 역할을 최소한 가지고 있어야 합니다.

프로젝트의 CI/CD 작업 토큰 액세스 설정 가져오기

프로젝트의 CI/CD 작업 토큰 액세스 설정(작업 토큰 범위)을 가져옵니다. 

GET /projects/:id/job_token_scope

지원되는 속성:

속성 유형 필수 설명
id integer/string 예 프로젝트의 ID 또는 URL 인코딩된 경로.

성공적인 경우, 200을 반환하고 다음과 같은 응답 속성을 반환합니다:

속성 유형 설명
inbound_enabled boolean 다른 프로젝트에서 생성된 CI/CD 작업 토큰이 이 프로젝트에 액세스할 수 있는지 여부를 나타냅니다.
outbound_enabled boolean 이 프로젝트에서 생성된 CI/CD 작업 토큰이 다른 프로젝트에 액세스할 수 있는지 여부를 나타냅니다. 폐기 예정이며 GitLab 17.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 예 다른 프로젝트에서 생성된 CI/CD 작업 토큰이 본 프로젝트에 제한된 액세스권을 가지고 있는지를 나타냅니다.

성공적인 경우, 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 Yes 프로젝트의 ID 또는 URL로 인코드된 경로.
target_project_id integer Yes 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 Yes 프로젝트의 ID 또는 URL로 인코드된 경로.

이 엔드포인트는 offset-based pagination을 지원합니다.

성공적으로 수행되면, 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 Yes 프로젝트의 ID 또는 URL로 인코드된 경로.
target_group_id integer Yes 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 Yes 프로젝트의 ID 또는 URL로 인코드된 경로.
target_group_id integer Yes 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'