사용자 SSH 및 GPG 키 API

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

사용자 SSH 키사용자 GPG 키를 REST API를 사용하여 관리할 수 있습니다.

SSH 키 목록

사용자의 SSH 키 목록을 가져옵니다.

전제 조건:

이 엔드포인트는 목록을 제한하기 위해 페이지네이션 매개변수 pageper_page를 사용합니다.

GET /user/keys

지원되는 속성:

  • 없음

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/user/keys"

예시 응답:

[
  {
    "id": 1,
    "title": "Public key",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
    "created_at": "2014-08-01T14:47:39.080Z"
  },
  {
    "id": 3,
    "title": "Another Public key",
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
    "created_at": "2014-08-01T14:47:39.080Z"
  }
]

사용자의 SSH 키 목록 가져오기

지정된 사용자의 SSH 키 목록을 가져옵니다.

GET /users/:id_or_username/keys

지원되는 속성:

속성 유형 필수 설명
id_or_username string yes 해당 사용자의 ID 또는 사용자 이름

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/users/1/keys"

단일 SSH 키 가져오기

단일 SSH 키를 가져옵니다.

GET /user/keys/:key_id

지원되는 속성:

속성 유형 필수 설명
key_id string yes SSH 키의 ID

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/user/keys/1"

예시 응답:

{
  "id": 1,
  "title": "Public key",
  "key": "<SSH_KEY>",
  "created_at": "2014-08-01T14:47:39.080Z"
}

사용자의 단일 SSH 키 가져오기

지정된 사용자의 단일 SSH 키를 가져옵니다.

GET /users/:id/keys/:key_id

지원되는 속성:

속성 유형 필수 설명
id integer yes 지정된 사용자의 ID
key_id integer yes SSH 키 ID

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/users/1/keys/1"

예시 응답:

{
  "id": 1,
  "title": "Public key",
  "key": "<SSH_KEY>",
  "created_at": "2014-08-01T14:47:39.080Z"
}

계정에 SSH 키 추가하기

  • usage_type 매개변수는 GitLab 15.7에 도입되었습니다.

계정에 새로운 SSH 키를 만듭니다.

전제 조건:

POST /user/keys

지원되는 속성:

속성 유형 필수 설명
title string yes 새 SSH 키의 제목
key string yes 새 SSH 키
expires_at string no ISO 8601 형식의 SSH 키 만료 날짜 (YYYY-MM-DDTHH:MM:SSZ)
usage_type string no SSH 키의 사용 범위: auth, signing 또는 auth_and_signing. 기본값: auth_and_signing

다음 중 하나를 반환합니다:

  • 성공 시 201 Created 상태의 생성된 키.
  • 오류를 설명하는 메시지와 함께 400 Bad Request 오류:

    {
      "message": {
        "fingerprint": [
          "이미 사용 중입니다"
        ],
        "key": [
          "이미 사용 중입니다"
        ]
      }
    }
    

예시 응답:

{
  "title": "ABC",
  "key": "<SSH_KEY>",
  "expires_at": "2016-01-21T00:00:00.000Z",
  "usage_type": "auth"
}

사용자의 SSH 키 추가

  • usage_type 매개변수가 GitLab 15.7에서 도입되었습니다.

지정된 사용자가 소유한 새 키를 만듭니다.

참고: 이 작업은 감사 이벤트도 추가합니다.

필수 조건:

  • 귀하는 관리자여야 합니다.
POST /users/:id/keys

지원되는 속성:

속성 유형 필수 여부 설명
id integer yes 지정된 사용자의 ID
title string yes 새 SSH 키의 제목
key string yes 새 SSH 키
expires_at string no SSH 키의 만료 날짜(ISO 8601 형식) (YYYY-MM-DDTHH:MM:SSZ)
usage_type string no SSH 키의 사용 범위: auth, signing 또는 auth_and_signing. 기본값: auth_and_signing

다음 중 하나를 반환합니다:

  • 성공 시 상태가 201 Created인 생성된 키.
  • 리소스를 설명하는 메시지가 포함된 400 Bad Request 오류:

    {
      "message": {
        "fingerprint": [
          "이미 사용 중입니다"
        ],
        "key": [
          "이미 사용 중입니다"
        ]
      }
    }
    

응답 예시:

{
  "title": "ABC",
  "key": "<SSH_KEY>",
  "expires_at": "2016-01-21T00:00:00.000Z",
  "usage_type": "auth"
}

계정에서 SSH 키 삭제

계정에서 SSH 키를 삭제합니다.

필수 조건:

DELETE /user/keys/:key_id

지원되는 속성:

속성 유형 필수 여부 설명
key_id integer yes SSH 키 ID

