그룹 SSH 인증서 API
Tier: Premium, Ultimate
Offering: GitLab.com
- GitLab 16.4에 도입됐으며
ssh_certificates_rest_endpoints
라는 플래그로 기본 설정은 해제 상태입니다.- [GitLab 16.9에서 GitLab.com에서 활성화되었습니다.
플래그: GitLab.com에서는 이 기능을 사용할 수 있습니다. GitLab Dedicated에서는 이 기능을 사용할 수 없습니다.
이 API를 사용하여 그룹의 SSH 인증서를 생성, 읽기 및 삭제할 수 있습니다. 최상위 그룹만 SSH 인증서를 저장할 수 있습니다. 이 API를 사용하려면 Owner 역할이 할당된 사용자로 인증해야 합니다.
특정 그룹에 대한 모든 SSH 인증서 가져오기
GET groups/:id/ssh_certificates
매개변수:
속성 | 유형 | 필요여부 | 설명 |
---|---|---|---|
id
| 정수 | 예 | 그룹의 ID |
기본적으로 GET
요청은 API 결과가 페이지별로 표시되므로 한 번에 20개의 결과를 반환합니다.
pagination에서 자세히 알아보세요.
예시 요청:
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/groups/90/ssh_certificates"
예시 응답:
[
{
"id": 12345,
"title": "SSH Title 1",
"key": "ssh-rsa AAAAB3NzaC1ea2dAAAADAQABAAAAgQDGbLkF44ScxRQi2FfA7VsHgGqptguSbmW26jkJhEiRZpGS4/+UzaaSqc8Psw2OhSsKc5QwfrB/ANpO4LhOjDzhf2FuD8ACkv3R7XtaJ+rN6PlyzoBfLAiSyzxhEoMFDBprTgaiZKgg2yQ9dRH55w3f6XMZ4hnaUae53nQgfQLxFw== example@gitlab.com",
"created_at": "2023-09-08T12:39:00.172Z"
},
{
"id":12346,
"title":"SSH Title 2",
"key": "ssh-rsa AAAAB3NzaC1ac2EAAAADAQABAAAAgQDTl/hHfu1F/KlR+QfgM2wUmyxcN5YeiaWluEGIrfXUeJuI+bK6xjpE3+2afHDYtE9VQkeL32KRjefX2d72Jeoa68ewt87Vn8CcGkUTOTpHNzeL8pHMKFs3m7ArSBxNg5vTdgAsq5dbDGNtat7b2WCHTNvtWoON1Jetne30uW2EwQ== example@gitlab.com",
"created_at": "2023-09-08T12:39:00.244Z"
}
]
SSH 인증서 생성
그룹에 새로운 SSH 인증서를 생성합니다.
POST /groups/:id/ssh_certificates
매개변수:
속성 | 유형 | 필요여부 | 설명 |
---|---|---|---|
id
| 정수 | 예 | 그룹의 ID |
key
| 문자열 | 예 | SSH 인증서의 공개 키 |
title
| 문자열 | 예 | SSH 인증서의 제목 |
예시 요청:
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/ssh_certificates?title=newtitle&key=ssh-rsa+REDACTED+example%40gitlab.com"
예시 응답:
{
"id": 54321,
"title": "newtitle",
"key": "ssh-rsa ssh-rsa AAAAB3NzaC1ea2dAAAADAQABAAAAgQDGbLkF44ScxRQi2FfA7VsHgGqptguSbmW26jkJhEiRZpGS4/+UzaaSqc8Psw2OhSsKc5QwfrB/ANpO4LhOjDzhf2FuD8ACkv3R7XtaJ+rN6PlyzoBfLAiSyzxhEoMFDBprTgaiZKgg2yQ9dRH55w3f6XMZ4hnaUae53nQgfQLxFw== example@gitlab.com",
"created_at": "2023-09-08T12:39:00.172Z"
}
그룹 SSH 인증서 삭제
그룹에서 SSH 인증서를 삭제합니다.
DELETE /groups/:id/ssh_certificate/:id
매개변수:
속성 | 유형 | 필요여부 | 설명 |
---|---|---|---|
id
| 정수 | 예 | 그룹의 ID |
id
| 정수 | 예 | SSH 인증서의 ID |
예시 요청:
curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/ssh_certificates/12345"