グループSSH証明書API

プラン: Premium、Ultimate
提供形態: GitLab.com

このAPIを使用して、グループのSSH証明書を作成、読み取り、削除します。トップレベルグループのみがSSH証明書を保存できます。このAPIを使用するには、オーナーロールが割り当てられたユーザーとして認証する必要があります。

特定のグループのすべてのSSH証明書を取得

GET /groups/:id/ssh_certificates

パラメータは以下のとおりです:

属性	型	必須	説明
`id`	整数	はい	グループの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== 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"