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

群组 SSH 证书 API

版本：Premium, Ultimate
服务：GitLab.com

使用此 API 为群组创建、读取和删除 SSH 证书。只有顶级群组才能存储 SSH 证书。要使用此 API，您必须以被分配了所有者（Owner）角色的用户身份进行身份验证。

获取特定群组的所有 SSH 证书

GET /groups/:id/ssh_certificates

参数：

属性	类型	是否必需	描述
`id`	integer	是	群组的 ID。

默认情况下，由于 API 结果是分页的，GET 请求一次会返回 20 个结果。详细了解分页。

示例请求：

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://primary.example.com/api/v4/groups/90/ssh_certificates"

示例响应：

[
  {
    "id": 12345,
    "title": "SSH Title 1",
    "key": "ssh-rsa AAAAB3NzaC1ea2dAAAADAQABAAAAgQDGbLkF44ScxRQi2FfA7VsHgGqptguSbmW26jkJhEiRZpGS4/+UzaaSqc8Psw2OhSsKc5QwfrB/ANpO4LhOjDzhf2FuD8ACkv3R7XtaJ+rN6PlyzoBfLAiSyzxhEoMFDBprTgaiZKgg2yQ9dRH55w3f6XMZ4hnaUae53nQgfQLxFw== [email protected]",
    "created_at": "2023-09-08T12:39:00.172Z"
  },
  {
    "id":12346,
    "title":"SSH Title 2",
    "key": "ssh-rsa AAAAB3NzaC1ac2EAAAADAQABAAAAgQDTl/hHfu1F/KlR+QfgM2wUmyxcN5YeiaWluEGIrfXUeJuI+bK6xjpE3+2afHDYtE9VQkeL32KRjefX2d72Jeoa68ewt87Vn8CcGkUTOTpHNzeL8pHMKFs3m7ArSBxNg5vTdgAsq5dbDGNtat7b2WCHTNvtWoON1Jetne30uW2EwQ== [email protected]",
    "created_at": "2023-09-08T12:39:00.244Z"
  }
]

创建 SSH 证书

在群组中创建一个新的 SSH 证书。

POST /groups/:id/ssh_certificates

参数：

属性	类型	是否必需	描述
`id`	integer	是	群组的 ID。
`key`	string	是	SSH 证书的公钥。
`title`	string	是	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== [email protected]",
  "created_at": "2023-09-08T12:39:00.172Z"
}

删除群组 SSH 证书

从群组中删除一个 SSH 证书。

DELETE /groups/:id/ssh_certificate/:id

参数：

属性	类型	是否必需	描述
`id`	integer	是	群组的 ID
`id`	integer	是	SSH 证书的 ID

示例请求：

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/ssh_certificates/12345"