REST API 구현 가이드

REST API 구현 가이드에 대해 설명합니다.

침해된 개인 액세스 토큰(PAT)의 보안 영향을 줄이기 위해, 세분화된 PAT를 사용하면 특정 조직 경계(그룹, 프로젝트, 사용자 또는 인스턴스 수준)에 제한된 세밀한 권한으로 토큰을 생성할 수 있습니다. 이를 통해 사용자는 토큰에 필요한 권한만 부여하는 최소 권한 원칙을 따를 수 있습니다. 세분화된 PAT는 경계와 특정 리소스 권한으로 구성된 세분화된 범위를 통해 세밀한 액세스 제어를 허용합니다. 세분화된 PAT로 API 요청을 인증할 때, GitLab은 토큰의 권한이 지정된 경계 수준에서 요청된 리소스에 대한 액세스를 포함하는지 검증합니다. 이 문서는 REST API 엔드포인트를 세분화된 PAT 인증과 호환되도록 만들고자 하는 커뮤니티 기여자와 GitLab 개발자를 위해 설계되었습니다. 단계별 구현 가이드 # 이 가이드는 REST API 엔드포인트에 세분화된 PAT 인증을 추가하는 방법을 안내합니다. 시작하기 전에 전체에서 사용되는 용어를 이해하기 위해 권한 명명 규칙 문서를 검토하십시오. Note 이 단계는 REST API 엔드포인트만 다룹니다. GraphQL 쿼리 및 변이에 대한 지원 추가는 GraphQL 구현 가이드 를 참조하십시오. 워크플로 개요 # 구현은 다음 흐름을 따릅니다: 1-2단계: 계획 - 엔드포인트 식별 및 권한 설계 3단계: 원시 권한 생성(YAML 파일) 4단계: 원시 권한을 할당 가능한 권한으로 번들화(YAML 파일) 5단계: 엔드포인트에 인증 데코레이터 추가(Ruby 코드) 6단계: 인증 테스트 작성(Ruby 사양) 7단계: 로컬 테스트(수동 검증) 각 단계에서 생성되는 파일 # 각 단계에서 생성하는 파일을 보여주는 빠른 참조: 단계 파일 유형 위치 수량 예시 2 계획 문서 (메모) — 권한 이름 식별 3 원시 권한 YAML config/authz/permissions/<resource>/<action>.yml 권한당 1개 config/authz/permissions/job/read.yml 3 원시 권한 리소스 메타데이터 config/authz/permissions/<resource>/.metadata.yml 리소스당 1개 config/authz/permissions/job/.metadata.yml 4 할당 가능한 권한 YAML config/authz/permission_groups/assignable_permissions/<category>/<resource>/<action>.yml 그룹당 1개 config/authz/permission_groups/assignable_permissions/ci_cd/job/run.yml 4(선택) 범주 메타데이터 config/authz/permission_groups/assignable_permissions/<category>/.metadata.yml 범주당 0 또는 1개 config/authz/permission_groups/assignable_permissions/ci_cd/.metadata.yml 4 리