그룹 관리

이 페이지에서는 Directory API를 사용하여 Google 그룹스를 관리하는 방법을 설명합니다.

  • 그룹 만들기
  • 그룹 업데이트
  • 그룹 별칭 추가하기
  • 그룹 검색
  • 도메인 또는 계정의 모든 그룹을 검색합니다.
  • 구성원의 모든 그룹 검색
  • 모든 그룹 별칭을 가져옵니다.
  • 그룹 별칭 삭제하기
  • 그룹 삭제

그룹 만들기

그룹을 만들려면 다음 POST 요청을 사용하고 승인을 포함합니다. 설명 요청을 승인합니다. 계정과 연결된 모든 도메인에 대해 그룹을 만들 수 있습니다. 쿼리 문자열의 경우 자세한 내용은 groups.insert 메서드 

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

다음 JSON 요청은 그룹을 만드는 샘플 요청 본문을 보여줍니다. 그룹 이메일 주소는 sales_group@example.com입니다. 

{
   "email": "sales_group@example.com",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

성공적인 응답은 HTTP 201 상태 코드 새 그룹의 속성이 표시됩니다

그룹 업데이트

그룹 설정을 업데이트하려면 다음 PUT 요청을 사용하고 승인에 설명되어 있습니다. 요청을 승인합니다. groupKey는 그룹의 이메일 주소(그룹 별칭의 이메일 주소)입니다. 또는 그룹의 고유한 id일 수 있습니다. 쿼리 문자열, 요청, 응답 속성의 경우 자세한 내용은 groups.update 메서드 

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

일반적으로 그룹의 이메일 주소를 영구 데이터의 키로 사용하지 않는 것이 좋습니다. 이메일 주소는 변경될 수 있기 때문입니다.

다음 예에서 고유한 groupKey는 nnn이고 그룹의 APAC 영업팀입니다. 

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "sales_group@example.com",
    "name": "APAC Sales Group"
}

업데이트 요청의 경우 요청에 업데이트된 정보만 제출하면 됩니다. 하지 말아야 할 일 요청에 그룹의 모든 속성을 입력해야 합니다.

성공적인 응답은 HTTP 201 상태 코드 및 새 그룹의 속성: 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

그룹 별칭 추가하기

그룹 별칭을 추가하려면 다음 POST 요청을 사용하고 승인을 포함합니다. 요청 승인에 설명된 대로 요청을 검증합니다. groupKey는 그룹의 이메일 주소(그룹 별칭)입니다. 이메일 주소 또는 그룹의 고유한 id입니다. 쿼리 문자열, 요청, 응답 속성은 다음을 참조하세요. groups 리소스. 

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

일반적으로 그룹의 이메일 주소를 영구 데이터의 키로 사용하지 않는 것이 좋습니다. 이메일 주소는 변경될 수 있기 때문입니다.

다음 JSON 요청은 그룹의 별칭을 만들기 위한 샘플 요청을 보여줍니다. 이 groupKey은(는) NNNN(으)로 표시되는 그룹의 고유한 id입니다.

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "best_sales_group@example.com"
}

성공적인 응답은 HTTP 201 상태 코드 새 그룹 별칭의 속성을 지정합니다.

그룹 검색

그룹을 검색하려면 다음 GET 요청을 사용하고 승인을 포함합니다. 설명 요청을 승인합니다. groupKey는 그룹의 이메일 주소(그룹 별칭)입니다. 이메일 주소 또는 그룹의 고유한 id입니다. 쿼리 문자열, 요청, 응답 속성은 다음을 참조하세요. groups.get 메서드 
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey

일반적으로 그룹의 이메일 주소를 영구 데이터의 키로 사용하지 않는 것이 좋습니다. 이메일 주소는 변경될 수 있기 때문입니다.

다음 예에서 고유한 groupKey ID는 nnnn입니다. 

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

성공적인 응답은 HTTP 200 상태 코드 및 그룹 설정이 포함됩니다. 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

도메인 또는 계정의 모든 그룹을 검색합니다.

특정 도메인 또는 계정의 모든 그룹을 검색하려면 다음 GET 명령어를 사용합니다. 승인하고 다음 페이지에 설명된 승인을 포함합니다. 요청을 승인합니다. 검색어의 경우 문자열, 요청, 응답 속성에 대한 자세한 내용은 groups.list 메서드 이 예시에서는 가독성을 위해 줄 반환을 사용합니다. 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

도메인 또는 계정의 모든 그룹을 검색할 때 다음 사항을 고려하세요.

  • 하위 도메인의 모든 그룹: 도메인 이름과 함께 domain 인수를 사용합니다.
  • 계정의 모든 그룹: customer 인수를 다음 중 하나와 함께 사용합니다. my_customer 또는 계정의 customerId 값입니다. 계정 관리자인 경우 my_customer 문자열을 사용하여 계정의 customerId입니다. 리셀러 고객의 계정에 액세스하는 리셀러인 경우 재판매 계정의 customerId입니다. customerId 값의 경우 다음을 사용합니다. 계정의 기본 도메인 이름을 도메인의 모든 사용자 검색 작업을 요청할 수 있습니다. 결과 응답에는 customerId 값이 있습니다.
  • domain 인수와 customer 인수를 모두 사용합니다. Directory API가 domain의 모든 그룹을 반환합니다.
  • domain 및 customer 인수를 사용하지 않는 경우: Directory API는 my_customer입니다. 이 계정은 다음을 만드는 관리자의 customerId입니다. 요청을 처리합니다
  • customer 인수와 userKey 인수를 모두 사용합니다. Directory API에서 오류를 반환합니다. 이를 사용하여 두 개의 개별 요청을 인수입니다.

