사용자 이메일 주소 API

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

REST API를 사용하여 사용자 이메일 주소를 관리할 수 있습니다.

이메일 주소 목록 조회

본인의 이메일 주소 목록을 가져옵니다.

Prerequisites:

  • 인증을 받아야 합니다.

이 끝점은 기본 이메일 주소를 반환하지 않지만, 문제 25077에서 이러한 동작을 변경할 것을 제안합니다.

GET /user/emails

예시 응답:

[
  {
    "id": 1,
    "email": "email@example.com",
    "confirmed_at" : "2021-03-26T19:07:56.248Z"
  },
  {
    "id": 3,
    "email": "email2@example.com",
    "confirmed_at" : null
  }
]

사용자에 대한 이메일 주소 목록 조회

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

지정된 사용자의 이메일 목록을 가져옵니다.

Prerequisites:

  • 관리자가 되어야 합니다.

이 끝점은 기본 이메일 주소를 반환하지 않지만, 문제 25077에서 이러한 동작을 변경할 것을 제안합니다.

GET /users/:id/emails

지원되는 속성:

속성 유형 필수 설명
id 정수 예 지정된 사용자의 ID

단일 이메일 주소 조회

단일 이메일 주소를 가져옵니다.

GET /user/emails/:email_id

지원되는 속성:

속성 유형 필수 설명
email_id 정수 예 이메일 ID

예시 응답:

{
  "id": 1,
  "email": "email@example.com",
  "confirmed_at" : "2021-03-26T19:07:56.248Z"
}

이메일 주소 추가

인증된 사용자가 소유하는 새 이메일을 생성합니다.

POST /user/emails

지원되는 속성:

속성 유형 필수 설명
email 문자열 예 이메일 주소 
{
  "id": 4,
  "email": "email@example.com",
  "confirmed_at" : "2021-03-26T19:07:56.248Z"
}

성공 시 201 Created 상태로 생성된 이메일이 반환됩니다. 오류가 발생하면 오류를 설명하는 메시지와 함께 400 Bad Request가 반환됩니다:

{
  "message": {
    "email": [
      "has already been taken"
    ]
  }
}

사용자에 대한 이메일 주소 추가

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

지정된 사용자가 소유하는 새 이메일 주소를 생성합니다.

Prerequisites:

  • 관리자가 되어야 합니다.
POST /users/:id/emails

지원되는 속성:

속성 유형 필수 설명
id 문자열 예 지정된 사용자의 ID
email 문자열 예 이메일 주소
skip_confirmation 부울 아니오 확인을 생략하고 이메일이 확인된 것으로 간주 - true 또는 false (기본값)

이메일 주소 중 하나 삭제하기

주 이메일 주소를 제외한 이메일 주소 중 하나를 삭제하세요.

전제 조건:

  • 인증이 완료되어야 합니다.

삭제된 이메일 주소가 사용자 이메일에 사용되고 있는 경우, 해당 사용자 이메일은 주 이메일 주소로 대신 전송됩니다.

알려진 문제 때문에, 그룹 알림은 여전히 삭제된 이메일 주소로 전송됩니다.

DELETE /user/emails/:email_id

지원되는 속성:

속성 유형 필수 설명
email_id 정수 예 이메일 ID

반환:

  • 작업이 성공하면 204 No Content를 반환합니다.
  • 리소스를 찾을 수 없으면 404를 반환합니다.

사용자의 이메일 주소 삭제하기

Tier: Free, Premium, Ultimate

Offering: Self-managed, GitLab Dedicated

사용자의 이메일 주소를 삭제하세요.

전제 조건:

  • 관리자가 되어야 합니다.

지정된 사용자의 이메일 주소를 삭제합니다. 주 이메일 주소는 삭제할 수 없습니다.

DELETE /users/:id/emails/:email_id

지원되는 속성:

속성 유형 필수 설명
id 정수 예 지정된 사용자 ID
email_id 정수 예 이메일 ID