사용자 이메일 주소 API
Tier: Free, Premium, Ultimate
Offering: GitLab.com, Self-managed, GitLab Dedicated
REST API를 사용하여 사용자 이메일 주소를 관리할 수 있습니다.
이메일 주소 목록
귀하의 이메일 주소 목록을 받아보세요.
전제 조건: - 인증해야 합니다.
이 엔드포인트는 기본 이메일 주소를 반환하지 않지만, 이슈 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
지정된 사용자의 이메일 주소 목록을 받아보세요.
전제 조건: - 관리자여야 합니다.
이 엔드포인트는 기본 이메일 주소를 반환하지 않지만, 이슈 25077에서 이 동작을 변경하기로 제안되었습니다.
GET /users/:id/emails
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| integer | yes | 지정된 사용자의 ID |
단일 이메일 주소 가져오기
단일 이메일 주소를 가져오세요.
GET /user/emails/:email_id
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
email_id
| integer | yes | 이메일 ID |
예시 응답:
{
"id": 1,
"email": "email@example.com",
"confirmed_at" : "2021-03-26T19:07:56.248Z"
}
이메일 주소 추가
인증된 사용자가 소유한 새 이메일을 생성합니다.
POST /user/emails
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
email
| string | yes | 이메일 주소 |
{
"id": 4,
"email": "email@example.com",
"confirmed_at" : "2021-03-26T19:07:56.248Z"
}
성공 시 201 Created
상태와 함께 생성된 이메일을 반환합니다. 오류가 발생하면 오류를 설명하는 메시지와 함께 400 Bad Request
가 반환됩니다.
{
"message": {
"email": [
"이미 존재하는 이메일입니다"
]
}
}
사용자의 이메일 주소 추가
Tier: Free, Premium, Ultimate
Offering: Self-managed, GitLab Dedicated
지정된 사용자가 소유한 새 이메일 주소를 생성합니다.
전제 조건: - 관리자여야 합니다.
POST /users/:id/emails
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| string | yes | 지정된 사용자의 ID |
email
| string | yes | 이메일 주소 |
skip_confirmation
| boolean | no | 확인을 건너뛰고 이메일이 검증됨 - true 또는 false (기본) |
귀하의 이메일 주소 중 하나 삭제
귀하의 이메일 주소 중 하나를 삭제합니다. 기본 이메일 주소가 아닌 다른 이메일 주소입니다.
전제 조건: - 인증해야 합니다.
삭제된 이메일 주소가 사용자 이메일의 일부로 사용되었으면, 해당 사용자 이메일은 대신 기본 이메일 주소로 전송됩니다.
알려진 이슈로 인해 그룹 알림은 삭제된 이메일 주소로 계속 전송됩니다.
DELETE /user/emails/:email_id
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
email_id
| integer | yes | 이메일 ID |
반환:
- 작업이 성공적이면
204 No Content
가 반환됩니다. - 자원을 찾을 수 없으면
404
가 반환됩니다.
사용자의 이메일 주소 삭제
Tier: Free, Premium, Ultimate
Offering: Self-managed, GitLab Dedicated
사용자의 이메일 주소를 삭제합니다.
전제 조건: - 관리자여야 합니다.
지정된 사용자의 이메일 주소를 삭제합니다. 기본 이메일 주소는 삭제할 수 없습니다.
DELETE /users/:id/emails/:email_id
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| integer | yes | 지정된 사용자의 ID |
email_id
| integer | yes | 이메일 ID |