다음 예에서는 계정 관리자가 my_customer를 사용하여 계정 그룹:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2

다음 예에서는 리셀러 관리자의 요청이 리셀러 계정의 모든 그룹을 반환합니다. customerId C03az79cb로 교체합니다. 응답 페이지당 반환되는 최대 결과는 2개입니다. 이 응답의 후속 사용자 목록에 관한 nextPageToken가 있습니다. 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2

성공적인 응답은 HTTP 200 상태 코드 및 그룹은 그룹 이메일의 알파벳순으로 표시됩니다. 

{
"kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support@sales.com",
      "name": "Sales support",
      "directMembersCount": "6",
      "description": "The sales support group",
      "adminCreated": true
     },
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "travel@sales.com",
      "name": "Sales travel",
      "directMembersCount": "2",
      "description": "The travel group supporting sales",
      "adminCreated": false,
      "aliases": [
       {
         "alias": "best_sales_group@example.com"
       }
      ],
      "nonEditableAliases: [
       {
         "alias": "liz@test.com"
       }
      ]
     },
  "nextPageToken": "NNNN"
  }

구성원의 모든 그룹 검색

구성원이 구독을 보유한 모든 그룹을 검색하려면 다음 GET를 사용합니다. 승인하고 다음 페이지에 설명된 승인을 포함합니다. 요청을 승인합니다. 가독성을 위해 이 예시에서는 줄 반환을 사용합니다. 

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
?pageToken=pagination token
&maxResults=maximum results per response page
  • 구성원은 사용자 또는 그룹일 수 있습니다.
  • userKey는 사용자의 기본 이메일 주소, 사용자의 별칭 이메일 주소일 수 있습니다. 그룹의 기본 이메일 주소, 그룹의 이메일 별칭 또는 사용자의 고유한 id 이는 사용자 작업을 검색합니다.
  • userKey에 지정된 사용자 또는 그룹은 도메인에 속해 있어야 합니다.
  • 많은 그룹이 있는 응답에 pageToken 쿼리 문자열을 사용합니다. 페이지로 나누기의 경우 응답은 nextPageToken 속성을 반환합니다. 이 속성은 응답 결과의 다음 페이지를 위한 토큰입니다. 다음 요청에서는 이 토큰을 pageToken 쿼리 문자열 값입니다.
  • customer 인수와 userKey 인수를 모두 사용합니다. Directory API에서 오류를 반환합니다. 이를 사용하여 두 개의 개별 요청을 인수입니다.

요청 및 응답 속성은 groups.list 메서드

성공적인 응답은 HTTP 200 상태 코드 회원 정보 목록:

  • 사용자가 구독하는 모든 그룹(사용자 외부의 그룹 포함) 반환됩니다.
  • 그룹은 각 그룹 이메일 주소의 알파벳순으로 반환됩니다.
  • 응답 본문에서 id는 그룹의 고유 ID입니다.
  • 응답에서 사용자 도메인 외부의 그룹 등록정보에는 할 수 있습니다. 
{
    "kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "sales_group@example.com",
      "name": "sale group",
      "directMembersCount": "5",
      "description": "Sales group"
     },
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support_group.com",
      "name": "support group",
      "directMembersCount": "5",
      "description": "Support group"
     }
  ],
   "nextPakeToken": "NNNNN"
}

모든 그룹 별칭을 가져옵니다.

그룹의 모든 별칭을 검색하려면 다음 GET 요청을 사용하고 승인에 설명되어 있습니다. 요청을 승인합니다. 이 groupKey은(는) 그룹의 기본 이메일 주소, 그룹 고유의 이메일 주소일 수 있습니다. id 또는 그룹 별칭 이메일 요청 및 응답 속성은 groups 리소스. 

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

성공적인 응답은 HTTP 201 상태 코드 그룹의 별칭 목록이 표시됩니다.

그룹 별칭 삭제하기

그룹의 별칭을 삭제하려면 다음 DELETE 요청을 사용하고 승인에 설명되어 있습니다. 요청을 승인합니다. groupKey은 그룹의 기본 이메일 주소일 수 있고 그룹의 고유한 이메일 주소일 수도 있습니다. id 또는 그룹 별칭 이메일 aliasId는 별칭으로 이(가) 삭제되었습니다. 요청 및 응답 속성은 groups 리소스를 참조하세요. 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

성공적인 응답은 HTTP 201 상태 코드.

그룹 삭제

그룹을 삭제하려면 다음 DELETE 요청을 사용하고 승인을 포함합니다. 설명 요청을 승인합니다. groupKey는 그룹의 고유한 id입니다. 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey
예를 들어 이 DELETE 요청은 nnnn 그룹 id가 있는 그룹을 삭제합니다. 
DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

성공적인 응답은 HTTP 200 상태 코드.

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

  • 그룹의 모든 회원이 삭제됩니다. 회원의 사용자 계정은 삭제되지 않습니다.
  • 그룹 자료실은 삭제됩니다.
  • 삭제된 그룹의 주소로 보낸 메일이 전송되지 않습니다. 대신 발신자는 반송 메일입니다.