이 API를 사용하여 초대를 관리하고 그룹 또는 프로젝트에 사용자를 추가합니다.

그룹 또는 프로젝트에 멤버 추가#

새 멤버를 추가합니다. 사용자 ID를 지정하거나 이메일로 사용자를 초대할 수 있습니다.

필수 요건:

• 그룹의 경우, 해당 그룹에 대한 Owner 역할이 있어야 합니다.
• 프로젝트의 경우:
  • 해당 프로젝트에 대한 Maintainer 또는 Owner 역할이 있어야 합니다.
  • 그룹 멤버십 잠금이 비활성화되어 있어야 합니다.
• GitLab Self-Managed 인스턴스의 경우:
  • 새 사용자 계정 생성이 허용되지 않는 경우, 관리자가 사용자를 추가해야 합니다.
  • 사용자 초대가 허용되지 않는 경우, 관리자가 사용자를 추가해야 합니다.
  • 역할 승격에 대한 관리자 승인이 활성화된 경우, 관리자가 초대를 승인해야 합니다.

POST /groups/:id/invitations
POST /projects/:id/invitations

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/:id/invitations" \
  --data "email=test@example.com&user_id=1&access_level=30"
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/invitations" \
  --data "email=test@example.com&user_id=1&access_level=30"

응답 예시:

모든 이메일이 성공적으로 전송된 경우:

{  "status":  "success"  }

이메일 전송 중 오류가 발생한 경우:

{
  "status": "error",
  "message": {
               "test@example.com": "Invite email has already been taken",
               "test2@example.com": "User already exists in source",
               "test_username": "Access level is not included in the list"
             }
}

청구 불가능한 승격 관리를 활성화하려면, 먼저 enable_member_promotion_management 애플리케이션 설정을 활성화해야 합니다.

응답 예시:

{
  "queued_users": {
    "username_1": "Request queued for administrator approval."
  },
  "status": "success"
}

그룹 또는 프로젝트에 대한 모든 보류 중인 초대 목록 조회#

인증된 사용자가 볼 수 있는 초대된 그룹 또는 프로젝트 멤버 목록을 가져옵니다. 직접 멤버에 대한 초대만 반환하며, 상속된 조상 그룹을 통한 초대는 반환하지 않습니다.

이 기능은 페이지네이션 파라미터 page와 per_page를 사용하여 멤버 목록을 제한합니다.

GET /groups/:id/invitations
GET /projects/:id/invitations

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/:id/invitations?query=member@example.org"
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/invitations?query=member@example.org"

응답 예시:

 [
   {
     "id": 1,
     "invite_email": "member@example.org",
     "created_at": "2020-10-22T14:13:35Z",
     "access_level": 30,
     "expires_at": "2020-11-22T14:13:35Z",
     "user_name": "Raymond Smith",
     "created_by_name": "Administrator"
   },
]

그룹 또는 프로젝트에 대한 초대 업데이트#

그룹 또는 프로젝트에 대한 보류 중인 초대를 업데이트합니다.

PUT /groups/:id/invitations/:email
PUT /projects/:id/invitations/:email

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/55/invitations/email@example.org?access_level=40"
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/55/invitations/email@example.org?access_level=40"

응답 예시:

{
  "expires_at": "2012-10-22T14:13:35Z",
  "access_level": 40,
}

그룹 또는 프로젝트에 대한 초대 삭제#

지정된 이메일 주소로 보류 중인 초대를 삭제합니다.

DELETE /groups/:id/invitations/:email
DELETE /projects/:id/invitations/:email

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/55/invitations/email@example.org"
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/55/invitations/email@example.org"

• 성공 시 204와 내용 없음을 반환합니다.
• 초대를 삭제할 권한이 없는 경우 403 forbidden을 반환합니다.
• 권한이 있지만 해당 이메일 주소에 대한 초대가 없는 경우 404 not found를 반환합니다.
• 요청이 유효하지만 초대를 삭제할 수 없는 경우 409를 반환합니다.