Directory API: 그룹 회원

그룹에 회원 추가

그룹에 멤버를 추가하려면 다음 POST 요청을 사용하고 요청 승인에 설명된 승인을 포함합니다. 그룹 구성원은 사용자 또는 다른 그룹일 수 있습니다. groupKey은 새 회원의 그룹 이메일 주소 또는 그룹의 고유한 id입니다. 요청 및 응답 속성은 API 참조를 확인하세요. 

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members

그룹을 다른 그룹의 회원으로 추가하는 경우 하위 그룹의 회원이 상위 그룹의 회원으로 표시되기까지 최대 10분이 걸릴 수 있습니다. 또한 API는 그룹 멤버십의 순환에 대해 오류를 반환합니다. 예를 들어 group1이 group2의 구성원인 경우 group2는 group1의 구성원이 될 수 없습니다.

JSON 요청

다음 JSON 요청은 그룹 구성원을 만드는 샘플 요청 본문을 보여줍니다. 회원의 이메일 주소는 liz@example.com이고 그룹에서의 회원 역할은 MEMBER입니다. POST 요청은 groupKey에 NNNNN을 사용합니다. 

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members

{
   "email": "liz@example.com",
    "role": "MEMBER"
}

그룹 구성원의 role는 다음 중 하나일 수 있습니다.

  • OWNER – 이 역할은 그룹에 메시지를 보낼 수 있는 사용자를 변경하고, 회원을 추가 또는 삭제하고, 회원 역할을 변경하고, 그룹 설정을 변경하고, 그룹을 삭제할 수 있습니다. OWNER은 그룹의 구성원이어야 합니다.
  • MANAGER – 이 역할은 Google 관리 콘솔을 사용하여 Google Workspace를 사용 설정한 경우에만 사용할 수 있습니다. 관리자 역할은 회원을 소유자로 지정하거나 그룹을 삭제하는 작업을 제외하고 소유자 역할이 하는 모든 작업을 할 수 있습니다. 그룹에는 소유자 및 관리자 구성원이 여러 명 있을 수 있습니다.
  • MEMBER - 이 역할은 그룹을 구독하고, 토론 자료실을 보고, 그룹의 회원 목록을 볼 수 있습니다. 회원 역할에 대한 자세한 내용은 관리 고객센터를 참고하세요.

JSON 응답

응답이 성공하면 HTTP 200 상태 코드와 회원의 멤버십 정보가 반환됩니다. id은 회원의 고유 멤버십 ID입니다. 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MEMBER",
   "type": "GROUP"
  }

그룹 구성원의 type는 다음 중 하나일 수 있습니다.

  • GROUP - 회원이 다른 그룹입니다.
  • MEMBER - 회원이 사용자임

그룹 멤버십 업데이트

그룹 멤버십을 업데이트하려면 다음 PUT 요청을 사용하고 요청 승인에 설명된 승인을 포함합니다. groupKey는 그룹의 이메일 주소 또는 그룹의 고유 id이고, memberKey는 사용자 또는 그룹의 기본 이메일 주소, 사용자의 별칭 이메일 주소 또는 사용자의 고유 id입니다. 요청 및 응답 속성은 API 참조를 확인하세요. 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

JSON 요청

다음 JSON 요청은 그룹 멤버십 설정을 업데이트하는 샘플 요청 본문을 보여줍니다. 회원의 이메일 주소는 liz@example.com이고 그룹에서 회원의 역할이 MEMBER에서 MANAGER로 변경됩니다. 이 예시에서 PUT 요청의 groupKey는 NNNNN입니다. 회원, 소유자, 관리자 역할에 대한 자세한 내용은 관리 고객센터를 참고하세요. 

PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
 
{
   "email": "liz@example.com",
    "role": "MANAGER"
}

JSON 응답

응답이 성공하면 HTTP 200 상태 코드와 업데이트된 멤버십 정보가 반환됩니다. id은 회원의 고유 멤버십 ID입니다. 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

그룹의 구성원 가져오기

그룹 멤버십을 가져오려면 다음 GET 요청을 사용하고 요청 승인에 설명된 승인을 포함합니다. groupKey는 그룹의 이메일 주소 또는 그룹의 고유 id이고, memberKey는 사용자 또는 그룹의 기본 이메일 주소, 사용자의 별칭 이메일 주소 또는 사용자의 고유 id입니다. 요청 및 응답 속성은 API 참조를 확인하세요. 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

JSON 응답

응답이 성공하면 HTTP 200 상태 코드와 회원의 멤버십 정보가 반환됩니다. id은 회원의 고유 멤버십 ID입니다. 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

모든 그룹 구성원 가져오기

모든 그룹 구성원을 가져오려면 다음 GET 요청을 사용하고 요청 승인에 설명된 승인을 포함합니다. groupKey은 그룹의 이메일 주소 또는 그룹의 고유한 id입니다. 선택사항인 roles 쿼리 문자열은 역할별로 그룹 구성원을 가져올 수 있는 필터이며 결과 역할 컬렉션은 roles 필터에 지정된 순서로 표시됩니다. 요청 및 응답 속성은 API 참조를 확인하세요. 가독성을 위해 이 예시에는 줄바꿈이 포함되어 있습니다. 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page

모든 회원은 회원의 이메일 주소의 알파벳순으로 반환됩니다. 회원 수가 많은 응답에는 pageToken 쿼리 문자열을 사용합니다. 페이지로 나누기의 경우 응답은 다음 페이지의 응답 결과를 위한 토큰이 있는 nextPageToken 속성을 반환합니다. 다음 요청에서는 이 토큰을 pageToken 쿼리 문자열 값으로 사용합니다.

JSON 응답

응답에 성공하면 HTTP 200 상태 코드와 회원 정보 목록이 반환됩니다. id은 회원의 고유 멤버십 ID입니다. 이 응답에는 그룹 구성원의 후속 목록에 대한 nextPageToken가 있습니다. 

{
   "kind": "directory#members",
   "members": [
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "liz@example.com",
    "role": "MANAGER",
    "type": "USER"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "USER"
   }
  ],
   "nextPageToken": "NNNNN"
}

그룹 멤버십 삭제

그룹에서 멤버의 멤버십을 삭제하려면 다음 DELETE 요청을 사용하고 승인 요청에 설명된 승인을 포함합니다. groupKey는 그룹의 고유 id이고 memberKey는 삭제된 사용자 또는 그룹 구성원의 기본 이메일 주소 또는 사용자의 고유 id입니다. 요청 및 응답 속성은 API 참조를 확인하세요. 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
 예를 들어 다음 DELETE 요청은 groupKey이 nnn이고 memberKey이 사용자 기본 이메일 주소인 liz@example.com인 회원을 삭제합니다. 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com

성공적인 응답은 HTTP 200 상태 코드를 반환합니다.

회원이 삭제되면 다음과 같은 결과가 발생합니다.

  • 삭제된 회원에게는 더 이상 그룹으로 전송되는 이메일이 전송되지 않습니다.
  • 그룹에서 회원을 삭제해도 사용자의 계정은 삭제되지 않습니다.
  • 그룹 소유자를 삭제해도 그룹은 정상적으로 작동합니다. 관리자는 직접 그룹을 관리하거나 소유권을 다른 그룹 회원에게 할당할 수 있습니다.