다음 중 하나를 반환합니다:

  • 작업에 성공한 경우 204 No Content 상태 코드.
  • 리소스를 찾을 수 없는 경우 404 상태 코드.

사용자의 SSH 키 삭제

지정된 사용자가 소유한 SSH 키를 삭제합니다.

필수 조건:

  • 귀하는 관리자여야 합니다.
DELETE /users/:id/keys/:key_id

지원되는 속성:

속성 유형 필수 여부 설명
id integer yes 지정된 사용자의 ID
key_id integer yes SSH 키 ID

GPG 키 목록

귀하의 GPG 키 목록을 가져옵니다.

필수 조건:

GET /user/gpg_keys

지원되는 속성:

  • 없음

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/user/gpg_keys"

응답 예시:

[
  {
    "id": 1,
    "key": "<PGP_PUBLIC_KEY_BLOCK>",
    "created_at": "2017-09-05T09:17:46.264Z"
  }
]

사용자의 GPG 키 목록

지정된 사용자의 GPG 키 목록을 가져옵니다. 이 엔드포인트는 인증 없이 액세스할 수 있습니다.

GET /users/:id/gpg_keys

지원되는 속성:

속성 유형 필수 여부 설명
id integer yes 사용자의 ID

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/users/2/gpg_keys"

응답 예시:

[
  {
    "id": 1,
    "key": "<PGP_PUBLIC_KEY_BLOCK>",
    "created_at": "2017-09-05T09:17:46.264Z"
  }
]

단일 GPG 키 가져오기

귀하의 GPG 키 중 하나의 세부 정보를 가져옵니다.

필수 조건:

GET /user/gpg_keys/:key_id

지원되는 속성:

속성 유형 필수 여부 설명
key_id integer yes GPG 키의 ID

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/user/gpg_keys/1"

응답 예시:

{
  "id": 1,
  "key": "<PGP_PUBLIC_KEY_BLOCK>",
  "created_at": "2017-09-05T09:17:46.264Z"
}

지정된 사용자의 단일 GPG 키 가져오기

지정된 사용자의 특정 GPG 키를 가져옵니다. 이 엔드포인트는 관리자 인증 없이 액세스할 수 있습니다.

GET /users/:id/gpg_keys/:key_id

지원되는 속성:

속성 유형 필수 여부 설명
id integer yes 사용자의 ID
key_id integer yes GPG 키의 ID

예시 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/users/2/gpg_keys/1"

응답 예시:

{
  "id": 1,
  "key": "<PGP_PUBLIC_KEY_BLOCK>",
  "created_at": "2017-09-05T09:17:46.264Z"
}

계정에 GPG 키 추가

귀하의 계정에 새 GPG 키를 만듭니다.

필수 조건:

POST /user/gpg_keys

지원되는 속성:

속성 유형 필수 여부 설명
key string yes 새 GPG 키

예시 요청:

export KEY="$(gpg --armor --export <your_gpg_key_id>)"

curl --data-urlencode "key=<PGP_PUBLIC_KEY_BLOCK>" \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/user/gpg_keys"

응답 예시:

[
  {
    "id": 1,
    "key": "<PGP_PUBLIC_KEY_BLOCK>",
    "created_at": "2017-09-05T09:17:46.264Z"
  }
]

사용자용 GPG 키 추가

지정된 사용자가 소유한 새 GPG 키를 생성합니다.

필수 조건:

  • 관리자여야 합니다.
POST /users/:id/gpg_keys

지원되는 속성:

속성 유형 필수 설명
id integer yes 사용자 ID
key_id integer yes GPG 키 ID

예시 요청:

curl --data-urlencode "key=<PGP_PUBLIC_KEY_BLOCK>" \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/2/gpg_keys"

예시 응답:

[
  {
    "id": 1,
    "key": "<PGP_PUBLIC_KEY_BLOCK>",
    "created_at": "2017-09-05T09:17:46.264Z"
  }
]

계정에서 GPG 키 삭제

계정에서 GPG 키를 삭제합니다.

필수 조건:

  • 인증이 되어 있어야 합니다.
DELETE /user/gpg_keys/:key_id

지원되는 속성:

속성 유형 필수 설명
key_id integer yes GPG 키 ID

성공 시 다음 중 하나를 반환합니다:

  • 204 No Content
  • 키를 찾을 수 없는 경우 404 Not Found

사용자용 GPG 키 삭제

지정된 사용자가 소유한 GPG 키를 삭제합니다.

필수 조건:

  • 관리자여야 합니다.
DELETE /users/:id/gpg_keys/:key_id

지원되는 속성:

속성 유형 필수 설명
id integer yes 사용자 ID
key_id integer yes GPG 키 ID